ORDER-222 - Update custom fields on a commercial order

put

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

Updates the list of custom fields for a commercial order.

⚠️ This endpoint can only be used if all underlying logistic orders of the commercial order are in DRAFT_ORDER status.
Note: The commercial order itself does not have a status — only its associated logistic orders do.

Custom fields can be identified by DJUST_ID or EXTERNAL_ID. If no type is provided, EXTERNAL_ID is assumed.

This route is often used to replace the cart name with a proper custom field value during order construction.

Permissions: Requires a valid API key and client type.

Multistore Support: Optional store view context header allows routing in multistore environments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

commercialOrderId

string

required

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

Body Params

Request body containing the custom fields to update and their ID type specification.

customFieldIdType

string

enum

Defaults to EXTERNAL_ID

Type of ID used for identifying custom fields.
If omitted, EXTERNAL_ID will be used by default.

Allowed:

customFields

array of objects

List of custom fields to update on the order.

customFields

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

200

Custom fields successfully updated on the order.

400

Invalid request format or custom field data.

401

Unauthorized – user lacks permissions to update the order.

404

Order or store/account not found.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!