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

Settings

Configure commerce module behavior per project. Settings control currency, tax, inventory, and checkout defaults. All routes live under /modules/commerce/* and require a token with commerce:read or commerce:write scope.

Get commerce settings

GET
/modules/commerce/settings
commerce:read

Get or create default commerce settings.

curl
curl https://api.saasignal.saastemly.com/modules/commerce/settings \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Update commerce settings

PATCH
/modules/commerce/settings
commerce:admin

Update commerce settings.

curl
curl -X PATCH https://api.saasignal.saastemly.com/modules/commerce/settings \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 200 OK
{ "status": "ok" }
Body field
Type
Description
default_currency
string
3–3 chars
tax_inclusive
boolean
auto_capture_payments
boolean
inventory_tracking
boolean
allow_backorders
boolean
low_stock_threshold
integer
range ≥0 .. ≤10000
cart_ttl_hours
integer
range ≥1 .. ≤8760
review_moderation
string
values: none, manual, auto
review_auto_approve_min_rating
integer
range ≥1 .. ≤5
max_cart_items
integer
range ≥1 .. ≤1000
order_number_prefix
string
1–10 chars
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited