Skip to content

Get a bulk variant job

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

GET/preorders/product_variants/jobs/{job_id}

Costs 1 rate-limit point · Rate limits

Check the status of a bulk variant-admin job.

state is queued (waiting for a worker), running, stalled (nothing moved for stall_after_seconds; stalled_reason not_started or no_progress), completed, failed or cancelled. status is kept as before and reads running while the job is queued. Timestamps are UTC. Jobs are kept for 24 hours. A bulk variant job completes even when some variants fail: succeeded_count, failed_count and failed (each failed variant's shopify_variant_id and error) say which.

Also searched ascheck bulk variant job statuspoll bulk variant jobget variant job status

Path parameters

  • job_idstringRequired

    The job ID a bulk variant call returned.

Returns

The product variant object.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The 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.

GET/preorders/product_variants/jobs/{job_id}
curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/jobs/{job_id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "job_id": "bulk_sync_metafields_5e8b2d0c9a4f7136",
  "status": "completed",
  "progress": 100,
  "total": 3,
  "processed": 3,
  "state": "completed",
  "stalled_reason": null,
  "created_at": "2026-06-25T14:02:11Z",
  "started_at": "2026-06-25T14:02:12Z",
  "last_progress_at": null,
  "finished_at": "2026-06-25T14:02:15Z",
  "stall_after_seconds": 900
}