Remove from all offers
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/product_variants/{shopify_variant_id}/detach_from_all_offersCosts 2 rate-limit points · Rate limits
Remove a variant from every preorder offer it's attached to. Customer orders are unaffected.
Destructive. Each offer is reset on Shopify before its local link is removed. detached_offer_ids lists the offers it left; failed lists any Shopify refused, which keep the variant (207 when some failed, 502 when all did). inventory_policy: DENY first turns 'Continue selling' off on the variant.
Also searched asremove variant from all preordersdetach from preorderkick variant out of offersremove from all offers
Path parameters
shopify_variant_idstringRequiredThe variant, as gid://shopify/ProductVariant/<id> or the numeric ID.
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
inventory_policystringDENY turns 'Continue selling' off on the variant first. Omit to leave it.
One ofDENY
Returns
variantobjectShow 9 child attributesHide child attributes
idstringExample:3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096productobjectShow 3 child attributesHide child attributes
shopify_product_idstringExample:gid://shopify/Product/8784906035384titlestringExample:Classic SneakerstatusnullExample:active
variant_titlestringExample:Blue / MediumskustringExample:CS-BLU-Mimage_urlstringExample:https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…offersarray of anyspreorder_units_soldintegerExample:41line_item_revenuestringExample:4510.00
offersarray of anysdetached_offer_idsarray of stringsfailedarray of anys
Errors
not_foundThe path is valid but nothing with that id exists in this store.
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 request failed validation.
shopify_errorA 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.
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/detach_from_all_offers" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"inventory_policy": "DENY"
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/detach_from_all_offers", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"inventory_policy": "DENY"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/detach_from_all_offers",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"inventory_policy": "DENY"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/detach_from_all_offers")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
inventory_policy: "DENY"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"variant": {
"id": "3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"product": {
"shopify_product_id": "gid://shopify/Product/8784906035384",
"title": "Classic Sneaker",
"status": "active"
},
"variant_title": "Blue / Medium",
"sku": "CS-BLU-M",
"image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-blue.jpg",
"offers": [],
"preorder_units_sold": 41,
"line_item_revenue": "4510.00"
},
"offers": [],
"detached_offer_ids": [
"73a74948-2b57-4cc3-971f-2b441828c977"
],
"failed": []
}{
"variant": {
"id": "string",
"shopify_variant_id": "string",
"product": {
"shopify_product_id": "string",
"title": "string",
"status": null
},
"variant_title": "string",
"sku": "string",
"image_url": "string",
"offers": [
{
"id": "string",
"shipping_text": "string",
"max_count": 1,
"quantity_limit": 1,
"preorder_count": 1,
"quantity_limit_reached": true
}
],
"preorder_units_sold": 1,
"line_item_revenue": "string"
},
"offers": [
{
"id": "string",
"internal_name": "string",
"current_status": "string",
"inventory": {
"stock_condition": "string"
},
"markets": {
"scope": "string"
},
"shipping": {
"timeline": {
"scope": "string"
}
},
"widget": {
"disclaimer": {
"disclaimer_text": "string"
}
},
"payments": {
"options_offered": "string"
}
}
],
"detached_offer_ids": [
"string"
],
"failed": [
{
"offer_id": "string",
"error": "string"
}
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"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
}
]
}