Skip to content

Get allowed status transitions

GET
/stores/{storeRef}/orders/{id}/allowed-transitions
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/orders/1/allowed-transitions \
--header 'x-api-key: <x-api-key>'

Returns the order’s current statuses and, for each of order, fulfillment, shipping and payment status, the statuses an update would accept right now. The lists apply the same state machine and guards as the update route, so a status that is not listed is refused. When no order has this ID in the store the response is 200 with an empty body.

Required scopes: read:orders

id
required
integer

The order ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

The current statuses and the allowed next statuses. The body is empty when no order has this ID in the store.

Media typeapplication/json
object
current
required

The order’s current statuses.

object
order_status
required

Lifecycle status.

string
Allowed values: pending confirmed processing cancelled on_hold completed
fulfillment_status
required

Fulfillment status.

string
Allowed values: unfulfilled fulfilled returned return_requested
shipping_status
required

Shipping status.

string
Allowed values: not_shipped shipped in_transit out_for_delivery delivered delivery_failed
payment_status
required

Payment status.

string
Allowed values: pending authorized paid captured failed refunded voided
allowed_transitions
required

For each status dimension, the statuses the order may move to now.

object
order_status
required

Lifecycle statuses the order may move to.

Array<string>
Allowed values: pending confirmed processing cancelled on_hold completed
fulfillment_status
required

Fulfillment statuses the order may move to.

Array<string>
Allowed values: unfulfilled fulfilled returned return_requested
shipping_status
required

Shipping statuses the order may move to.

Array<string>
Allowed values: not_shipped shipped in_transit out_for_delivery delivered delivery_failed
payment_status
required

Payment statuses the order may move to.

Array<string>
Allowed values: pending authorized paid captured failed refunded voided

Example

{
"current": {
"order_status": "pending",
"fulfillment_status": "unfulfilled",
"shipping_status": "not_shipped",
"payment_status": "pending"
},
"allowed_transitions": {
"order_status": [
"pending"
],
"fulfillment_status": [
"unfulfilled"
],
"shipping_status": [
"not_shipped"
],
"payment_status": [
"pending"
]
}
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}