Update pages
BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog
const url = 'https://app.stoqapp.com/api/v2/external/preorders/settings/pages';const options = { method: 'PATCH', headers: {'X-Auth-Token': '<X-Auth-Token>', 'Content-Type': 'application/json'}, body: '{"home":"string","collection":"string","search":"string","locations":"string","market_setup":"gid://shopify/Market/12345","market_locations_enabled":"gid://shopify/Market/12345"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://app.stoqapp.com/api/v2/external/preorders/settings/pages \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: <X-Auth-Token>' \ --data '{ "home": "string", "collection": "string", "search": "string", "locations": "string", "market_setup": "gid://shopify/Market/12345", "market_locations_enabled": "gid://shopify/Market/12345" }'Update the Preorder pages settings (Preorders > Settings > Pages): the Preorder button on the home, collection and search pages, the collection-page badge rule, and the locations and markets those pages count stock at. Shop-wide, not per offer. Does not change the page’s CSS selectors.
Note: Deep partial. home.enabled, collection.enabled and search.enabled switch the Preorder button on those pages. locations.location_ids is replaced wholesale when present. market_setup and market_locations_enabled are the same settings as in the back-in-stock Delivery settings.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Example
{ "home": "string", "collection": "string", "search": "string", "locations": "string", "market_setup": "gid://shopify/Market/12345", "market_locations_enabled": "gid://shopify/Market/12345"}Responses
Section titled “Responses”Success — the updated resource.
object
Example generated
{}Accepted — async/bulk work was queued. Poll the returned job.
Returned for async/bulk work — poll the job until it reaches a terminal state.
object
Example
{ "job_id": "job_a1b2c3", "status_url": "/api/v2/external/jobs/job_a1b2c3"}Missing or invalid X-Auth-Token.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Unauthorized" ]}The request failed validation.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "name is required" ]}Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Rate limit exceeded" ]}Thanks for letting us know.
Still stuck? Ask Quinn or chat with support