/settings Get shop settings
Request
curl "https://app.shopbird.app/api/v1/settings" \
-H "Authorization: Bearer sb_live_…" Response 200
{
"default_visibility": "buttons",
"default_hide_from_lists": true
} Docs
Every settings endpoint, with its scope, parameters, a request and a response.
/settings Get shop settings
Request
curl "https://app.shopbird.app/api/v1/settings" \
-H "Authorization: Bearer sb_live_…" Response 200
{
"default_visibility": "buttons",
"default_hide_from_lists": true
} /settings Update shop settings
| Parameter | In | Type | Description |
|---|---|---|---|
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 |
| Field | Type | Description |
|---|---|---|
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"
}
}