Remove variants from offers
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/products/remove_from_offersCosts 2 rate-limit points · Rate limits
Take variants out of every preorder offer they are in, as the store-wide Products tab's 'Remove from offer' does.
shopify_variant_ids are up to 100 Shopify variant gids. A variant in an offer that sells in selected markets only is skipped (skipped_market_shopify_variant_ids), as the tab skips it; ones STOQ has no row for come back under not_found. inventory_policy: DENY first turns 'Continue selling' off on the removed variants, offer by offer, as the tab's Remove modal does by default; omit it to leave their policy. Finishes before the response. To remove from one offer only use /preorders/offers/:id/products/remove_variants.
Also searched asremove from offerremove products from all offersunlink variants from offerstake products off preorderstop preorders on these products
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
shopify_variant_idsarray of stringsShopify variant gids to take out of every offer, at most 100.
inventory_policystringDENY turns 'Continue selling' off on the removed variants first. Omit to leave it.
One ofDENY
Returns
variants_removedarray of objectsShow 2 child attributesHide child attributes
shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096offer_idsarray of strings
skipped_market_shopify_variant_idsarray of stringsnot_foundarray of strings
Errors
not_foundThe path is valid but nothing with that id exists in this store.
conflictThe request is well formed, but the resource's current state does not allow it.
job_in_progressAn earlier bulk change on the same resource is still running.
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.
quantity_limit_reachedEvery targeted variant has reached its preorder quantity limit, so STOQ keeps it from selling.
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/products/remove_from_offers" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864"
],
"inventory_policy": "DENY"
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/products/remove_from_offers", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864"
],
"inventory_policy": "DENY"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/products/remove_from_offers",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864"
],
"inventory_policy": "DENY"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/products/remove_from_offers")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
shopify_variant_ids: [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864"
],
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){
"variants_removed": [
{
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"offer_ids": [
"73a74948-2b57-4cc3-971f-2b441828c977"
]
},
{
"shopify_variant_id": "gid://shopify/ProductVariant/47284734455864",
"offer_ids": [
"73a74948-2b57-4cc3-971f-2b441828c977"
]
}
],
"skipped_market_shopify_variant_ids": [],
"not_found": []
}{
"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
}
]
}