Skip to content

Update offer products

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

PATCH/preorders/offers/{id}/products

Costs 2 rate-limit points · Rate limits

Update any subset of the products configuration on a preorder offer: the selection rule, its collection or tags, the exclusions and which inventory policy newly attached variants get.

Deep partial: absent fields are unchanged. Switching selection removes the current variants on Shopify before anything is saved, then refills from the new rule asynchronously; a refused Shopify reset leaves the offer as it was. Custom variants are added and removed with add_variants and remove_variants.

Also searched asedit productschange product selectionchange variant sourceset productsmodify products on offerchange collectionswap collectionuse a different collectionupdate the collection on the offerset excluded variantsexclude variants listblock variants from offerset exclusion tagexclude by tagset exclude tagset source to allapply to all productsauto-sourceevery variantshop-wide preorderset source to collectionuse a collectionlink to collectionset products from collectiondrive variants from collectionset source to customuse custom variantscustom product listswitch to customset source to tagsuse product tagslink to tagsset products from tagsdrive variants from tagschange product tagsset offer tagsedit tags on offer

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

  • selectionstring

    Which rule puts variants on the offer: all (every variant in the shop, minus exclusions), collection, custom (variants added by hand with add_variants) or tags. Changing it removes the current variants from the offer and refills them from the new rule; the previous rule's collection, tags and exclusions are cleared.

    One of allcollectioncustomtags
  • shopify_collection_idstring

    The Shopify collection driving the variant list: its Shopify collection gid from resolve_entities (kind collection); never a title. Required when switching selection to collection.

  • tagsarray of strings

    Product tags; products carrying any of them are on the offer. Replaces the list. Required when switching selection to tags.

  • eligible_inventory_policystring

    continue_selling: STOQ turns on 'Continue selling when out of stock' for the rule's out-of-stock variants so all of them take preorders (editor: Track all products). all: only variants that already have 'Continue selling' on take preorders (editor: Only track products with 'Continue selling' enabled). Not for custom selection.

    One of continue_sellingall
  • excluded_shopify_variant_idsarray of anys, nullable

    Variants held back: Shopify variant gids. Replaces the list; [] or null clears it. selection all or tags only.

  • exclusion_tagstring, nullable

    Variants of products carrying this tag are held back. null clears it. selection all only.

  • inventory_policy_for_removed_variantsstring, nullable

    When selection changes: CONTINUE or DENY sets the inventory policy of the variants coming off the offer first; omit or null leaves it unchanged.

    One of CONTINUEDENYnull

Returns

  • selectionstring

    Rule that puts variants on the offer: all (every variant in the shop, minus exclusions), collection, custom (variants added by hand) or tags.

    One of allcollectioncustomtags
  • shopify_collection_idstring, nullable

    Collection driving the variant list, as gid://shopify/Collection/<id>. Null unless selection is collection.

  • tagsarray of strings

    Product tags; products carrying any of them are on the offer. Empty unless selection is tags.

  • eligible_inventory_policystring

    continue_selling: STOQ turns Continue selling on for the rule's out-of-stock variants so all take preorders. all: only variants that already have Continue selling on take preorders.

    One of continue_sellingall
  • excluded_shopify_variant_idsarray of strings

    Variants held back from the rule, as gid://shopify/ProductVariant/<id>.

  • exclusion_tagstring, nullable

    Variants of products carrying this tag are held back. Null when none is set.

  • variant_countinteger

    Number of variants on the offer, leaving out variants deleted from the catalog.

  • 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 4 child attributesHide child attributes
    • settingstring

      The setting that changed, as the dashboard names it.

    • fromstring

      Its value before the write.

    • tostring

      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.

502
shopify_error

A Shopify call the operation needs failed after the operation had started.

503
upstream_unavailable

A service the answer depends on did not respond in time.

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}/products
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "selection": "collection",
    "shopify_collection_id": "gid://shopify/Collection/482865234104"
  }'
Response
{
  "selection": "collection",
  "shopify_collection_id": "gid://shopify/Collection/482865234104",
  "tags": [],
  "eligible_inventory_policy": "all",
  "excluded_shopify_variant_ids": [],
  "exclusion_tag": null
}