Skip to content

Remove variants from offers

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

POST/preorders/products/remove_from_offers

Costs 2 rate-limit points · Rate limits

Take variants out of every preorder offer they are in, as the store-wide Products tab's 'Remove from offer' does.

shopify_variant_ids are up to 100 Shopify variant gids. A variant in an offer that sells in selected markets only is skipped (skipped_market_shopify_variant_ids), as the tab skips it; ones STOQ has no row for come back under not_found. inventory_policy: DENY first turns 'Continue selling' off on the removed variants, offer by offer, as the tab's Remove modal does by default; omit it to leave their policy. Finishes before the response. To remove from one offer only use /preorders/offers/:id/products/remove_variants.

Also searched asremove from offerremove products from all offersunlink variants from offerstake products off preorderstop preorders on these products

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

  • shopify_variant_idsarray of strings

    Shopify variant gids to take out of every offer, at most 100.

  • inventory_policystring

    DENY turns 'Continue selling' off on the removed variants first. Omit to leave it.

    One of DENY

Returns

  • variants_removedarray of objects
    Show 2 child attributesHide child attributes
    • shopify_variant_idstring
      Example: gid://shopify/ProductVariant/47284734423096
    • offer_idsarray of strings
  • skipped_market_shopify_variant_idsarray of strings
  • not_foundarray of strings

Errors

404
not_found

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

409
conflict

The request is well formed, but the resource's current state does not allow it.

409
job_in_progress

An earlier bulk change on the same resource is still running.

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.

422
quantity_limit_reached

Every targeted variant has reached its preorder quantity limit, so STOQ keeps it from selling.

422
validation_failed

The request failed validation.

502
shopify_error

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

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.

POST/preorders/products/remove_from_offers
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/products/remove_from_offers" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shopify_variant_ids": [
      "gid://shopify/ProductVariant/47284734423096",
      "gid://shopify/ProductVariant/47284734455864"
    ],
    "inventory_policy": "DENY"
  }'
Response
{
  "variants_removed": [
    {
      "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
      "offer_ids": [
        "73a74948-2b57-4cc3-971f-2b441828c977"
      ]
    },
    {
      "shopify_variant_id": "gid://shopify/ProductVariant/47284734455864",
      "offer_ids": [
        "73a74948-2b57-4cc3-971f-2b441828c977"
      ]
    }
  ],
  "skipped_market_shopify_variant_ids": [],
  "not_found": []
}