Skip to content

Get markets

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

GET/preorders/offers/{id}/markets

Costs 1 rate-limit point · Rate limits

Read market scoping for a preorder offer.

scope all (the default) applies the offer in every Shopify market, with shopify_market_ids empty. selected applies it only to shoppers in the listed markets. A market-scoped offer can't also sell in sequential batches. When attaching variants, POST /preorders/offers/:id/products/add_variants with skip_variants_in_market_offers: true leaves out variants a market-scoped offer already has. Edit with PATCH /preorders/offers/:id/markets.

Also searched asget marketsshow market scopingview marketswhat marketswhich countriesmarket settings

Path parameters

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.

Errors

404
not_found

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

422
invalid_params

One or more fields failed the action's schema.

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/offers/{id}/markets
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/markets" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "scope": "all",
  "shopify_market_ids": [
    "string"
  ]
}