Order Document (Shop API 15.1)

(supports custom properties)

Document representing an order.

Property Type Constraints Description
billing_address OrderAddress   The billing address. This property is part of basket checkout information only.
coupon_items [CouponItem]   The sorted array of coupon items. Can be empty.
creation_date DateTime   The order creation date. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The time zone of the date time is always UTC.
currency String   The ISO 4217 mnemonic code of the currency.
customer_info CustomerInfo   The customer information for logged in customers. This property is part of basket checkout information only.
order_no String   The order number of the order.
order_price_adjustments [PriceAdjustment]   Array of order level price adjustments. Can be empty.
order_token String   The order token used to secure the lookup of an order on base of the plain order number. The order token contains only URL safe characters.
order_total Decimal   Total price of the order, including products, shipping and tax. This property is part of basket checkout information only.
payment_instruments [OrderPaymentInstrument]   The sorted array of payment instruments.
product_items [ProductItem]   The sorted array of product items (up to a maximum of 50 items). Can be empty.
product_sub_total Decimal   Total price of all product items after all product discounts.
product_total Decimal   Total price of all product items after all product and order discounts.
shipments [Shipment]   The array of shipments. This property is part of basket checkout information only.
shipping_total Decimal   Total shipping price of the order after all shipping discounts. Excludes tax if taxation policy is net. Includes tax if taxation policy is gross. This property is part of basket checkout information only.
status Enum {created, new, open, completed, cancelled, replaced, failed}   The status of the order.
tax_total Decimal   Total tax amount of the order. This property is part of basket checkout information only.