Skip to content

Transfer a waitlist

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

POST/back_in_stock/signups/transfer

Costs 2 rate-limit points · Rate limits

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

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.

Also searched astransfer signupsmove the waitlistmove signups to another variantmerge waitlistsshift restock signups to a new variantmove requests

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

  • to_shopify_variant_idstringRequired

    Shopify variant gid the signups move to.

  • from_shopify_variant_idstring

    Shopify variant gid whose pending signups move. Give this or from_shopify_product_id.

  • from_shopify_product_idstring

    Shopify product gid; on its own, the pending signups of every variant of it move.

  • to_shopify_product_idstring

    Shopify product gid of the target variant. Read from the variant when omitted.

Returns

  • countinteger

    Pending signups selected to move. Ones that would duplicate a signup already on the target are dropped, so fewer may arrive.

  • backgroundboolean

    True when the move runs in the background (more than 500 signups); count is then the number queued to move.

Errors

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 action refused the request for a reason that is not a single bad field.

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/back_in_stock/signups/transfer
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"
  }'
Response
{
  "count": 42,
  "background": false
}