Order List
Retrieve a paginated list of Procurement orders for your company.
GET
/api/v1/shop/orders?page=1&limit=10Description
Returns Procurement orders with optional status and date filters.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number (1-based). Default is 1. |
| limit | number | No | Records per page. Default is 10. Max 100 on tickets, wallet, and shipping labels. |
| status | string | No | Filter by order status (e.g. IN TRANSIT, COMPLETED). Case-insensitive match against order_status. |
| start_date | string | No | On or after this date (YYYY-MM-DD; shipping labels also accept MM/DD/YYYY). |
| end_date | string | No | On or before this date (YYYY-MM-DD; shipping labels also accept MM/DD/YYYY). |
Response
| Field | Type | Description |
|---|---|---|
| total_orders | number | Total matching orders. |
| total_pages | number | Total pages. |
| current_page | number | Current page. |
| orders[] | array | Order objects with shipping, billing, items, documents, and tracking where applicable. |
| orders[].order_number | string | Unique order number. |
| orders[].order_status | string | Human-readable status (field name varies by order type on list). |
| orders[].items[] | array | Line items (fields vary by order type; Procurement list omits items). |
| orders[].tracking | array | Shipment tracking entries when available. |
Notes
- Default page size is 10.
- status filter is matched case-insensitively against order_status.
- Procurement list responses omit line items; fetch order detail for items[].
- order_status on list uses internal status timestamps; detail returns numeric order_status.
Related Endpoints
Did this page help you?
Request
curl -X GET https://uat.unduit.com/api-exposed/api/v1/shop/orders?page=1&limit=10 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"total_orders": 1,
"total_pages": 1,
"current_page": 1,
"orders": [
{
"order_number": "174894576543",
"company_name": "Acme Corporation",
"shipping_name": "Acme Corp IT",
"shipping_phone": "5551234567",
"shipping_country": "US",
"shipping_state": "CA",
"shipping_city": "San Jose",
"shipping_zip": "95110",
"shipping_address": "500 Logistics Way",
"billing_name": "Acme Corporation",
"billing_phone": "5551234567",
"billing_apt": "",
"billing_address": "100 Corporate Blvd",
"billing_city": "San Jose",
"billing_state": "CA",
"billing_zip": "95110",
"billing_country": "US",
"email": "jane.smith@acme.com",
"phone": "5551234567",
"currency_code": "USD",
"order_amount": "199.00",
"total_amount": "214.92",
"tax_amount": "15.92",
"order_status_date": "Jun 3rd, 2026",
"created_at": "Jun 3rd, 2026",
"tracking": [
{
"carrier_name": "ups",
"forward_shipping": {
"tracking_number": null,
"tracking_link": null
},
"return_shipping": {
"return_tracking_number": "1Z999AA10123456784",
"return_tracking_link": "https://wwwapps.ups.com/WebTracking/processRequest?HTMLVersion=5.0&Requester=NES&loc=en_US&tracknum=1Z999AA10123456784"
}
}
]
}
]
}