Advance an offer's batches
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/products/advance_batchesCosts 2 rate-limit points · Rate limits
Move variants on a batch preorder offer to their next batch, as the Products table's 'Start next batch' does.
Batch offers only. shopify_variant_ids are Shopify variant gids; omit it for every variant that is in a batch. A variant on its last batch stops selling (inventory policy DENY). Ones not on the offer come back under not_attached.
Also searched asadvance batchstart next batchnext waveadvance variants to next batch
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 advance: Shopify variant gids. Omit for every variant that is in a batch.
Returns
advanced_countintegerVariants moved to their next batch.
variantsarray of objectsThose variants after the move, as rows of the offer's Products table.
Show 17 child attributesHide child attributes
idstringID of this variant's place on the offer.
shopify_variant_idstringThe variant, as gid://shopify/ProductVariant/<id>.
productobjectThe variant's product.
Show 3 child attributesHide child attributes
shopify_product_idstringThe product, as gid://shopify/Product/<id>.
titlestringProduct title.
statusnullProduct status in Shopify, such as active, draft, archived or unlisted. Null when not stored yet; include_statuses=true reads it from Shopify.
titlestringVariant name: product and variant title together, or the product title alone for a product's only variant.
variant_titlestringVariant title. Null for a product's only variant (Shopify's "Default Title").
skustringVariant SKU. Null when it has none.
discardedbooleantrue when the variant has been deleted from the catalog.
shipping_textstringThis variant's own shipping text. Null when it has none and the offer's text shows.
max_countintegerThis variant's own quantity limit. Null when it has none. Kept but not enforced while the offer has batches on.
quantity_limitintegerThe quantity limit that applies: max_count, or the batches' total on a batch offer. Null when unlimited. Read-only.
preorder_countintegerUnits preordered that count toward the quantity limit.
quantity_limit_reachedbooleantrue when preorder_count has reached quantity_limit, or the batch limit on a batch offer.
current_batch_idstringBatch the variant is selling in now. Null when the offer has batches off or the variant is in no batch.
created_atstringWhen the variant was added to the offer, ISO 8601 in UTC.
batch_limitsobjectThis variant's own quantity limit per batch, keyed by batch ID. Batches left out use the batch's quantity_limit.
batch_ship_textsobjectThis variant's own ship text per batch, keyed by batch ID. Batches left out use the batch's shipping_text.
batch_progressobjectUnits sold and the limit per batch, and the batch on sale now. Null when the offer has batches off.
Show 2 child attributesHide child attributes
current_batch_idstringBatch the variant is selling in now.
batchesarray of objectsEvery batch, in selling order.
Show 5 child attributesHide child attributes
batch_idstringBatch ID.
positionintegerPlace in the selling order, from 1.
quantity_limitintegerLimit enforced for this variant in the batch: its own batch_limits value, or the batch's.
default_quantity_limitintegerThe batch's own quantity_limit.
countintegerUnits of this variant sold in the batch.
not_attachedarray of anysVariants asked for that are not on the offer or not valid IDs, 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.
validation_failedThe request failed validation.
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/advance_batches" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501"
]
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/advance_batches", {
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"
]
}),
});
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/advance_batches",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501"
]
},
)
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/advance_batches")
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"
]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"advanced_count": 1,
"variants": [
{
"id": "b1f0c6d2-3e4a-4c1b-9a77-2d5e8f1a6c30",
"shopify_variant_id": "gid://shopify/ProductVariant/44712349876501",
"product": {
"shopify_product_id": "gid://shopify/Product/8123456789013",
"title": "Trail Runner Sneaker",
"status": "active"
},
"title": "Trail Runner Sneaker",
"variant_title": "US 9 / Black",
"sku": "TRS-BLK-09",
"discarded": false,
"shipping_text": null,
"max_count": 10,
"quantity_limit": 200,
"preorder_count": 100,
"quantity_limit_reached": false,
"current_batch_id": "e3a1b9c4-7d20-4f5e-a8b6-1c9d0e2f3a45",
"created_at": "2026-06-25T10:42:10Z",
"batch_limits": {},
"batch_ship_texts": {},
"batch_progress": {
"current_batch_id": "e3a1b9c4-7d20-4f5e-a8b6-1c9d0e2f3a45",
"batches": [
{
"batch_id": "0a6f2d8e-41b7-4c39-9e05-6b8d3f1c2a77",
"position": 1,
"quantity_limit": 100,
"default_quantity_limit": 100,
"count": 100
},
{
"batch_id": "e3a1b9c4-7d20-4f5e-a8b6-1c9d0e2f3a45",
"position": 2,
"quantity_limit": 100,
"default_quantity_limit": 100,
"count": 0
}
]
}
}
],
"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
}
]
}