Create an order

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

Parameter	Details
shopKey required	string Example: ms
countryCode required	string Example: de

Request body

required

Parameter	Details
id	integer
address required	object billing object forward object shipping object
basketKey	string
campaignKey	string
confirmedAt	string Example: 2021-09-23T11%3A30%3A58%2B00%3A00
contacts	object type string value string
cost	object appliedFees array object appliedReductions array object withTax integer withoutTax integer withTaxWithMembershipDiscountWithoutServiceCosts integer withoutTaxWithMembershipDiscount integer costCapture integer tax object
currencyCode	string
customer required MinProps: 1	object referenceKey string MinLength: 1 MaxLength: 100 Pattern: ^[0-9a-zA-Z\-\\_\.\@]*$ identities array object legacyCustomData status object company object
shopCountry required readonly	object countryCode string MinLength: 2 MaxLength: 2 Example: DE defaultLanguageCode string MaxLength: 5 Example: de_DE supportedLanguageCodes array string MaxLength: 5 Example: de_DE url string Example: https://www.example.com currencyCode string nullable Example: EUR customData nullable object MinProps: 1 assortment object
invoicedAt	string Example: 2021-09-23T11%3A30%3A58%2B00%3A00
createdAt	string Example: 2021-09-23T11%3A30%3A58%2B00%3A00
updatedAt readonly	string Example: 2021-09-23T11%3A30%3A58%2B00%3A00
items	object availableQuantity integer currency string Pattern: ^([A-Z]{3})$ legacyCustomData packageId integer key string reservationKey string status string Enum: available cancelled delivered returned unavailable warehouseId integer nullable campaignKey string createdAt string Format: date-time Example: 2021-09-23T11%3A30%3A58%2B00%3A00 deliveryForecast object price object lowestPriorPrice object product object promotion object variant object itemGroup object merchant object
legacyCustomData	object
membershipDiscount readonly	object membershipCardId integer pointsUsed integer reductionValue integer tax integer
packages	object id integer shipmentKey string carrierKey string nullable deliveryStatus string Enum: open shipment_pending delegation_pending shipment_completed cancellation_complete deliveryDate object tracking object
payment	object amount integer key string transactionKey string installment array object data object options object
promotion nullable	object id string code string displayName string reduction string version string
publicKey MinLength: 1 MaxLength: 100	string
referenceKey MinLength: 1 MaxLength: 100	string
shipping	object policy string deliveredOn string Pattern: [0-9]{4}\-[0-9]{2}\-[0-9]{2} deliveryCosts integer expressDeliveryCosts integer
status	string Enum: order_open payment_pending payment_reserved invoice_completed cancellation_pending cancellation_completed invoice_partially_completed
detailedStatus required	object order code string required name string required shipping code string required name string required billing code string required name string required
vouchers	object id integer applicableItems array object code string type string Enum: absolute relative value integer
voucher required	object id integer applicableItems array object code string type string Enum: absolute relative value integer
loyaltyCard required	object cardNumber string points integer provider string Pattern: [A-Za-z]

Responses

200

The order has been successfully created

application/json

Success

integer

object

basketKey

string

campaignKey

string

confirmedAt

string

Example:

2021-09-23T11%3A30%3A58%2B00%3A00

Array of object

required

object

currencyCoderequired

string

object

invoicedAt

string

Example:

2021-09-23T11%3A30%3A58%2B00%3A00

createdAt

string

Example:

2021-09-23T11%3A30%3A58%2B00%3A00

updatedAt

string

Example:

2021-09-23T11%3A30%3A58%2B00%3A00

Array of object

object

Array of object

publicKey

string

referenceKey

string

object

status

string

object

Array of object

object

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

409

Conflict error

application/json

Error

422

Unprocessable content

application/json

Error

POST/shops/{shopKey}/countries/{countryCode}/orders

Request samples

Response samples

200

Order:

Content type: application/json