PartnershipsBook Demo
Loading...
API Reference
Cart

Endpoints allowing you to manage cart contents, customer information, and shipping options

# Endpoints
get
/cart/{id}
Fetches cart details, including products, buyer identity, and cart costs
post
/cart/add
Adds items to an existing cart using Variant IDs
post
/cart/update
Updates an existing cart by modifying existing cart items quantities
del
/cart/items
Remove a product variant from a cart (removes entire variant regardless of quantity)
get
/cart/status/{id}
Retrieve the current status of a cart
get
Get Cart

Fetches cart details, including products, buyer identity, and cart costs

Parameters
id
string
required
Cart ID (ULID format)
get
/cart/{id}
shell
javascript
go
java
php
{} Response
200
400
401
403
404
500
post
Add Items to Cart
Adds items to an existing cart using Variant IDs
Request body
cart_id
string
Optional. If omitted, a new cart is created and its ID is returned.
item
object
required
item parameter
item.customizations
object[]
Buyer-supplied customizations (e.g. player, name on back)
item.customizations[].key
string
required
Matches product_customizations.key
item.customizations[].text_value
string
Free-text input (for text types)
item.customizations[].value
string
Selected option value (for single_select / multi_select)
item.quantity
integer
Number of units (0 to remove item)
item.variant_id
string
required
Product variant ID from catalog
post
/cart/add
shell
javascript
go
java
php
{} Response
200
400
401
403
500
post
Update Cart Item
Updates an existing cart by modifying existing cart items quantities
Request body
cart_id
string
Optional. If omitted, a new cart is created and its ID is returned.
item
object
required
item parameter
item.customizations
object[]
Buyer-supplied customizations (e.g. player, name on back)
item.customizations[].key
string
required
Matches product_customizations.key
item.customizations[].text_value
string
Free-text input (for text types)
item.customizations[].value
string
Selected option value (for single_select / multi_select)
item.quantity
integer
Number of units (0 to remove item)
item.variant_id
string
required
Product variant ID from catalog
post
/cart/update
shell
javascript
go
java
php
{} Response
200
400
401
403
500
del
Delete Cart Item
Remove a product variant from a cart (removes entire variant regardless of quantity)
Request body
cart_id
string
required
Cart ID in ULID format
variant_id
string
required
Product variant ID to remove
del
/cart/items
shell
javascript
go
java
php
{} Response
200
400
401
403
500
get
Get Cart Status
Retrieve the current status of a cart
Parameters
id
string
required
Cart ID (UUID format)
get
/cart/status/{id}
shell
javascript
go
java
php
{} Response
200
400
404
500
get
/cart/{id}
shell
javascript
go
java
php
{} Response
200
400
401
403
404
500