Skip to content

Update markets

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

PATCH/preorders/offers/{id}/markets

Costs 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

Headers

  • Idempotency-Keystring

    A 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 (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • scopestring

    all 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 of allselected
  • shopify_market_idsarray of anys

    Shopify 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

  • scopestring

    all applies the offer in every market; selected only in shopify_market_ids.

    One of allselected
  • shopify_market_idsarray of strings

    Markets the offer applies in when scope is selected, as gid://shopify/Market/<id>. Empty when scope is all.

  • also_changedarray of objects

    Settings 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_pathstring

      Dotted path of the changed field in this response, when it is one.

    • settingstring

      The setting that changed, as the dashboard names it.

    • fromarray of strings

      Its value before the write.

    • toarray of anys

      Its value after the write.

    • reasonstring

      Why it changed.

Errors

404
not_found

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

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One 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.

PATCH/preorders/offers/{id}/markets
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"
      ]
    }
  }'
Response
{
  "scope": "selected",
  "shopify_market_ids": [
    "gid://shopify/Market/1",
    "gid://shopify/Market/2"
  ]
}