Skip to content

Remove variants

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

POST/preorders/offers/{id}/products/remove_variants

Costs 2 rate-limit points · Rate limits

Remove variants from a custom-selection preorder offer.

Custom selection only. Shopify is reset to the variants that stay before the local rows go, so a refused reset (502) changes nothing. inventory_policy: DENY first turns 'Continue selling' off on the removed variants; omit it to leave their policy as it is. shopify_variant_ids are Shopify variant gids; ones not on the offer come back under not_attached. Finishes before the response.

Also searched asremove variantsdetach variantsremove products from offerunlink variantsexclude variants

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

  • shopify_variant_idsarray of strings

    Variants to detach from the offer: Shopify variant gids. Custom selection only.

  • inventory_policystring

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

    One of DENY

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_idnull

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

  • tagsarray of anys

    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 anys

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

  • exclusion_tagnull

    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.

  • variants_removedarray of strings

    Variants taken off the offer, as gid://shopify/ProductVariant/<id>.

  • not_attachedarray of strings

    Variants asked for that are not on the offer, as sent.

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
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/offers/{id}/products/remove_variants
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/remove_variants" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shopify_variant_ids": [
      "gid://shopify/ProductVariant/44712349876501",
      "gid://shopify/ProductVariant/44712349909269"
    ],
    "inventory_policy": "DENY"
  }'
Response
{
  "selection": "custom",
  "shopify_collection_id": null,
  "tags": [],
  "eligible_inventory_policy": "all",
  "excluded_shopify_variant_ids": [],
  "exclusion_tag": null,
  "variant_count": 10,
  "variants_removed": [
    "gid://shopify/ProductVariant/44712349876501",
    "gid://shopify/ProductVariant/44712349909269"
  ],
  "not_attached": []
}