Create products variants bulk update settings
BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog
const url = 'https://app.stoqapp.com/api/v2/external/preorders/offers/example/products/variants/bulk_update_settings';const options = { method: 'POST', headers: {'X-Auth-Token': '<X-Auth-Token>', 'Content-Type': 'application/json'}, body: '{"shipping_text":"Preorder now","max_count":5,"shopify_variant_ids":["45000000001"],"batch_limits":5}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.stoqapp.com/api/v2/external/preorders/offers/example/products/variants/bulk_update_settings \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: <X-Auth-Token>' \ --data '{ "shipping_text": "Preorder now", "max_count": 5, "shopify_variant_ids": [ "45000000001" ], "batch_limits": 5 }'Set the same shipping text, max preorder count or per-batch limits on many variants of a preorder offer.
Note: shopify_variant_ids is required (1 to 250 variant gids attached to the offer). The other fields follow PATCH /preorders/offers/:id/products/variants/:shopify_variant_id: absent is unchanged, null clears. Variants not attached to the offer are skipped and returned in skipped_shopify_variant_ids; the call fails with 422 if none are attached.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Example
{ "shipping_text": "Preorder now", "max_count": 5, "shopify_variant_ids": [ "45000000001" ], "batch_limits": 5}Responses
Section titled “Responses”Success — the updated resource.
object
Example generated
{}Accepted — async/bulk work was queued. Poll the returned job.
Returned for async/bulk work — poll the job until it reaches a terminal state.
object
Example
{ "job_id": "job_a1b2c3", "status_url": "/api/v2/external/jobs/job_a1b2c3"}Missing or invalid X-Auth-Token.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Unauthorized" ]}The resource does not exist for this shop, or the action path is not registered.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Offer not found" ]}The request failed validation.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "name is required" ]}Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Rate limit exceeded" ]}Thanks for letting us know.
Still stuck? Ask Quinn or chat with support