Skip to content

Get a bulk order job

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

GET/preorders/orders/jobs/{job_id}

Costs 1 rate-limit point · Rate limits

Check the status of a bulk-order job, with each order's result.

status is queued, running, completed or failed. succeeded / failed list each finished order by id and shopify_order_id; failed entries carry the reason. state adds stalled: nothing moved for stall_after_seconds (stalled_reason not_started or no_progress); created_at, started_at, last_progress_at and finished_at are UTC. Results are kept for 24 hours.

Also searched ascheck bulk order jobpoll bulk order jobget order job status

Path parameters

  • job_idstringRequired

    The job ID a bulk order call returned.

Returns

  • job_idstring

    Id of the background job doing the work.

  • operationstring

    The bulk action the job runs.

    One of releasesend_confirmationsend_shipping_updateopen_scheduled_fulfillmentsreschedule_fulfillmentreschedule_paymentcollect_paymenthold_fulfillmentssplit_fulfillment_orders
  • statusstring

    Where the job is: queued, running, completed, failed or cancelled; unknown if its progress can't be read.

    One of queuedrunningcompletedfailedcancelledunknown
  • totalinteger

    How many orders the job acts on.

  • processedinteger

    How many orders it has worked through so far.

  • succeeded_countinteger

    How many orders the action succeeded on.

  • failed_countinteger

    How many orders the action failed on.

  • succeededarray of objects

    The orders the action succeeded on.

    Show 3 child attributesHide child attributes
    • idstring

      STOQ's id for the order.

    • shopify_order_idstring

      The Shopify order gid (gid://shopify/Order/<id>).

    • namestring

      The Shopify order name, such as #1001.

  • failedarray of objects

    The orders the action failed on, each with the reason.

    Show 4 child attributesHide child attributes
    • idstring

      STOQ's id for the order.

    • shopify_order_idstring

      The Shopify order gid (gid://shopify/Order/<id>).

    • namestring

      The Shopify order name, such as #1001.

    • errorstring

      Why the action failed for this order.

  • statestring

    status, with stalled added: nothing has moved for stall_after_seconds.

    One of queuedrunningstalledfailedcompletedcancelled
  • stalled_reasonnull

    Why the job is stalled: not_started (no worker picked it up) or no_progress (it started, then stopped). Null unless state is stalled.

  • created_atstring

    When the job was submitted (ISO 8601, UTC).

  • started_atnull

    When a worker started the job (ISO 8601, UTC), or null before then.

  • last_progress_atnull

    When the job last moved (ISO 8601, UTC), or null before it started.

  • finished_atstring, nullable

    When the job finished (ISO 8601, UTC), or null while it runs.

  • stall_after_secondsinteger

    Seconds without progress after which state turns stalled.

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/orders/jobs/{job_id}
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/jobs/{job_id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "job_id": "string",
  "operation": "release",
  "status": "queued",
  "total": 1,
  "processed": 1,
  "succeeded_count": 1,
  "failed_count": 1,
  "succeeded": [
    {
      "id": "string",
      "shopify_order_id": "string",
      "name": "string"
    }
  ],
  "failed": [
    {
      "id": "string",
      "shopify_order_id": "string",
      "name": "string",
      "error": "string"
    }
  ],
  "state": "queued",
  "stalled_reason": null,
  "created_at": "2026-01-15T09:30:00Z",
  "started_at": null,
  "last_progress_at": null,
  "finished_at": "string",
  "stall_after_seconds": 1
}