Skip to main content
POST
Add Item to Cart

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Path Parameters

id
string
required

Resource ID

Body

application/json
variant_id
string
required
quantity
integer
required
Required range: x >= 1
metadata
object

Response

200 - application/json

Success

id
string
status
enum<string>
Available options:
active,
completed,
abandoned
session_id
string | null

Guest identification ID

customer_id
string | null
items
object[]
shipping_address
object
billing_address
object
shipping_method_id
string | null
discount_codes
string[]
summary
object
applied_discounts
object[]
metadata
object
created_at
string<date-time>
updated_at
string<date-time>