Skip to product menu
Skip to main content

Introduction to Carts

A cart contains the products that a user has shortlisted and wishes to purchase. Cart can either belong to a registered customer or be an anonymous cart used by guest login customers. Once a cart is ready for checkout, you can use the Checkout API to convert the cart to an order.

Attributes

AttributeDescription
cart_idstring: Unique ID generated by the server for the cart. This is used as an identifier.
checkout_urlstring: URL for the checkout in the store
codestring: Currency code
total_pricedouble: Total price of the cart
symbol_formattedstring: Formatted symbol of the currency
code_on_leftboolean: Denotes whether the currency code is on the left
formatstring: Format of the currency
countinteger: Count of the items in the cart
itemsarray: Contains the list of items in the cart
selling_pricedouble: Selling price of the item
quantityinteger: Quantity of the item
total_pricedouble: Total price of the item
discount_amountdouble: Discount applied on the item
custom_fieldsarray: Contains the custom fields mapped to the item
descriptionstring: Description of the item
is_out_of_stockboolean: Denotes whether the item is out of stock
label_pricedouble: Label price of the item
stock_availableinteger: The available stock of the item
urlstring: The URL of the product in the store
approximate_totaldouble: The approximate total of the item
approximate_total_formattedstring: Formatted value of the approximate total
variant_idstring: The unique identifier of the variant
namestring: The name of the item
optionsarray: Variant details (name, ID and value of the attributes)
is_returnableboolean: Denotes whether the item is returnable
categorystring: The category of the item
skustring: Stock Keeping Unit of the item
eanstring: International Article Number of the item
isbnstring: International Standard Book Number of the item
upcstring: Universal Product Code of the item
mpnstring: Manufacturer Part Number of the item
brandstring: Brand of the item
imagesarray: Contains the images of the items
imagesarray: Contains the images of the items
idstring: Unique identifier of the image
titlestring: Unique identifier of the image
urlstring: Url of the image in the store
orderinteger: Order of the image
is_featuredboolean: Denotes whether the image is featured
is_placeholder_imageboolean: Denotes whether the image is a placeholder image
alternate_textstring: The alt text to be used for the image
custom_fieldsarray: Contains the custom fields mapped to the item
display_valuestring: Value of the custom field entered by the customer
labelstring: Label of the custom field