Remove variants
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/products/remove_variantsCosts 2 rate-limit points · Rate limits
Remove variants from a custom-selection preorder offer.
Custom selection only. Shopify is reset to the variants that stay before the local rows go, so a refused reset (502) changes nothing. inventory_policy: DENY first turns 'Continue selling' off on the removed variants; omit it to leave their policy as it is. shopify_variant_ids are Shopify variant gids; ones not on the offer come back under not_attached. Finishes before the response.
Also searched asremove variantsdetach variantsremove products from offerunlink variantsexclude variants
Path parameters
idstringRequiredThe offer's ID, from
GET /preorders/offers.
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 stringsVariants to detach from the offer: Shopify variant gids. Custom selection only.
inventory_policystringDENY turns 'Continue selling' off on the removed variants first. Omit to leave it.
One ofDENY
Returns
selectionstringRule that puts variants on the offer: all (every variant in the shop, minus exclusions), collection, custom (variants added by hand) or tags.
One ofallcollectioncustomtagsshopify_collection_idnullCollection driving the variant list, as gid://shopify/Collection/<id>. Null unless selection is collection.
tagsarray of anysProduct tags; products carrying any of them are on the offer. Empty unless selection is tags.
eligible_inventory_policystringcontinue_selling: STOQ turns Continue selling on for the rule's out-of-stock variants so all take preorders. all: only variants that already have Continue selling on take preorders.
One ofcontinue_sellingallexcluded_shopify_variant_idsarray of anysVariants held back from the rule, as gid://shopify/ProductVariant/<id>.
exclusion_tagnullVariants of products carrying this tag are held back. Null when none is set.
variant_countintegerNumber of variants on the offer, leaving out variants deleted from the catalog.
variants_removedarray of stringsVariants taken off the offer, as gid://shopify/ProductVariant/<id>.
not_attachedarray of stringsVariants asked for that are not on the offer, as sent.
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.
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/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/remove_variants" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"inventory_policy": "DENY"
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/remove_variants", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"inventory_policy": "DENY"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/remove_variants",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"inventory_policy": "DENY"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/remove_variants")
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/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
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){
"selection": "custom",
"shopify_collection_id": null,
"tags": [],
"eligible_inventory_policy": "all",
"excluded_shopify_variant_ids": [],
"exclusion_tag": null,
"variant_count": 10,
"variants_removed": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"not_attached": []
}{
"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
}
]
}