ORDER-150 - Update commercial order lines

put

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

Add or update lines on an existing commercial order.

Scope

Front Office only; caller must be an ACCOUNT user.

Store scoping

Effective store is dj-store header if provided; otherwise the tenant default store.
Caller must be attached to the effective store; otherwise 403.

Operation context

If the order originates from an Operation (sourceType = OPERATION) and you are in a PARTIAL flow:
For a line whose variant belongs to the Operation, apply Operation constraints (visibility, dates, minQuantity / maxQuantity) alongside standard rules.
For a line whose variant does not belong to the Operation, apply standard rules only (no Operation constraints).
If none of the requested lines are eligible after applying all applicable constraints, the request fails with 422.

Response model

On success, returns an array of non-blocking warnings (may be empty) describing adjustments performed by the system (for example, quantity bounded to min/max).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

commercialOrderId

string

required

Commercial order reference

Body Params

List of line updates to apply on the order.
- lineType controls whether id targets an Offer Price or a Product Variant.
- lineIdType controls the id namespace. As of now, only EXTERNAL_ID is supported.
- updateOrderCommercialLines contains the list of line updates to apply.
- Negative quantities are invalid; 0 may remove a line if supported by business rules.
- When the order comes from an Operation (PARTIAL flow), Operation min/max and visibility/date constraints apply to variants belonging to the Operation. - metadata allows passing extra pricing inputs from front to the Real-Time Pricing module (not persisted).

customFieldIdType

string

Identifier type for custom fields applied at line level.

lineIdType

string

Identifier type for the id field in updateOrderCommercialLines.
As of now, only EXTERNAL_ID is supported.

lineType

string

Target entity type for the id field in updateOrderCommercialLines.

metadata

object

updateOrderCommercialLines

array of objects

List of line updates to apply to the order.

updateOrderCommercialLines

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

401

Authentication failed.

403

Forbidden (wrong client type, feature disabled for Operation context, or caller not attached to the effective store).

404

Commercial order not found

422

Unprocessable (invalid payload, or no eligible lines under Operation constraints; e.g. all requested lines are out of Operation scope or violate min/max/date/visibility rules).

500

Unexpected server error.

200Lines updated; warnings may describe non-blocking adjustments.