Update markets
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/marketsCosts 2 rate-limit points · Rate limits
Update any subset of the market settings on a preorder offer.
Deep partial: absent fields are unchanged. Get market GIDs from the shop's Shopify markets.
Also searched asedit marketschange market scopingmodify marketsenable market scopingturn on market scopingscope to marketsenable marketsdisable market scopingturn off market scopingremove market restrictionsglobal preorderenable all marketsapply to all marketsall countriesavailable everywhereadd marketinclude marketadd countryextend to marketremove marketexclude marketdrop marketremove countryset marketschange marketsrestrict to marketsset countriesset regions
Path parameters
idstringRequiredThe offer's ID, from
GET /preorders/offers.
Headers
Idempotency-KeystringA fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with
Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
scopestringall applies the offer in every market and clears shopify_market_ids; selected applies it only in shopify_market_ids, which must not be empty.
One ofallselectedshopify_market_idsarray of anysShopify Market GIDs (or numeric ids) the offer applies to when scope is selected. An array replaces the list; {"$add": [...], "$remove": [...]} edits it. Emptying the list moves scope to all.
Returns
scopestringall applies the offer in every market; selected only in shopify_market_ids.
One ofallselectedshopify_market_idsarray of stringsMarkets the offer applies in when scope is selected, as gid://shopify/Market/<id>. Empty when scope is all.
also_changedarray of objectsSettings this write changed on its own because they depend on what you changed (turning one option off can reset another). Absent when nothing else changed.
Show 5 child attributesHide child attributes
field_pathstringDotted path of the changed field in this response, when it is one.
settingstringThe setting that changed, as the dashboard names it.
fromarray of stringsIts value before the write.
toarray of anysIts value after the write.
reasonstringWhy it changed.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
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 -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/markets" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shopify_market_ids": {
"$add": [
"gid://shopify/Market/2"
]
}
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/markets", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"shopify_market_ids": {
"$add": [
"gid://shopify/Market/2"
]
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/markets",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shopify_market_ids": {
"$add": [
"gid://shopify/Market/2"
]
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/markets")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
shopify_market_ids: {
"$add" => [
"gid://shopify/Market/2"
]
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"scope": "selected",
"shopify_market_ids": [
"gid://shopify/Market/1",
"gid://shopify/Market/2"
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"A request with this Idempotency-Key is still running"
],
"code": "idempotency_key_in_progress",
"details": [
{
"code": "idempotency_key_in_progress",
"message": "A request with this Idempotency-Key is still running",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"widget.button.text_color must be a hex color"
],
"code": "invalid_params",
"details": [
{
"code": "invalid_params",
"message": "must be a hex color",
"path": "widget.button.text_color",
"value": "blue",
"expected": {
"type": "string"
}
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}