Skip to main content
POST
/
v1
/
orders
/
{id}
/
transition
Transition order status
curl --request POST \
  --url http://localhost:3000/v1/orders/{id}/transition \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_status": "received",
  "portal_id": "<string>"
}
'
{
  "success": true,
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "target_status": "<string>"
}

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
target_status
enum<string>
required

Target RFC status to transition the order to

Available options:
received,
staged,
arrived,
completed,
cancelled
​
portal_id
string

Pickup portal ID, required when target_status is "arrived"

Response

Order transitioned successfully

​
success
boolean
required
​
order_id
string<uuid>
required
​
message
string
required
​
target_status
string
required