ORDER-223 - Synchronise a commercial order

Overview
Synchronises a commercial order so it remains consistent with the current pricing, availability and configuration rules applied to its order lines.

User scoping
Only dj-client: ACCOUNT is allowed (customer users).

Store scoping
The store context is resolved from dj-store (when provided) or from the tenant default store.
dj-store-view may further refine the store view context when applicable.

Visibility
Access and visibility rules apply to the order and its content, including ownership/permissions and catalog visibility (eligible catalog views).

Validation rules
The commercial order must be editable and not validated.
When at least one blocking warning is detected, no change is applied.
This endpoint only applies to commercial orders created through an order-based checkout.

Business rules
This endpoint supports two execution contexts depending on the tenant configuration:

  • RTP (Real Time Pricing): synchronisation relies on pricing and availability data provided by an external system outside of Djust, accessed in real time.
  • Standard mode: synchronisation relies on persisted Djust data (catalog, offer prices, offer stock, custom fields).
    In both contexts, offer eligibility rules apply (offer price, offer stock and supplier status, account eligibility).

Errors
This endpoint may return authentication, authorisation (permissions), validation, not found or conflict errors.
Standard Djust error codes apply.

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

Unique commercial order ID (REFERENCE only). Business IDs or EXTERNAL_IDs are not supported for this path.

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

401

Unauthorized (invalid or missing API key).

403

Forbidden. The caller is not allowed to synchronise this order.

404

Not found. The commercial order id does not exist.

409

Conflict. The order cannot be synchronised in its current state (e.g., already validated).

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