GET api/v1/Orders?contactId={contactId}

Retrieve array of orders by contact id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ReadOrderDto
NameDescriptionTypeAdditional information
Id

Id of order

integer

None.

Type

Type of order

string

Max length: 32

ExtOrderId

External id of order

string

Max length: 100

ContactId

Id of contact

integer

None.

FirstName

FirstName on the order

string

Max length: 50

LastName

LastName on the order

string

Max length: 50

Address

Address on the order

string

Max length: 250

PostCode

Postcode on the order

string

Max length: 32

City

City on the order

string

Max length: 100

Country

Country on the order

string

Max length: 100

Company

Company on the order

string

Max length: 250

PriceTotal

Total price of order

decimal number

None.

LastModified

Date and time of last modification of order

date

None.

StoreId

Id of store

integer

None.

OriginDate

Date of origin of the order

date

None.

StartDate

Start date of the order

date

None.

EndDate

End date of the order

date

None.

Email

Email of the order

string

Max length: 250

ContactRegistrationSource

Registration source of the order's contact

string

Max length: 50

ContactRegistrationDateTime

Registration datetime of the order's contact

date

None.

OrderLines

Orderlines of order

Collection of ReadOrderLineDto

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Type": "sample string 2",
    "ExtOrderId": "sample string 3",
    "ContactId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Address": "sample string 6",
    "PostCode": "sample string 7",
    "City": "sample string 8",
    "Country": "sample string 9",
    "Company": "sample string 10",
    "PriceTotal": 11.0,
    "LastModified": "2023-11-29T04:54:49.4200211+00:00",
    "StoreId": 1,
    "OriginDate": "2023-11-29T04:54:49.4200211+00:00",
    "StartDate": "2023-11-29T04:54:49.4200211+00:00",
    "EndDate": "2023-11-29T04:54:49.4200211+00:00",
    "Email": "sample string 13",
    "ContactRegistrationSource": "sample string 14",
    "ContactRegistrationDateTime": "2023-11-29T04:54:49.4200211+00:00",
    "OrderLines": [
      {
        "Id": 1,
        "OrderId": 2,
        "ExtProductId": "sample string 3",
        "ImgUrl": "sample string 4",
        "Name": "sample string 5",
        "Description": "sample string 6",
        "Quantity": 7.0,
        "Price": 8.0,
        "PriceTotal": 9.0,
        "LastModified": "2023-11-29T04:54:49.4200211+00:00",
        "ContactRegistrationSource": "sample string 11",
        "ContactRegistrationDateTime": "2023-11-29T04:54:49.4200211+00:00"
      },
      {
        "Id": 1,
        "OrderId": 2,
        "ExtProductId": "sample string 3",
        "ImgUrl": "sample string 4",
        "Name": "sample string 5",
        "Description": "sample string 6",
        "Quantity": 7.0,
        "Price": 8.0,
        "PriceTotal": 9.0,
        "LastModified": "2023-11-29T04:54:49.4200211+00:00",
        "ContactRegistrationSource": "sample string 11",
        "ContactRegistrationDateTime": "2023-11-29T04:54:49.4200211+00:00"
      }
    ]
  },
  {
    "Id": 1,
    "Type": "sample string 2",
    "ExtOrderId": "sample string 3",
    "ContactId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Address": "sample string 6",
    "PostCode": "sample string 7",
    "City": "sample string 8",
    "Country": "sample string 9",
    "Company": "sample string 10",
    "PriceTotal": 11.0,
    "LastModified": "2023-11-29T04:54:49.4200211+00:00",
    "StoreId": 1,
    "OriginDate": "2023-11-29T04:54:49.4200211+00:00",
    "StartDate": "2023-11-29T04:54:49.4200211+00:00",
    "EndDate": "2023-11-29T04:54:49.4200211+00:00",
    "Email": "sample string 13",
    "ContactRegistrationSource": "sample string 14",
    "ContactRegistrationDateTime": "2023-11-29T04:54:49.4200211+00:00",
    "OrderLines": [
      {
        "Id": 1,
        "OrderId": 2,
        "ExtProductId": "sample string 3",
        "ImgUrl": "sample string 4",
        "Name": "sample string 5",
        "Description": "sample string 6",
        "Quantity": 7.0,
        "Price": 8.0,
        "PriceTotal": 9.0,
        "LastModified": "2023-11-29T04:54:49.4200211+00:00",
        "ContactRegistrationSource": "sample string 11",
        "ContactRegistrationDateTime": "2023-11-29T04:54:49.4200211+00:00"
      },
      {
        "Id": 1,
        "OrderId": 2,
        "ExtProductId": "sample string 3",
        "ImgUrl": "sample string 4",
        "Name": "sample string 5",
        "Description": "sample string 6",
        "Quantity": 7.0,
        "Price": 8.0,
        "PriceTotal": 9.0,
        "LastModified": "2023-11-29T04:54:49.4200211+00:00",
        "ContactRegistrationSource": "sample string 11",
        "ContactRegistrationDateTime": "2023-11-29T04:54:49.4200211+00:00"
      }
    ]
  }
]