Qodex.ai

List Orders

GET {{baseUrl}}/orders?keyword=0500100121&payment_method=mad&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=1473353381&product=1745426678&branch=566146469&tags=shirts&tags=socks&tags=hats&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

KeyDatatypeRequiredDescription
keywordstringfind orders using id or customer mobile or customer name or shipping_number or tag.
payment_methodstringfind orders for specific payment method.
statusnumberfind orders for specific status (array of integers).
statusnumberfind orders for specific status (array of integers).
statusnumberfind orders for specific status (array of integers).
statusnumberfind orders for specific status (array of integers).
statusnumberfind orders for specific status (array of integers).
statusnumberfind orders for specific status (array of integers).
from_datestringfind orders created after a specific date.
to_datestringfind orders created before a specific date.
countrynumberinteger find orders for specific country. List of countries can be found here
citynumberfind orders for specific city. List of cities can be found here
productnumberfind orders for specific product. List of products can be found here
branchnumberfind orders for specific branch. List of branches can be found here
tagsstringfind orders for specific tags. List of tags can be found here here
tagsstringfind orders for specific tags. List of tags can be found here here
tagsstringfind orders for specific tags. List of tags can be found here here
expandedbooleanby default the api returned a short details for orders, sometimes you need to get full details of orders same as order details response in that case set value the value to true.
pagenumberThe Pagination page number
reference_idnumber613398835

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"status":200,"success":true,"data":[{"id":982102061,"reference_id":11042186,"total":{"amount":30,"currency":"SAR"},"date":{"date":"2021-02-13 22:03:27.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":525144736,"name":"ملغي"},"items":[{"name":"تفاح احمر","quantity":1}]},{"id":1812441987,"reference_id":10859560,"total":{"amount":90.2,"currency":"SAR"},"date":{"date":"2021-02-09 03:08:57.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1939592358,"name":"قيد التنفيذ"},"items":[{"name":"تفاح احمر","quantity":1},{"name":"رمان","quantity":1},{"name":"منتج غير محدود الكمية","quantity":1}]},{"id":219330153,"reference_id":10859470,"total":{"amount":81.4,"currency":"SAR"},"date":{"date":"2021-02-09 02:59:56.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1939592358,"name":"قيد التنفيذ"},"items":[{"name":"منتج غير محدود الكمية","quantity":1},{"name":"ليمون بلدي","quantity":1}]},{"id":155876799,"reference_id":10645020,"total":{"amount":16.5,"currency":"SAR"},"date":{"date":"2021-02-03 22:18:16.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":566146469,"name":"بإنتظار المراجعة"},"items":[{"name":"بطاطس","quantity":1}]},{"id":1671462687,"reference_id":10603708,"total":{"amount":16.5,"currency":"SAR"},"date":{"date":"2021-02-03 00:38:39.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":566146469,"name":"بإنتظار المراجعة"},"items":[{"name":"بطاطس","quantity":1}]},{"id":438357865,"reference_id":10529486,"total":{"amount":55,"currency":"SAR"},"date":{"date":"2021-02-01 16:53:45.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":566146469,"name":"بإنتظار المراجعة"},"items":[{"name":"باذنجان ابيض","quantity":1}]},{"id":1279586845,"reference_id":10292154,"total":{"amount":9,"currency":"SAR"},"date":{"date":"2021-02-01 16:56:28.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1298199463,"name":"تم التنفيذ"},"items":[{"name":"ليمون بلدي","quantity":1}]},{"id":27781399,"reference_id":10250932,"total":{"amount":170,"currency":"SAR"},"date":{"date":"2021-01-26 22:51:00.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":989286562,"name":"مسترجع"},"items":[{"name":"ثوم","quantity":1}]},{"id":1617148867,"reference_id":10052712,"total":{"amount":5.75,"currency":"SAR"},"date":{"date":"2021-01-20 13:21:31.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1298199463,"name":"تم التنفيذ"},"items":[{"name":"بطاطس","quantity":1}]},{"id":2044340651,"reference_id":9784848,"total":{"amount":38.64,"currency":"SAR"},"date":{"date":"2021-01-11 19:03:54.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":566146469,"name":"بإنتظار المراجعة"},"items":[{"name":"باذنجان ابيض","quantity":1}]},{"id":646035563,"reference_id":9764816,"total":{"amount":44.39,"currency":"SAR"},"date":{"date":"2021-01-11 00:36:42.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":814202285,"name":"تم الشحن"},"items":[{"name":"بصل ذهبي","quantity":1}]},{"id":1206379986,"reference_id":9632631,"total":{"amount":44.39,"currency":"SAR"},"date":{"date":"2021-01-06 05:41:17.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1723506348,"name":"تم التوصيل"},"items":[{"name":"بطاطس","quantity":2}]},{"id":1452780390,"reference_id":9075139,"total":{"amount":120.75,"currency":"SAR"},"date":{"date":"2020-12-23 00:18:00.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1298199463,"name":"تم التنفيذ"},"items":[{"name":"T-Shirt","quantity":1}]},{"id":1281603945,"reference_id":8896718,"total":{"amount":69,"currency":"SAR"},"date":{"date":"2020-12-16 02:58:18.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1298199463,"name":"تم التنفيذ"},"items":[{"name":"بصل ذهبي","quantity":1}]},{"id":965536532,"reference_id":8850353,"total":{"amount":529,"currency":"SAR"},"date":{"date":"2020-12-14 16:38:11.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"can_cancel":false,"status":{"id":1298199463,"name":"تم التنفيذ"},"items":[{"name":"موز","quantity":1},{"name":"بطاطس","quantity":1}]}],"pagination":{"count":15,"total":33,"perPage":15,"currentPage":1,"totalPages":3,"links":{"next":"https://api.salla.dev/admin/v2/orders?page=2"}}}