ORDER-561 - Retrieve paginated lines of a commercial order

get

https://example.com/v1/shop/commercial-orders/{commercialOrderId}/lines

Retrieves all commercial order lines for a given order. This includes product details, quantities, pricing, and any associated information.

Use Case: This endpoint is used to display or review the individual lines of a customer's commercial order. It replaces any Cart usage by giving an extended view of all logistic order lines.
Permissions: Requires a valid API key and authenticated user context.
Pagination & Sorting: Supports standard pagination and sorting of lines.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

commercialOrderId

string

required

Business reference (REFERENCE) of the commercial order. This path parameter always expects a REFERENCE — the idType query param does not apply to it.

Query Params

sort

array of strings

Sorting criteria in format field:direction (e.g. quantity:desc, createdAt:asc). Multiple sort criteria are supported. Both asc and desc directions are available. Invalid entries are silently ignored. Sortable fields: id, createdAt, updatedAt, quantity, confirmedQuantity, externalId, status, paymentStatus, refunded, incidentDeclared, quoteLineExternalId.

sort

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

supplierIds

array of strings

Filter by supplier IDs. The format of these IDs is determined by the idType query parameter.

supplierIds

productVariantIds

array of strings

Filter by product variant IDs. The format of these IDs is determined by the idType query parameter.

productVariantIds

offerPriceIds

array of strings

Filter by offer price IDs. The format of these IDs is determined by the idType query parameter.

offerPriceIds

idType

string

enum

Specifies the format of filter IDs (supplierIds, productVariantIds, offerPriceIds). Default: EXTERNAL_ID. This parameter does not affect the path parameter commercialOrderId, which is always a REFERENCE.

Allowed:

locale

string

Locale for text localization (product names, labels, etc.). Format: IETF BCP 47 language tag (e.g. en-US, fr-FR).

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.

Responses

200Order lines retrieved successfully.

401Unauthorized. Missing or invalid authentication token.

403Forbidden. Caller is not allowed to access this order's lines.

404Commercial order not found for the provided reference.