Get a bulk order job
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/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_idstringRequiredThe job ID a bulk order call returned.
Returns
job_idstringId of the background job doing the work.
operationstringThe bulk action the job runs.
One ofreleasesend_confirmationsend_shipping_updateopen_scheduled_fulfillmentsreschedule_fulfillmentreschedule_paymentcollect_paymenthold_fulfillmentssplit_fulfillment_ordersstatusstringWhere the job is: queued, running, completed, failed or cancelled; unknown if its progress can't be read.
One ofqueuedrunningcompletedfailedcancelledunknowntotalintegerHow many orders the job acts on.
processedintegerHow many orders it has worked through so far.
succeeded_countintegerHow many orders the action succeeded on.
failed_countintegerHow many orders the action failed on.
succeededarray of objectsThe orders the action succeeded on.
Show 3 child attributesHide child attributes
idstringSTOQ's id for the order.
shopify_order_idstringThe Shopify order gid (gid://shopify/Order/<id>).
namestringThe Shopify order name, such as #1001.
failedarray of objectsThe orders the action failed on, each with the reason.
Show 4 child attributesHide child attributes
idstringSTOQ's id for the order.
shopify_order_idstringThe Shopify order gid (gid://shopify/Order/<id>).
namestringThe Shopify order name, such as #1001.
errorstringWhy the action failed for this order.
statestringstatus, with stalled added: nothing has moved for stall_after_seconds.
One ofqueuedrunningstalledfailedcompletedcancelledstalled_reasonnullWhy the job is stalled: not_started (no worker picked it up) or no_progress (it started, then stopped). Null unless state is stalled.
created_atstringWhen the job was submitted (ISO 8601, UTC).
started_atnullWhen a worker started the job (ISO 8601, UTC), or null before then.
last_progress_atnullWhen the job last moved (ISO 8601, UTC), or null before it started.
finished_atstring, nullableWhen the job finished (ISO 8601, UTC), or null while it runs.
stall_after_secondsintegerSeconds without progress after which state turns stalled.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/jobs/{job_id}" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/orders/jobs/{job_id}", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/orders/jobs/{job_id}",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/orders/jobs/{job_id}")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}