Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Shop API documents 23.2

Order document (Shop API 23.2)

(supports custom properties)

Document representing an order.

Property	Type	Description
`adjusted_merchandize_total_tax`	Decimal	The products tax after discounts applying in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added.
`adjusted_shipping_total_tax`	Decimal	The tax of all shipping line items of the line item container after shipping adjustments have been applied.
`billing_address`	OrderAddress	The billing address. This property is part of basket checkout information only.
`bonus_discount_line_items`	[BonusDiscountLineItem]	The bonus discount line items of the line item container.
`channel_type`	Enum {storefront, callcenter, marketplace, dss, store, pinterest, twitter, facebookads, subscriptions, onlinereservation, customerservicecenter, instagramcommerce, google, tiktok, snapchat, youtube, whatsapp}	The sales channel for the order.
`confirmation_status`	Enum {not_confirmed, confirmed}	The confirmation status of the order.
`coupon_items`	[CouponItem]	The sorted array of coupon items. This array can be empty.
`created_by`	String	The name of the user who created the order.
`creation_date`	Date	Returns the value of attribute 'creationDate'.
`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.
`customer_name`	String	The name of the customer associated with this order.
`export_status`	Enum {not_exported, exported, ready, failed}	The export status of the order.
`external_order_status`	String	The external status of the order.
`gift_certificate_items`	[GiftCertificateItem]	The sorted array of gift certificate line items. This array can be empty.
`global_party_id`	String	globalPartyId is managed by Customer 360. Its value can be changed.
`grouped_tax_items`	[GroupedTax]	Tax values that are summed and grouped based on the tax rate. The tax totals of the line items with the same tax rate will be grouped together and summed up. This will not affect calculation in any way.
`guest`	boolean	The registration status of the customer.
`last_modified`	Date	Returns the value of attribute 'lastModified'.
`merchandize_total_tax`	Decimal	The products total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.
`notes`	SimpleLink	The notes for the line item container.
`order_no`	String	The order number of the order.
`order_price_adjustments`	[PriceAdjustment]	The array of order level price adjustments. This array 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	The total price of the order, including products, shipping and tax. This property is part of basket checkout information only.
`payment_instruments`	[OrderPaymentInstrument]	The payment instruments list for the order.
`payment_status`	Enum {not_paid, part_paid, paid}	The payment status of the order.
`product_items`	[ProductItem]	The sorted array of product items (up to a maximum of 50 items). This array can be empty.
`product_sub_total`	Decimal	The total price of all product items after all product discounts. Depending on taxation policy the returned price is net or gross.
`product_total`	Decimal	The total price of all product items after all product and order discounts. Depending on taxation policy the returned price is net or gross.
`shipments`	[Shipment]	The array of shipments. This property is part of basket checkout information only.
`shipping_items`	[ShippingItem]	The sorted array of shipping items. This array can be empty.
`shipping_status`	Enum {not_shipped, part_shipped, shipped}	The shipping status of the order.
`shipping_total`	Decimal	The 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.
`shipping_total_tax`	Decimal	The tax of all shipping line items of the line item container before shipping adjustments have been applied.
`site_id`	String	The site where the order resides.
`source_code`	String	Gets the source code assigned to this basket.
`status`	Enum {created, new, open, completed, cancelled, replaced, failed}	The status of the order.
`tax_rounded_at_group`	boolean	If the tax is rounded at group level then this is set to true, false if the tax is rounded at item or unit level
`tax_total`	Decimal	The total tax amount of the order. This property is part of basket checkout information only.
`taxation`	Enum {gross, net}	The taxation the line item container is based on.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.