Search docs ⌘K
esc
Type to search across all documentation pages
Commerce

Carts

Manage shopping carts. Carts hold line items and can be converted to orders at checkout.

Create a cart

POST
/modules/commerce/carts
commerce:write0.0000053 tokens

Create a new shopping cart.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/commerce/carts \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 201 Created
{ "status": "ok" }
Body field
Type
Description
customer_id
string
session_id
string
currency
string
max 3 chars
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Get a cart

GET
/modules/commerce/carts/{cart_id}
commerce:read0.0000008 tokens

Retrieve a cart with items.

curl
curl https://api.saasignal.saastemly.com/modules/commerce/carts/{cart_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
cart_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

commerceCartUpdate

GET

commerceCartDelete

GET

Add item to cart

POST
/modules/commerce/carts/{cart_id}/items
commerce:write0.0000053 tokens

Add an item to a cart.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/commerce/carts/{cart_id}/items \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"product_id":"..."}'
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
cart_id required
string
Body field
Type
Description
product_id required
string
variant_id
string
quantity
integer
range ≥1 .. ≤9007199254740991default 1
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
422 Unprocessable entity
429 Rate limited

Update cart item quantity

PATCH
/modules/commerce/carts/{cart_id}/items/{item_id}
commerce:write0.0000053 tokens

Update the quantity of a cart item.

curl
curl -X PATCH https://api.saasignal.saastemly.com/modules/commerce/carts/{cart_id}/items/{item_id} \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"quantity":1}'
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
cart_id required
string
item_id required
string
Body field
Type
Description
quantity required
integer
range ≥1 .. ≤9007199254740991
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
422 Unprocessable entity
429 Rate limited

Remove cart item

DELETE
/modules/commerce/carts/{cart_id}/items/{item_id}
commerce:write0.0000053 tokens

Remove an item from a cart.

curl
curl -X DELETE https://api.saasignal.saastemly.com/modules/commerce/carts/{cart_id}/items/{item_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
cart_id required
string
item_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Checkout a cart

POST
/modules/commerce/carts/{cart_id}/checkout
commerce:write0.0000106 tokens

Convert a cart into an order.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/commerce/carts/{cart_id}/checkout \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 201 Created
{ "status": "ok" }
Path param
Type
Description
cart_id required
string
Body field
Type
Description
shipping_address
any JSON
billing_address
any JSON
notes
string
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
422 Unprocessable entity
429 Rate limited