Get all logistic orders paginated

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
sort
array of strings

Sorting criteria in format field:direction or field,direction (e.g. createdAt:desc, reference,asc). Multiple sort criteria are supported and are applied in the order they are sent. Both asc and desc directions are available for every sortable field. Invalid entries are ignored instead of rejecting the whole request. Without any criteria, the most recently created orders come first.

Sortable fields: id, reference, externalId, status, paymentStatus, paymentOption, createdAt, updatedAt, orderOrigin, incidentDeclared, channel, shippingType.

Sortable price fields: totalPriceWithTax, totalPriceWithoutTax, totalTaxAmount, totalProductWithTax, totalProductWithoutTax, totalProductTaxAmount, totalShippingFeesWithTax, totalShippingFeesWithoutTax, totalShippingTaxAmount.

Orders can also be sorted on the value of one of their custom fields, with the key cf.<identifier>, where the identifier is either the djust identifier of the custom field or its external one. A single custom field key is honoured per request, the following ones are ignored. Orders carrying no value for that custom field come last, in both directions. Values of a NUMBER or METRIC custom field are ordered as numbers, those of a DATE custom field written in ISO form chronologically, and all others as text, ignoring case and accents. The key is ignored when no custom field of the order carries the identifier, or when that custom field holds media.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort
customerAccountIds
array of strings, unique
customerAccountIds
approvalIds
array of strings, unique
approvalIds
string
required
supplierIds
array of strings, unique
supplierIds
date-time
date-time
date-time
date-time
boolean
string

Filter by one or more logistic order statuses.

string

Filter orders that are marked as incidents.

string

Filter orders by available payment methods.

string

Filter by the internal or external order identifier.

string

Filter by one or more order origins: CART, SUPPLIER_QUOTE, ORDER or EXTERNAL_ORDER. Applied before pagination.

string

Filter by order-level custom fields and their values. Several values on the same custom field are combined with a logical OR, different custom fields with a logical AND. Media custom fields are not searchable.

string

Filter by account-level custom fields and their values. Several values on the same custom field are combined with a logical OR, different custom fields with a logical AND. Media custom fields are not searchable.

string

Filter by offer-level custom fields and their values

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 20

The size of the page to be returned

int32
≥ 0
Defaults to 100
Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

string

(Optional) Customer account ID in multi-account customer user.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json