Read the status of an async operation

Scope: channel:read, channel:write, orders:write, customers:write, products:write, shipments:write, invoices:write, payments:write, fulfillment:write, purchase-orders:write or admin. A permission group made before the Channel API scopes existed grants it as orders:manage or invoices:manage or payments:manage or fulfillment-orders:manage.

Idempotency: not keyed; the request itself is safe to repeat.

Rate limit: read class, 6,000 requests per minute per tenant by default (write class 1,200). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 300

The uuid, a legacy 24-hex id, or ext:: (URL-encoded).

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json