List Orders
GET {{baseUrl}}/orders?keyword=shipping_number&payment_method=<string>&payment_method=<string>&status=<string>&status=<string>&from_date=yyyy-mm-dd&to_date=yyyy-mm-dd&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>&sort_by=updated_at&accounting_services=zoho_books&unread=<boolean>&assign_employee=<string>&assign_employee=<string>&selling_channel=mahly-app&selling_channel=affiliate&created_by=<integer>
This endpoint allows you to list all orders related to your store directly. In addition, it enables you to filter the orders using a set of optional parameters.
orders.read - Orders Read Only
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
keyword | string | Listing the orders by keywords such as tag_name and shipping_number | |
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 | URL encoded city name in Arabic. | |
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 | Order Source | |
source | string | Order Source | |
sort_by | string | Sort the retrieved orders based on one attribute from the enum values. For example, if we need to sort the order by the id in ascending or descending order. we will concatenate either asc or desc with one of the enum values; in this case, we will use id-asc or id-desc. | |
accounting_services | string | To filter the orders that did not get sent to the accounting services. | |
unread | string | FInd the unread orders that merchant did not open yet. | |
assign_employee | string | Find the orders that are assigned to one or more employees. List of employees can be found here | |
assign_employee | string | Find the orders that are assigned to one or more employees. List of employees can be found here | |
selling_channel | string | The order-selling channel which can be one of the allowed enum values | |
selling_channel | string | The order-selling channel which can be one of the allowed enum values | |
created_by | string | Employee ID who created the order(s). List of employees can be found here |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","reference_id":"\u003cnumber\u003e","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"amounts":{"sub_total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"shipping_cost":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"tax":{"percent":"\u003cstring\u003e","amount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"discounts":[{"title":"\u003cstring\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e","discount":"\u003cstring\u003e","discounted_shipping":"\u003cinteger\u003e"},{"title":"\u003cstring\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e","discount":"\u003cstring\u003e","discounted_shipping":"\u003cinteger\u003e"}],"total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"exchange_rate":{"base_currency":"\u003cstring\u003e","exchange_currency":"\u003cstring\u003e","rate":"\u003cinteger\u003e"},"date":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"status":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","slug":"\u003cstring\u003e","customized":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}},"draft":"\u003cboolean\u003e","read":"\u003cboolean\u003e","can_cancel":"\u003cboolean\u003e","can_reorder":"\u003cboolean\u003e","payment_method":"\u003cstring\u003e","is_pending_payment":"\u003cboolean\u003e","pending_payment_ends_at":"\u003cstring\u003e","items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","thumbnail":"\u003cstring\u003e"}],"customer":{"id":"\u003cnumber\u003e","first_name":"r\rJDUxlk","last_name":"FKPdGf","mobile":"\u003cnumber\u003e","mobile_code":"\u003cstring\u003e","email":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"avatar":"\u003cstring\u003e","gender":"\u003cstring\u003e","brithday":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"city":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","currency":"\u003cstring\u003e","location":"\u003cstring\u003e","updated_at":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"groups":["\u003cinteger\u003e","\u003cinteger\u003e"]}},{"id":"\u003cnumber\u003e","reference_id":"\u003cnumber\u003e","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"amounts":{"sub_total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"shipping_cost":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"tax":{"percent":"\u003cstring\u003e","amount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"discounts":[{"title":"\u003cstring\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e","discount":"\u003cstring\u003e","discounted_shipping":"\u003cinteger\u003e"},{"title":"\u003cstring\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e","discount":"\u003cstring\u003e","discounted_shipping":"\u003cinteger\u003e"}],"total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"exchange_rate":{"base_currency":"\u003cstring\u003e","exchange_currency":"\u003cstring\u003e","rate":"\u003cinteger\u003e"},"date":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"status":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","slug":"\u003cstring\u003e","customized":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}},"draft":"\u003cboolean\u003e","read":"\u003cboolean\u003e","can_cancel":"\u003cboolean\u003e","can_reorder":"\u003cboolean\u003e","payment_method":"\u003cstring\u003e","is_pending_payment":"\u003cboolean\u003e","pending_payment_ends_at":"\u003cstring\u003e","items":[{"name":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","thumbnail":"\u003cstring\u003e"}],"customer":{"id":"\u003cnumber\u003e","first_name":"cyED-qVnmHSy IbnbyduEKoF","last_name":"uukPlS ByeWxEMIDfM AkZJld","mobile":"\u003cnumber\u003e","mobile_code":"\u003cstring\u003e","email":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"avatar":"\u003cstring\u003e","gender":"\u003cstring\u003e","brithday":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"city":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","currency":"\u003cstring\u003e","location":"\u003cstring\u003e","updated_at":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"groups":["\u003cinteger\u003e","\u003cinteger\u003e"]}}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}