WRwritechoiceorg
orders

Create order

Submits a new order for processing, including essential details like delivery address, order identifier, and item positions.

post/orders

Request

Request body

sellerIdinteger required

The seller id to which this order belongs.

warehouseIdinteger

The id of the warehouse where the order gets processed. A list of warehouse identifiers and names can be obtained by executing GET /warehouses

orderIdentifierstring required

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

orderReferencestring required

The orderReference is set from the customer to identify the order easily. Example: #DE38678

hasInvoiceAddressboolean

Optional value indicating whether the invoice address is provided. <br>By default the delivery address is used as invoice address.

hasInvoiceDataboolean

Optional value indicating whether the invoice data is provided. <br>The invoice data includes currency and sales prices.

orderDatestring date-time

The date when the order was placed.

currencyCodestring

The currency in which the order was placed.

invoiceIdsstring[]
commentstring

Optional text which contains instructions for the fulfillment and is sent to the warehouse.

earliestDeliveryDatestring date

Optional date which indicates the earliest allowed date of delivery in ISO 8601 format. Example: 2021-01-10

latestDeliveryDatestring date

Optional date which indicates the latest allowed date of delivery in ISO 8601 format. Example: 2021-01-12

transportInsuranceAmountnumber

Optional amount which should get insured when booking the transport for this order in EUR.

cashOnDeliveryAmountnumber

Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment

cashOnDeliveryCurrencystring

Optional COD currency.

shippingMethodIdentifierstring

Optional identifier which indicates how the parcels should be transported. Example: UPSS

shippingMethodNamestring

Optional name which indicates how the parcels should be transported. Example: UPS Saver

tagsstring[]

Optional tags of this order

trackingEnabledboolean

Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true.

orderPriorityinteger

Optional value to prioritize order.

orderReference2string

Optional value for additional orderReference Example: #DE38678

customerPurchaseOrderNumberstring

Optional value which specifies reference code that is assigned to a purchase Example: PO-89225

ssccLabelboolean

Optional value setting whether to create ssccLabel or not based on customerPurchaseOrderNumber value.

channelIdstring

Optional value which specifies the channel ID of the master client of this order.

channelNamestring

Optional value which specifies the channel name of the master client of this order. Example: Obi E-Commerce

customAttributesobject

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.

statusstring

Indicates the overall status of the order creation attempt. Typically "OK" on success, or an error status on failure.

fieldstring

On failure, this field indicates the specific request field that caused the error (e.g., "deliveryAddress.countryIso2"). This field is null on success.

messagestring

A detailed, human-readable message describing the outcome of the operation. This may contain success confirmation or a specific error explanation.

orderIdinteger

The unique internal ID assigned to the new order upon successful creation. This field is null on failure.

Changes

No recorded changes to this operation across all 6 revisions of this API.