Basket Document (Shop API 15.1)

(supports custom properties)

Document representing a basket.

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.
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_price_adjustments [PriceAdjustment]   Array of order level price adjustments. Can be empty.
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.
tax_total Decimal   Total tax amount of the order. This property is part of basket checkout information only.

A Flash Message extends a document with additional context information.

Flashs

Type Description
BillingAddressRequired Returned if the billing address is not specified.
CustomerEmailRequired Returned if customer email is not specified.
InvalidCouponItem Returned if an existing coupon item is invalid (for example, its redemption limit has been reached).
InvalidCouponItem Returned if an existing coupon item became invalid (for example, its redemption limit is reached).
InvalidOptionItem Returned if an existing option item refers to an option or option value, which doesn't exist anymore.
InvalidProductItem Returned if an existing product item (or bundled product item) refers to a non-existent product, an offline product, or a product that is not assigned to the site catalog. Also occurs if an existing option item refers to a non-existent option id or option value.
OptionItemWithoutPrice Returned if there is an option item without a price.
PaymentMethodNotApplicable Returned if the payment method is set, but is no longer applicable.
PaymentMethodRequired Returned if payment method is not defined.
ProductItemNotAvailable Returned if there is not enough inventory for the product item quantity.
ProductItemWithoutPrice Returned if there is a product item without a price.
ShippingAddressRequired Returned if shipping address is not specified.
ShippingMethodNotApplicable Returned if the shipping method is set, but is no longer applicable.
ShippingMethodRequired Returned if the shipping method is not specified.