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

Orders

Create, track, and manage commerce orders through their full lifecycle. Orders support status transitions, line items, shipping, and refunds.

commerceOrderCreate

GET

List orders

GET
/modules/commerce/orders
commerce:read0.0000008 tokens

List commerce orders.

curl
curl https://api.saasignal.saastemly.com/modules/commerce/orders \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Query param
Type
Description
status
string
payment_status
string
fulfillment_status
string
customer_id
string
from
string
to
string
limit
integer
range ≥1 .. ≤100default 25
cursor
string
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Get an order

GET
/modules/commerce/orders/{order_id}
commerce:read0.0000008 tokens

Retrieve a single order with items, payments, and recent events.

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

Update an order

PATCH
/modules/commerce/orders/{order_id}
commerce:write0.0000053 tokens

Update order addresses, notes, or metadata.

curl
curl -X PATCH https://api.saasignal.saastemly.com/modules/commerce/orders/{order_id} \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
order_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
429 Rate limited

Delete an order

DELETE
/modules/commerce/orders/{order_id}
commerce:admin

Permanently remove a pending or cancelled order.

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