HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

Update order shipping information

put
https://example.com/v2/shop/commercial-orders//shipping-information

Updates the shipping information of a commercial order during the checkout phase.

The shippingAddressId must be an external ID corresponding to a valid shipping address.
The shippingType is a free-form string used to indicate the delivery mode (e.g. standard, express, pickup).

The update is applied to all linked logistic orders associated with the commercial order.

Permissions: Requires a valid API key and client type.

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

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.
Must be a REFERENCE ID (not a djust or external ID).

Body Params
string
required

External ID of the shipping address to apply.

string
required

Shipping mode identifier (free string, e.g., "STANDARD", "EXPRESS", "PICKUP").

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
204

Shipping information successfully applied to the commercial order and associated logistic orders.

No content is returned in the response.

Updated 4 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 4 months ago