Skip to content

Carts

Create and update carts, calculate delivery, and complete checkout.

Fields

idstringUnique identifier of the resource.
emailstring
currencyCodestringISO 4217 currency code, for example PEN.
statusenuminProgress · pending · completed · abandoned · cancelled · expired · failed
tokenstring
cartNumberstring
phonestring
firstNamestring
See all 25 fields
lastNamestring
completedAtstring
shippingAddressobject
billingAddressobject
promotionCodesarray<string>
itemsarray<object>
shippingMethodsarray<object>
totalsobject
invoiceTypeenumticket · invoice · receipt
identificationTypestring
identificationCountryCodestring
identificationNumberstring
entityNamestring
paymentMethodCodestring
specialInstructionsstring
giftMessagestring
entityTaxIdstring

Operations

MethodEndpointOperation
POST/v1/cartsCreate cart
GET/v1/carts/{cartToken}Get cart
POST/v1/carts/{cartToken}/payment-sessionStart a payment session
POST/v1/carts/{cartToken}/payment-receiptUpload cart payment receipt
GET/v1/carts/{cartToken}/shipping-optionsList cart shipping options
GET/v1/carts/{cartToken}/orderGet cart order group
PUT/v1/carts/{cartToken}/payment-methodSet cart payment method
PATCH/v1/carts/{cartToken}/addressesUpdate cart addresses
PATCH/v1/carts/{cartToken}/buyerUpdate cart buyer
PATCH/v1/carts/{cartToken}/instructionsUpdate the order note and gift message
GET/v1/carts/{cartToken}/shipping-methods/{shippingMethodId}/slotsList shipping slots

Checkout

MethodEndpointOperation
POST/v1/carts/{cartToken}/checkoutCheckout cart
GET/v1/carts/{cartToken}/checkoutGet cart checkout options

Items

MethodEndpointOperation
POST/v1/carts/{cartToken}/itemsAdd item to cart
PATCH/v1/carts/{cartToken}/items/{cartItemId}Update cart item quantity
DELETE/v1/carts/{cartToken}/items/{cartItemId}Remove item from cart

Promotion Codes

MethodEndpointOperation
POST/v1/carts/{cartToken}/promotion-codesAdd promotion code
DELETE/v1/carts/{cartToken}/promotion-codes/{code}Remove promotion code

Shipping Method

MethodEndpointOperation
PUT/v1/carts/{cartToken}/shipping-methodSet cart shipping method
DELETE/v1/carts/{cartToken}/shipping-methodClear cart shipping method

Last updated: