List Orders
GET {{baseUrl}}/orders?keyword=ad ipsum incididunt in&status=11&status=2&status=17&status=47&status=95&status=8&from_date=30-12-2022&to_date=31-12-2022&country=1473353380&city=جدة&product=ad ipsum incididunt in&expanded=false&page=1&reference_id=613398835
You can list all orders related to your store directly from this endpoint. Also, it allows you to filter them using a different set of optional parameters.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
keyword | string | <br>- customer.mobile | |
status | number | Find orders for specific status (array of ID integers). List of statuses can be found here | |
status | number | Find orders for specific status (array of ID integers). List of statuses can be found here | |
status | number | Find orders for specific status (array of ID integers). List of statuses can be found here | |
status | number | Find orders for specific status (array of ID integers). List of statuses can be found here | |
status | number | Find orders for specific status (array of ID integers). List of statuses can be found here | |
status | number | Find orders for specific status (array of ID integers). List of statuses can be found here | |
from_date | string | Find orders created after a specific date. | |
to_date | string | Find orders created before a specific date. | |
country | number | Integer find orders for specific country. List of countries can be found here | |
city | string | Find orders for specific city. List of cities can be found here | |
product | string | Find orders for specific product via its name variable. List of products can be found here | |
expanded | boolean | Get full details of orders same as order details response by setting the value to true. | |
page | number | The Pagination page number | |
reference_id | number | This is the ID that appears to the store owner |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":200,"success":true,"data":[{"id":1017120475,"reference_id":40497536,"total":{"amount":55,"currency":"SAR"},"date":{"date":"2022-06-16 14:48:20.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"status":{"id":566146469,"name":"بإنتظار المراجعة","slug":"under_review","customized":{"id":986688842,"name":"بإنتظار المراجعة"}},"can_cancel":false,"can_reorder":true,"is_pending_payment":false,"pending_payment_ends_at":0,"items":[{"name":"تي شيرت بلاك","quantity":1}]},{"id":1013578136,"reference_id":40497469,"total":{"amount":0,"currency":"SAR"},"date":{"date":"2022-06-16 14:46:42.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"status":{"id":525144736,"name":"ملغي","slug":"canceled","customized":{"id":1718741844,"name":"ملغي"}},"can_cancel":false,"can_reorder":true,"is_pending_payment":true,"pending_payment_ends_at":0,"items":[{"name":"Custom Shirt","quantity":3}]}],"pagination":{"count":2,"total":2,"perPage":15,"currentPage":1,"totalPages":1,"links":{}}}