curl --request POST \
--url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/plan/queue' \
--header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"tenantId": "acme-outdoors",
"salesChannel": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"fulfillmentSystem": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"erpSystem": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"controlPlane": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"includeInventory": true
}'
{
"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobType": "string",
"status": "queued",
"createdAt": "2026-08-31T14:22:05Z"
}
Queue a typed commerce sync plan for background execution.
Plan execution queued as a background job
POST
/
v1
/
tenants
/
{tenant_id}
/
sync
/
plan
/
queue
curl --request POST \
--url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/plan/queue' \
--header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"tenantId": "acme-outdoors",
"salesChannel": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"fulfillmentSystem": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"erpSystem": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"controlPlane": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"includeInventory": true
}'
{
"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobType": "string",
"status": "queued",
"createdAt": "2026-08-31T14:22:05Z"
}
Path parameters
string
required
Tenant identifier
Request body
object
string
required
object
required
object
required
object
object
boolean
Default false
Response
object
string (uuid)
required
Unique job identifier
string
required
Type of background job
string
required
Current job status
string (date-time)
required
Job creation timestamp
Status codes
| Code | Meaning |
|---|---|
202 | Plan execution queued as a background job |
401 | Unauthorized |
422 | Validation error |
curl --request POST \
--url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/plan/queue' \
--header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"tenantId": "acme-outdoors",
"salesChannel": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"fulfillmentSystem": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"erpSystem": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"controlPlane": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"label": "Replacement tent pole set",
"systemKind": "sales_channel",
"capabilities": [
"pull_orders"
]
},
"includeInventory": true
}'
{
"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobType": "string",
"status": "queued",
"createdAt": "2026-08-31T14:22:05Z"
}
Last modified on August 31, 2026