ORDER-560 - Retrieve paginated list of commercial orders

get deprecated

https://example.com/v1/shop/commercial-orders

Retrieves a paginated list of commercial orders associated with the authenticated user.

Use Case: This endpoint is used by customers to fetch their order history.
Permissions: Requires a valid API key and client type.
Sorting & Pagination: Supports sorting, filtering, and paginated results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 20

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

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

sort

locale

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)

connectedUserOnly

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

isValidated

boolean

nbPreviewLines

int32

≥ 0

Defaults to 100

(Optional) Number of order preview lines to fetch per order. Defaults to 100.

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

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

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

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

customer-account-id

string

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

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Order commercial found