Transfer a waitlist
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/signups/transferCosts 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-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
to_shopify_variant_idstringRequiredShopify variant gid the signups move to.
from_shopify_variant_idstringShopify variant gid whose pending signups move. Give this or from_shopify_product_id.
from_shopify_product_idstringShopify product gid; on its own, the pending signups of every variant of it move.
to_shopify_product_idstringShopify product gid of the target variant. Read from the variant when omitted.
Returns
countintegerPending signups selected to move. Ones that would duplicate a signup already on the target are dropped, so fewer may arrive.
backgroundbooleanTrue when the move runs in the background (more than 500 signups); count is then the number queued to move.
Errors
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe 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.
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"
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/transfer", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"from_shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"to_shopify_variant_id": "gid://shopify/ProductVariant/47284734455864"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/back_in_stock/signups/transfer",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"from_shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"to_shopify_variant_id": "gid://shopify/ProductVariant/47284734455864"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/transfer")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
from_shopify_variant_id: "gid://shopify/ProductVariant/47284734423096",
to_shopify_variant_id: "gid://shopify/ProductVariant/47284734455864"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"count": 42,
"background": false
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"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
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}