Skip to content

Get page settings

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

GET/preorders/settings/pages

Costs 1 rate-limit point · Rate limits

The Preorder pages settings (Preorders > Settings > Pages): whether the Preorder button shows on the home, collection and search pages, and whether collection pages show the preorder badge when any variant is a preorder. Shop-wide, not per offer. Product pages always show the button. The locations and markets these pages count stock at are GET /account/markets; the page's CSS selectors are GET /preorders/settings/developer.

Change them with PATCH /preorders/settings/pages. All are off on a new shop. show_badge_if_any_variant_is_preorder applies to every product list with the Preorder button on, not only collections, and shows a badge only for offers that have their badge turned on.

Also searched aspreorder pagespreorder on collection pagepreorder on home pagepreorder on search pagepreorder button on other pagescollection page badge

Returns

  • homeobject
    Show 1 child attributeHide child attributes
    • enabledboolean
      Example: true
  • collectionobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: true
    • show_badge_if_any_variant_is_preorderboolean
      Example: true
  • searchobject
    Show 1 child attributeHide child attributes
    • enabledboolean
      Example: true

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/preorders/settings/pages
curl "https://app.stoqapp.com/api/v2/external/preorders/settings/pages" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "home": {
    "enabled": true
  },
  "collection": {
    "enabled": true,
    "show_badge_if_any_variant_is_preorder": true
  },
  "search": {
    "enabled": true
  }
}