Get all logistic orders paginated

Pagination & sorting

Standard pagination is supported via page and size parameters. See the sort parameter for the sortable fields and the accepted formats.

Filtering

orderIdentifier matches the order reference, its external identifier or its DJUST identifier. orderOrigin restricts the list to the given origins, which is how external orders are kept out of a storefront screen without paging through them.

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
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
Body Params
accountCustomFieldValueCriteria
array of objects, unique

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.

accountCustomFieldValueCriteria
approvalIds
array of strings, unique
approvalIds
boolean
date-time
date-time
customerAccountIds
array of strings, unique
customerAccountIds
boolean

Filter orders that are marked as incidents.

string
required
logisticStatus
array of objects, unique

Filter by one or more logistic order statuses.

offerCustomFieldValueCriteria
array of objects, unique

Filter by offer-level custom fields and their values

offerCustomFieldValueCriteria
string

Filter by the internal or external order identifier.

orderLogisticCustomFieldValueCriteria
array of objects, unique

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.

orderLogisticCustomFieldValueCriteria
orderOrigin
array of objects, unique

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

paymentOptions
array of objects, unique

Filter orders by available payment methods.

supplierIds
array of strings, unique
supplierIds
date-time
date-time
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