---
title: "Remove variants"
description: "Remove variants from a custom-selection preorder offer."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/remove-variants/
api: "API v2 reference"
method: POST
path: "/preorders/offers/{id}/products/remove_variants"
---

# Remove variants

`POST https://app.stoqapp.com/api/v2/external/preorders/offers/{id}/products/remove_variants`

Remove variants from a custom-selection preorder offer.

**Note:** 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.

## Path parameters

- `id` (string, required): The offer's ID, from [`GET /preorders/offers`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-offers/).

## Headers

- `Idempotency-Key` (string): 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_ids` (array of strings): Variants to detach from the offer: Shopify variant gids. Custom selection only.
- `inventory_policy` (string): DENY turns 'Continue selling' off on the removed variants first. Omit to leave it. One of: `DENY`.

## Returns

- `selection` (string): 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: `all`, `collection`, `custom`, `tags`.
- `shopify_collection_id` (null): Collection driving the variant list, as gid://shopify/Collection/&lt;id&gt;. Null unless selection is collection.
- `tags` (array of anys): Product tags; products carrying any of them are on the offer. Empty unless selection is tags.
- `eligible_inventory_policy` (string): 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_selling`, `all`.
- `excluded_shopify_variant_ids` (array of anys): Variants held back from the rule, as gid://shopify/ProductVariant/&lt;id&gt;.
- `exclusion_tag` (null): Variants of products carrying this tag are held back. Null when none is set.
- `variant_count` (integer): Number of variants on the offer, leaving out variants deleted from the catalog.
- `variants_removed` (array of strings): Variants taken off the offer, as gid://shopify/ProductVariant/&lt;id&gt;.
- `not_attached` (array of strings): Variants asked for that are not on the offer, as sent.

Rate limit: this call costs 2 points ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
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"
  }'
```

## 200

Success: example response shown.

```json
{
  "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": []
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

```json
{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

