Skip to content

Get pages

BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog

GET
/preorders/settings/pages
curl --request GET \
--url https://app.stoqapp.com/api/v2/external/preorders/settings/pages \
--header 'X-Auth-Token: <X-Auth-Token>'

The Preorder pages settings (Preorders > Settings > Pages): whether the Preorder button shows on the home, collection and search pages, whether collection pages show the preorder badge when any variant is a preorder, and the locations and markets those pages count stock at. Shop-wide, not per offer. Product pages always show the button. The page’s CSS selectors (Dev mode) are not part of it.

Success — the requested resource.

Media typeapplication/json
object

Example generated

{}

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Unauthorized"
]
}

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"name is required"
]
}

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Rate limit exceeded"
]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support