Search Orders

Retrieve a list of orders based on specific criteria.

POST /{searchOrdersURL}

Request Format

{
  "fulfillmentStatuses": [
    "canceled",
    "delivered"
  ]
}

Request Parameters

Parameter	Type	Required	Description
fulfillmentStatuses	string[]	Optional	Filter by order fulfillment status
financialStatus	string[]	Optional	Filter by order financial status
orderReferenceId	string	Optional	Filter by your internal order ID
orderReferenceIds	string[]	Optional	Filter by multiple internal order IDs
startDate	string	Optional	Filter by orders created after this date (ISO 8601 format)
endDate	string	Optional	Filter by orders created before this date (ISO 8601 format)
countries	string[]	Optional	Filter by shipping country codes
limit	number	Optional	Maximum number of results to return (default: 50, max: 100)
offset	number	Optional	Number of results to skip for pagination (default: 0)

Response Format

{
  "orders": [
    {
      "id": "9f9ff09f-5891-4d3d-be35-9b302db835a1",
      "clientId": "ddb4371a-ad83-4f68-b99d-6b48c7eff366",
      "orderReferenceId": "orderref_123",
      "fulfillmentStatus": "failed",
      "financialStatus": "canceled",
      "currency": "USD",
      "totalInclVat": "0.00",
      "orderType": "order",
      "channel": "api",
      "storeId": null,
      "connectedOrderIds": [],
      "firstName": "TEST",
      "lastName": "PRINT",
      "country": "GB",
      "itemsCount": 1,
      "createdAt": "2024-12-02T11:05:09+00:00",
      "updatedAt": "2024-12-02T11:05:10+00:00",
      "orderedAt": "2024-12-02T11:05:07+00:00",
      "refusalReasonCode": "missing_retail_prices",
      "appServices": [],
      "customerReferenceId": "custref_456"
    }
  ]
}