curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/purgatory/orders/{id}' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"external_order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_posted": true,
"items": [
{
"external_sku": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ignore_item": true,
"non_physical": true,
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": "2",
"resolved": true
}
],
"ready_to_post": true,
"unresolved_count": 1
}
Get a purgatory
Get a purgatory
GET
/
api
/
v1
/
purgatory
/
orders
/
{id}
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/purgatory/orders/{id}' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"external_order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_posted": true,
"items": [
{
"external_sku": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ignore_item": true,
"non_physical": true,
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": "2",
"resolved": true
}
],
"ready_to_post": true,
"unresolved_count": 1
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string
required
Purgatory order ID
Response
PurgatoryOrderResponse
string
required
string,null
string
required
boolean
required
PurgatoryLineResponse[]
required
boolean
required
integer
required
Minimum:
0.Status codes
| Code | Meaning |
|---|---|
200 | — |
404 | — |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/purgatory/orders/{id}' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"external_order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_posted": true,
"items": [
{
"external_sku": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ignore_item": true,
"non_physical": true,
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": "2",
"resolved": true
}
],
"ready_to_post": true,
"unresolved_count": 1
}
Last modified on September 21, 2026