Skip to content

Remove from all offers

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

POST/preorders/product_variants/{shopify_variant_id}/detach_from_all_offers

Costs 2 rate-limit points · Rate limits

Remove a variant from every preorder offer it's attached to. Customer orders are unaffected.

Destructive. Each offer is reset on Shopify before its local link is removed. detached_offer_ids lists the offers it left; failed lists any Shopify refused, which keep the variant (207 when some failed, 502 when all did). inventory_policy: DENY first turns 'Continue selling' off on the variant.

Also searched asremove variant from all preordersdetach from preorderkick variant out of offersremove from all offers

Path parameters

  • shopify_variant_idstringRequired

    The variant, as gid://shopify/ProductVariant/<id> or the numeric ID.

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

  • inventory_policystring

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

    One of DENY

Returns

  • variantobject
    Show 9 child attributesHide child attributes
    • idstring
      Example: 3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85
    • shopify_variant_idstring
      Example: gid://shopify/ProductVariant/47284734423096
    • productobject
      Show 3 child attributesHide child attributes
      • shopify_product_idstring
        Example: gid://shopify/Product/8784906035384
      • titlestring
        Example: Classic Sneaker
      • statusnull
        Example: active
    • variant_titlestring
      Example: Blue / Medium
    • skustring
      Example: CS-BLU-M
    • image_urlstring
      Example: https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…
    • offersarray of anys
    • preorder_units_soldinteger
      Example: 41
    • line_item_revenuestring
      Example: 4510.00
  • offersarray of anys
  • detached_offer_idsarray of strings
  • failedarray of anys

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.

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/product_variants/{shopify_variant_id}/detach_from_all_offers
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/detach_from_all_offers" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inventory_policy": "DENY"
  }'
Response
{
  "variant": {
    "id": "3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85",
    "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
    "product": {
      "shopify_product_id": "gid://shopify/Product/8784906035384",
      "title": "Classic Sneaker",
      "status": "active"
    },
    "variant_title": "Blue / Medium",
    "sku": "CS-BLU-M",
    "image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-blue.jpg",
    "offers": [],
    "preorder_units_sold": 41,
    "line_item_revenue": "4510.00"
  },
  "offers": [],
  "detached_offer_ids": [
    "73a74948-2b57-4cc3-971f-2b441828c977"
  ],
  "failed": []
}