Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.CartSummary

A cart summary.
Property Name Type Description Available Version
accountId String ID of the account for the cart. 49.0
cartId String ID of the cart. 49.0
currencyIsoCode String Three-letter ISO 4217 currency code associated with the cart. 49.0
grandTotalAmount String Grand total amount including shipping and tax for items in the cart, in the currency of the cart. 49.0
isSecondary Boolean Specifies whether the cart is secondary (true) or not (false). 53.0
name String Name of the cart. 49.0
ownerId String ID of the owner of the cart. 49.0
ownerOrderId String ID of the owner of the order. 58.0
purchaseOrderNumber String Purchase order for the cart. 50.0
status ConnectApi.​CartStatus Status of the cart. Values are:
  • Active—Cart is created and available for modifications, like adding or removing products or promotions.
  • Checkout—Cart is in checkout. If the customer modifies the cart, the current checkout session is canceled.
  • Closed—Checkout is complete and an order was created. The cart cannot be modified.
  • PendingClosed—Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified. This value is available in API version 57.0 and later.
  • PendingDelete—Cart is marked for delete, but the request isn't completed yet. The cart can’t be modified.
  • Processing—Cart is processing. For example, taxes are being calculated. The cart can’t be modified.
49.0
taxType String Tax type of the cart.
  • Gross—Gross taxation policy.
  • Net—Net taxation policy.
55.0
totalChargeAmount String Total amount for shipping and other charges in the currency of the cart. 49.0
totalListPrice String Total list price for the cart. 49.0
totalProductAmount String Total amount including discounts, but excluding shipping and tax, for product items in the cart. 49.0
totalProductAmount​AfterAdjustments String Total product amount, including promotions. 52.0
totalProductCount String Total count of items in the cart. 49.0
totalPromotional​AdjustmentAmount String Total promotional adjustment amount for items in the cart. 52.0
totalTaxAmount String Total tax amount for the cart, including tax on shipping, if applicable. 49.0
type ConnectApi.​CartType Type of cart. Value is Cart. 49.0
uniqueProductCount Integer Total count of unique items, or SKUs, in the cart. 49.0
webstoreId String ID of the webstore of the cart. 49.0