Sign in

v1

latestOpenAPI 3.0.02026-07-226950132.6 KB
cart

Get cart contents

Gets the cart contents including items, totals, and customer information.

get/cart

Query parameters

cart_keystring

Unique identifier for the cart/customer.

fieldsstring

Specify each parent field you want to request separated by (,) in the response before the data is fetched.

defaultboolean

Return the default cart data if set to true.

thumbboolean

True if you want to return the URL of the featured product image for each item in the cart.

Response

Cart retrieved successfully.

cart_hashstring

Unique cart hash.

cart_keystring

Unique cart key for the customer.

itemsobject

Cart items indexed by item key.

item_countinteger

Total number of items in cart.

items_weightnumber

Total weight of all items.

needs_paymentboolean

Whether the cart needs payment.

needs_shippingboolean

Whether the cart needs shipping.

noticesobject

Cart notices and messages.

extensionsobject

Additional data from extensions.