ORDER-560 - Retrieve paginated list of commercial orders

Returns the paginated list of commercial orders for the caller.

User scoping

  • Only ACCOUNT clients are allowed for this front-office route.

Store scoping

  • Effective store is the dj-store header if provided, otherwise the tenant default store.
  • The caller must belong to the effective store; otherwise 403.

Visibility

  • Results are limited to the caller’s authorised perimeter (store membership + role).

Locales

  • locale (IETF BCP 47) is required and drives label localisation in the response.

Scope

  • Returns commercial order headers with snapshots and price summaries (no full logistic detail).
  • Each item includes sourceType and sourceId so the client can report/filter by order source (e.g., Operation).
  • Logistic details may be partially included via nbPreviewLines.

Filters

  • AND between different keys; OR between values of the same key.
  • Unknown or malformed values are silently ignored; empty lists mean no filter.
  • Supported filters: connectedUserOnly, customerAccountIds, isValidated, nbPreviewLines, sourceTypes, sourceIds, cf.

Custom field filtering (cf)

  • Filters only apply to commercial order custom fields.
  • Format: <CF_EXTERNAL_ID>|<CF_VALUE>.
  • AND between different CF external IDs; OR between multiple values of the same CF.
  • Invalid entries or non-applicable CFs are ignored (no 400).

Sorting

  • Server-side sorting uses sort=field:direction. Multiple criteria supported (comma-separated).
  • Supported fields: createdAt, validatedAt, updatedAt, sourceType, sourceId, reference.
  • Default: createdAt:desc then reference:asc as tie-breaker for stability.
  • Invalid/malformed sort entries are silently ignored; valid ones are still applied.
  • When sorting by reference, collation is case-insensitive and locale-aware.

  • Null handling: null values are always placed last, regardless of sort direction.

Errors

  • 401 Unauthorized (missing/invalid token).
  • 403 Forbidden (role or store not allowed).
  • Other errors follow Djust’s error catalog.

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

The locale used to localize texts (such as product names, labels, etc.).

Must follow the IETF BCP 47 language tag format: <language>-<region>

Example: en-US for English (United States), fr-FR for French (France)

boolean

(Optional) Filter the commercial orders of the connected user only. Defaults to false.

customerAccountIds
array of strings
Defaults to

(Optional) List of customer accounts ids to filter commercial orders of the connected user.

customerAccountIds
sourceTypes
array of strings
Defaults to
sourceTypes
sourceIds
array of strings
Defaults to
sourceIds
boolean
cf
array of strings

Filter commercial orders by commercial order custom field values.

Each entry must follow the format: <CF_EXTERNAL_ID>|<CF_VALUE>.
Only custom fields attached to the commercial order are supported.

Combination rules:

  • AND between different CF external IDs.
  • OR between multiple values of the same CF external ID.

Validation rules:

  • Malformed entries are ignored.
  • Unknown CF external IDs or CFs not applicable to commercial orders are ignored.
  • If all entries are ignored, the CF filter is not applied.
  • No 400 Bad Request is returned for invalid cf values.
cf
int32
≥ 0
Defaults to 100

(Optional) Number of order preview lines to fetch per order. 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