List Orders
GET {{baseUrl}}/orders?keyword=<string>&payment_method=<string>&payment_method=<string>&status=<string>&status=<string>&from_date=<string>&to_date=<string>&country=<integer>&city=<string>&product=<string>&branch=<string>&branch=<string>&tags=<string>&tags=<string>&expanded=<boolean>&page=<integer>&reference_id=<integer>&coupon=<string>&customer_id=<number>&shipping_app_id=<string>&shipping_app_id=<string>&source=<string>&source=<string>
This endpoint allows you to 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 | |
payment_method | string | Find orders for specific payment method. List of available payment methods can be found here | |
payment_method | string | Find orders for specific payment method. List of available payment methods can be found here | |
status | string | Find orders for specific status (array of ID integers). List of statuses can be found here | |
status | string | 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 | string | 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 | |
branch | string | Find orders for specific branch (array of integers). List of branches can be found here | |
branch | string | Find orders for specific branch (array of integers). List of branches can be found here | |
tags | string | Find orders for specific tags (array of ID integers). List of tags can be found here here | |
tags | string | Find orders for specific tags (array of ID integers). List of tags can be found here here | |
expanded | string | Get full details of orders same as order details response by setting the value to true. | |
page | string | The Pagination page number | |
reference_id | string | This is the ID that appears to the store owner | |
coupon | string | Discount code, extracted from discount.code | |
customer_id | string | Customer ID | |
shipping_app_id | string | Number array of Shipping Application IDs | |
shipping_app_id | string | Number array of Shipping Application IDs | |
source | string | The source of the order | |
source | string | The source of the order |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"\u003cinteger\u003e","success":"\u003cstring\u003e","data":[{"id":"\u003cnumber\u003e","reference_id":"\u003cnumber\u003e","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"date":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"can_cancel":"\u003cboolean\u003e","can_reorder":"\u003cboolean\u003e","is_pending_payment":"\u003cboolean\u003e","status":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","type":"custom","slug":"\u003cstring\u003e","parent":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"},"original":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"}},"items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e"}]},{"id":"\u003cnumber\u003e","reference_id":"\u003cnumber\u003e","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"date":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"can_cancel":"\u003cboolean\u003e","can_reorder":"\u003cboolean\u003e","is_pending_payment":"\u003cboolean\u003e","status":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","type":"custom","slug":"\u003cstring\u003e","parent":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"},"original":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"}},"items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e"}]}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}