Last update:
November 27, 2024
CartType object¶
This type defines the properties and fields associated with a shopping cart.
Fields¶
| Field | Description |
|---|---|
id String! |
The Id for the cart. |
name String! |
The name of the cart. |
status String |
The current status of the cart. |
storeId String! |
The Id of the store associated with the cart. |
channelId String |
The Id of the sales channel associated with the cart. |
hasPhysicalProducts Boolean |
Indicates whether the cart contains physical products. |
isAnonymous Boolean! |
Indicates whether the cart is associated with an anonymous user. |
customerId String! |
The Id of the customer associated with the cart. |
customerName String |
The name of the customer associated with the cart. |
organizationId String |
The Id of the organization associated with the cart. |
organizationName String |
The name of the organization associated with the cart. |
isRecuring Boolean |
Indicates whether the cart is for a recurring order. |
comment String |
Any comments associated with the cart. |
purchaseOrderNumber String |
The purchase order number associated with the cart. |
checkoutId String! |
The Id for the checkout process, refreshed after order creation. |
volumetricWeight Decimal |
The volumetric weight of the items in the cart. |
weightUnit String |
The unit of weight measurement used. |
weight Decimal |
The total weight of the items in the cart. |
total MoneyType! |
The total cost of the cart. |
subTotal MoneyType! |
The subtotal of the cart before taxes and discounts. |
subTotalWithTax MoneyType! |
The subtotal of the cart including taxes. |
extendedPriceTotal MoneyType! |
The total extended price of the items in the cart. |
extendedPriceTotalWithTax MoneyType! |
The total extended price of the items in the cart including taxes. |
currency CurrencyType! |
The currency used for the cart. |
taxTotal MoneyType! |
The total amount of tax for the cart. |
taxPercentRate Decimal! |
The tax rate applied to the cart. |
taxType String |
The type of tax applied to the cart. |
taxDetails [TaxDetailType!]! |
A list of detailed tax information for the cart. |
fee MoneyType! |
The fee associated with the cart. |
feeWithTax MoneyType! |
The fee including taxes. |
feeTotal MoneyType! |
The total fee for the cart. |
feeTotalWithTax MoneyType! |
The total fee for the cart including taxes. |
shippingPrice MoneyType! |
The shipping price for the cart. |
shippingPriceWithTax MoneyType! |
The shipping price including taxes. |
shippingTotal MoneyType! |
The total shipping cost for the cart. |
shippingTotalWithTax MoneyType! |
The total shipping cost including taxes. |
shipments [ShipmentType!]! |
A list of shipments associated with the cart. |
availableShippingMethods [ShippingMethodType!]! |
A list of available shipping methods for the cart. |
paymentPrice MoneyType! |
The price of the payment method for the cart. |
paymentPriceWithTax MoneyType! |
The price of the payment method including taxes. |
paymentTotal MoneyType! |
The total payment amount for the cart. |
paymentTotalWithTax MoneyType! |
The total payment amount including taxes. |
payments [PaymentType!]! |
A list of payments associated with the cart. |
availablePaymentMethods [PaymentMethodType!]! |
A list of available payment methods for the cart. |
handlingTotal MoneyType! |
The total handling fee for the cart. |
handlingTotalWithTax MoneyType! |
The total handling fee including taxes. |
discountTotal MoneyType! |
The total discount applied to the cart. |
discountTotalWithTax MoneyType! |
The total discount including taxes. |
subTotalDiscount MoneyType! |
The discount applied to the subtotal of the cart. |
subTotalDiscountWithTax MoneyType! |
The discount applied to the subtotal including taxes. |
discounts [DiscountType!]! |
A list of discounts applied to the cart. |
addresses [CartAddressType!]! |
A list of addresses associated with the cart. |
gifts [GiftItemType!]! |
A list of gift items in the cart. |
availableGifts [GiftItemType!]! |
A list of available gift items for the cart. |
items [LineItemType!]! |
A list of line items in the cart. |
itemsCount Int! |
The total number of items in the cart. |
itemsQuantity Int! |
The total quantity of items in the cart. |
coupons [CouponType!]! |
A list of coupons applied to the cart. |
dynamicProperties(...) [DynamicPropertyValueType!]! |
A list of dynamic properties associated with the cart. |
validationErrors(...) [ValidationErrorType!]! |
A list of validation errors associated with the cart. |
type String |
The type of the cart. |
warnings [ValidationErrorType!]! |
A list of warnings related to the cart. |
The Cart.Addresses field in CartType is a functional enabler. Currently, it is not featured in any internal business logic and is separated from Cart.Billing.Addresses and Cart.Shipping.Addresses. Feel free to add your own business logic to it.
You can find the address type structure here.