Bulk Sync Metafields
BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog
POST
/preorders/product_variants/bulk_sync_metafields
const url = 'https://app.stoqapp.com/api/v2/external/preorders/product_variants/bulk_sync_metafields';const options = { method: 'POST', headers: {'X-Auth-Token': '<X-Auth-Token>', 'Content-Type': 'application/json'}, body: '{"variant_ids":["45000000001"]}'};
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/product_variants/bulk_sync_metafields \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: <X-Auth-Token>' \ --data '{ "variant_ids": [ "45000000001" ] }'Force-resync preorder metafields for many variants in one job (max 5000).
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
variant_ids
Example
{ "variant_ids": [ "45000000001" ]}Responses
Section titled “Responses”Success — the updated resource.
Media typeapplication/json
object
Example generated
{}Accepted — async/bulk work was queued. Poll the returned job.
Media typeapplication/json
Returned for async/bulk work — poll the job until it reaches a terminal state.
object
job_id
string
status_url
string
Example
{ "job_id": "job_a1b2c3", "status_url": "/api/v2/external/jobs/job_a1b2c3"}Missing or invalid X-Auth-Token.
Media typeapplication/json
Error envelope returned by every failed request.
object
errors
required
Array<string>
Example
{ "errors": [ "Unauthorized" ]}The request failed validation.
Media typeapplication/json
Error envelope returned by every failed request.
object
errors
required
Array<string>
Example
{ "errors": [ "name is required" ]}Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.
Media typeapplication/json
Error envelope returned by every failed request.
object
errors
required
Array<string>
Example
{ "errors": [ "Rate limit exceeded" ]}Was this page helpful?
Thanks for letting us know.
Still stuck? Ask Quinn or chat with support