Endpoints:
Set Order Status
POST /order-status sets the new status to the specific orders
Required fields:
order_ids, status_id, are required when setting a custom status to an order.
This endpoint will return200 OK with the current JSON representation of the Order if the creation was a success.
Example JSON Request
{
"order_ids": [2234234, 53434534534, 34534534, 674567456],
"status_id": 1234,
"private_note": null,
"public_note": null,
"due_date": null,
"email_customers": true,
"email_additional_emails": true,
"append_notes": false,
}
Get Order Status
GET /order-status/123 gets the current order status for the order with the id of 123
Example JSON Response
{
"current_status_id": 98765,
"current_status_name": "Pending",
"current_status_name_public": "Your order is pending",
"due_date": 2024-01-01,
"last_updated": 2023-01-01,
"updated_by": "Susan Smith",
"order_id": 123,
"private_note": null,
"public_note": null,
"workflow_id": 29,
"workflow_name": "Internal workflow",
"workflow_steps":[
{
"display_order": 0,
"status_id": 40267,
"status_name": "Received",
"status_name_public": "received",
"step_status": "complete"
},
{
"display_order": 1,
"status_id": 353667,
"status_name": "in-production",
"status_name_public": "In Production",
"step_status": "current"
},
{
"display_order": 2,
"status_id": 456456,
"status_name": "shipping",
"status_name_public": "Shipped",
"step_status": "upcoming"
}
]
}