Docs

Settings

Every settings endpoint, with its scope, parameters, a request and a response.

GET /settings

Get shop settings

Scope settings:read Returns 200

Request

curl "https://app.shopbird.app/api/v1/settings" \
  -H "Authorization: Bearer sb_live_…"

Response 200

{
  "default_visibility": "buttons",
  "default_hide_from_lists": true
}
PATCH /settings

Update shop settings

Scope settings:write Returns 200

ParameterInTypeDescription
dry_run query true true: validate and return the would-be result; nothing is saved
wait query true true: wait up to 20 s until the change is live at checkout
Idempotency-Key header string Retrying with the same key never applies the write twice (kept 24 h)
If-Match header string The ETag from your last read; required where the resource is versioned
Request body (2 fields)
FieldTypeDescription
default_visibility buttons | price | details | page
default_hide_from_lists boolean

Request

curl -X PATCH "https://app.shopbird.app/api/v1/settings" \
  -H "Authorization: Bearer sb_live_…" \
  -H 'If-Match: "v3"' \
  -H "Content-Type: application/json" \
  -d '{
  "default_visibility": "buttons",
  "default_hide_from_lists": true
}'

Response 200

{
  "default_visibility": "buttons",
  "default_hide_from_lists": true,
  "sync": {
    "generation": 42,
    "status": "pending"
  }
}