Create order
Submits a new order for processing, including essential details like delivery address, order identifier, and item positions.
Request body
The seller id to which this order belongs.
The id of the warehouse where the order gets processed. A list of warehouse identifiers and names can be obtained by executing GET /warehouses
A unique identifier to prevent duplicates of the same order in the system. It can be the id of the order in the shop system or another unique number
The orderReference is set from the customer to identify the order easily. Example: #DE38678
Optional value indicating whether the invoice address is provided. <br>By default the delivery address is used as invoice address.
Optional value indicating whether the invoice data is provided. <br>The invoice data includes currency and sales prices.
The date when the order was placed.
The currency in which the order was placed.
Optional text which contains instructions for the fulfillment and is sent to the warehouse.
Optional date which indicates the earliest allowed date of delivery in ISO 8601 format. Example: 2021-01-10
Optional date which indicates the latest allowed date of delivery in ISO 8601 format. Example: 2021-01-12
Optional amount which should get insured when booking the transport for this order in EUR.
Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment
Optional COD currency.
Optional identifier which indicates how the parcels should be transported. Example: UPSS
Optional name which indicates how the parcels should be transported. Example: UPS Saver
Optional tags of this order
Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true.
Optional value to prioritize order.
Optional value for additional orderReference Example: #DE38678
Optional value which specifies reference code that is assigned to a purchase Example: PO-89225
Optional value setting whether to create ssccLabel or not based on customerPurchaseOrderNumber value.
Optional value which specifies the channel ID of the master client of this order.
Optional value which specifies the channel name of the master client of this order. Example: Obi E-Commerce
Optional value for custom attributes of order.
Response
Returns the result of the order creation attempt, including the newly assigned 'orderId' if successful, or status and error details if validation fails.
Indicates the overall status of the order creation attempt. Typically "OK" on success, or an error status on failure.
On failure, this field indicates the specific request field that caused the error (e.g., "deliveryAddress.countryIso2"). This field is null on success.
A detailed, human-readable message describing the outcome of the operation. This may contain success confirmation or a specific error explanation.
The unique internal ID assigned to the new order upon successful creation. This field is null on failure.