Appearance
Order Histories
Order histories track all status changes for your orders over time.
List Order Histories
GET/order-histories Bearer Token — view orders
Retrieve a paginated list of order status change history.
| Parameter | Type | Required | Description |
|---|---|---|---|
per_page | number | No | Results per page |
Response
Success (200):
json
{
"data": [
{
"order_reference": "ORD-00001",
"old_status": "NEW",
"new_status": "SHIPPED",
"changed_by": "Admin Name",
"changed_at": "2025-01-16T09:00:00Z"
},
{
"order_reference": "ORD-00002",
"old_status": "SHIPPED",
"new_status": "DELIVERED",
"changed_by": "System",
"changed_at": "2025-01-17T14:30:00Z"
}
],
"meta": {
"pagination": {
"page": 1,
"limit": 50,
"total": 180,
"pages": 4
}
}
}Show Order History
GET/order-histories/{id}/show Bearer Token — view orders
Retrieve a single order history entry by ID.
Response
Success (200):
json
{
"data": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"order_reference": "ORD-00001",
"old_status": "NEW",
"new_status": "SHIPPED",
"changed_by": "Admin Name",
"changed_at": "2025-01-16T09:00:00Z"
},
"meta": {}
}Not found (404):
json
{
"error": {
"code": "HTTP_ERROR",
"message": "Resource not found."
}
}