---
title: "Transfer a waitlist"
description: "Move a variant's or a product's current waitlist (pending signups) to another variant, as the dashboard's Transfer signups does."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-signups/transfer-a-waitlist/
api: "API v2 reference"
method: POST
path: "/back_in_stock/signups/transfer"
---

# Transfer a waitlist

`POST https://app.stoqapp.com/api/v2/external/back_in_stock/signups/transfer`

Move a variant's or a product's current waitlist (pending signups) to another variant, as the dashboard's Transfer signups does.

**Note:** Give from_shopify_variant_id to move one variant's waitlist, or only from_shopify_product_id to move every variant of a product. Notified signups stay. A signup that would duplicate one already waiting on the target variant is dropped. 422 when the target is not a variant of this store. to_shopify_product_id is read from the target variant when omitted. Moves of more than 500 signups run in the background: background is true and count is the number queued to move.

## 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

- `to_shopify_variant_id` (string, required): Shopify variant gid the signups move to.
- `from_shopify_variant_id` (string): Shopify variant gid whose pending signups move. Give this or from_shopify_product_id.
- `from_shopify_product_id` (string): Shopify product gid; on its own, the pending signups of every variant of it move.
- `to_shopify_product_id` (string): Shopify product gid of the target variant. Read from the variant when omitted.

## Returns

- `count` (integer): Pending signups selected to move. Ones that would duplicate a signup already on the target are dropped, so fewer may arrive.
- `background` (boolean): True when the move runs in the background (more than 500 signups); count is then the number queued to move.

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/back_in_stock/signups/transfer" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from_shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
    "to_shopify_variant_id": "gid://shopify/ProductVariant/47284734455864"
  }'
```

## 202

Success: example response shown.

```json
{
  "count": 42,
  "background": false
}
```

## 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
    }
  ]
}
```

## 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
    }
  ]
}
```

