See what came in and move an order along, the same steps as the buttons on the Orders page.
TOOL
WHAT IT DOES
list_orders
Orders newest first: reference, buyer, total, status and whether it's paid. Permission: orders:read
get_order
One order with items, totals, status and the next steps an app may take. Permission: orders:read
preview_order_action
Check a step (ready to ship, shipped or delivered) without doing it. Permission: orders:fulfil
apply_order_action
Take that step with the token. Permission: orders:fulfil
Good to know
The buyer is told
A step sends the buyer the same email the Orders page button would. The preview lists everything that will happen first: the status, any stock move or invoice, and the email.
Only forward steps
Apps can't cancel, refund or edit an order. Those stay in the dashboard.
Not for API keys
Order tools work only through an app a person connected, never with a script's key.
{
"name": "preview_order_action",
"arguments": {
"org_id": 121,
"order_id": 5821,
"step": "shipped"
}
}
→ "to": "shipped",
"effects": [
"The order's status changes …",
"The buyer is emailed that the
order is shipped"
],
"publish_token": "pub_…"