HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

ORDER-500 - Retrieve a commercial order by ID

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

Fetches the full details of a commercial order by its unique identifier.

  • Use Case: This endpoint is used to view a specific commercial order placed by a customer.

  • Permissions: Requires a valid API key and client type.

  • Multistore Support: Optional store context headers allow filtering by store and storeview.

  • ID Type Handling: Optional idType query param allows choosing between internal and external identifiers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the commercial order to retrieve.

Query Params
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)

string
enum

(Optional) Specifies the format of the identifier (commercialOrderId):

  • BUSINESS_ID: Djust system ID

  • CART_ID: Cart ID origin in a Cart v2 use case

  • REFERENCE: Client-facing reference

Allowed:
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

Updated 10 months ago

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

Updated 10 months ago