Skip to content

Bulk sync metafields

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

POST/preorders/product_variants/bulk_sync_metafields

Costs 2 rate-limit points · Rate limits

Force-resync preorder metafields for many variants in one job (max 5000).

Runs POST /preorders/product_variants/:shopify_variant_id/sync_metafields for each variant in the background. Use it when the storefront shows other shipping text, limits or counts than GET /preorders/products for many variants, for example after Shopify refused a write or the metafields were edited in Shopify. Nothing is recounted or reset, and it's safe to repeat. shopify_variant_ids takes gids or numeric ids, at most 5000 (422 validation_failed otherwise). Returns 202 with job_id and status_url; poll GET /preorders/product_variants/jobs/:job_id.

Also searched asforce resync many variantsbulk refresh metafieldspush many variants to shopify

Headers

  • Idempotency-Keystring

    A 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 (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_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 strings

    Variants to process in one background job, up to 5000, as numeric IDs or gid://shopify/ProductVariant/<id>.

Returns

  • job_idstring

    Id of the background job doing the work.

  • status_urlstring

    Path of the endpoint that reports this job's progress; poll it until the job finishes. Results are kept for 24 hours.

  • variant_countinteger
    Example: 3

Errors

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The action refused the request for a reason that is not a single bad field.

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.

POST/preorders/product_variants/bulk_sync_metafields
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/product_variants/bulk_sync_metafields" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shopify_variant_ids": [
      "gid://shopify/ProductVariant/47284734423096",
      "gid://shopify/ProductVariant/47284734455864",
      "gid://shopify/ProductVariant/47284734488632"
    ]
  }'
Response
{
  "job_id": "bulk_sync_metafields_5e8b2d0c9a4f7136",
  "status_url": "/api/v2/external/preorders/product_variants/jobs/bulk_sync_metafields_5e8b2d0c9a4f7136",
  "variant_count": 3
}