Get page settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/settings/pagesCosts 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
homeobjectShow 1 child attributeHide child attributes
enabledbooleanExample:true
collectionobjectShow 2 child attributesHide child attributes
enabledbooleanExample:trueshow_badge_if_any_variant_is_preorderbooleanExample:true
searchobjectShow 1 child attributeHide child attributes
enabledbooleanExample:true
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/settings/pages" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/settings/pages", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/settings/pages",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/settings/pages")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"home": {
"enabled": true
},
"collection": {
"enabled": true,
"show_badge_if_any_variant_is_preorder": true
},
"search": {
"enabled": true
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}