Skip to main content
POST
Await Commerce Jobs

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
correlations
object[]
required

Every returned commerce job correlation, including orders and returns. Maximum 50000; trimmed and deduplicated in first-requested order.

Maximum array length: 50000
timeoutMs
integer

Wait budget in milliseconds; 0 is one status read. Maximum 120000.

Required range: 0 <= x <= 120000
organizationId
string
Required string length: 1 - 120

Response

Request completed. Inspect data.success, per-target results and pendingCount for processing progress.

ok
boolean
required
apiVersion
string
required
operationId
string<uuid>
required
status
enum<string>
required
Available options:
completed
data
object
required
warnings
string[]
required
recommendations
string[]
required