Salla Docs
List Orders
GET/ordersThis endpoint allows you to list all orders related to your store.
::: tip[Tip]
Also, the endpoint enables you to filter the orders using a set of optional parameters.
:::
:::danger[Deprecation Notice]
All Apps created after 15th of August, 2024 will not be able to use the expanded query parameter.
:::
Request
Listing the orders by keywords such as tag_name and shipping_number
Find orders for specific payment method. List of available payment methods can be found here
Find orders for specific status (array of ID integers). List of statuses can be found here
Find orders created after a specific date.
Find orders created before a specific date.
Find orders for specific country. List of countries can be found here
Find orders for specific product via its name variable. List of products can be found here
Find orders for specific branch (array of integers). List of branches can be found here
Find orders for specific tags (array of ID integers). List of tags can be found here
Get full details of orders same as order details response by setting the value to true.
The Pagination page number
Unique identification refrence number that appears to the store owner
Discount code, extracted from discount.code
Customer unique identification number.
Number array of Shipping Application unique identification number.
Order source.
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.
To filter the orders that did not get sent to the accounting services.
Find the unread orders that merchant did not open yet.
Find the orders that are assigned to one or more employees. List of employees can be found here
The order-selling channel which can be one of the allowed enum values
Employee unique identification number who created the order(s). List of employees can be found here
Request samples
Responses
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
Detailed structure of the List Order model object showing its fields and data types.
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
{
"status": 200,
"success": true,
"data": [
{
"id": 1017120475,
"reference_id": 40497536,
"total": {
"amount": 55,
"currency": "SAR"
},
"exchange_rate": {
"base_currency": "SAR",
"exchange_currency": "USD",
"rate": 0.266592
},
"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,
"payment_method": "bank",
"is_pending_payment": false,
"pending_payment_ends_at": 0,
"features": {
"digitalable": true,
"shippable": true
},
"items": [
{
"name": "تي شيرت بلاك",
"quantity": 1,
"thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/c151972a-c2d1-4a4d-b374-b46fd0bca79e-500x333.33333333333-WfHaI7WVXTosOlksBhesYbWlxhMFf9fJVDK6JlJj.jpg"
}
]
},
{
"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": {}
}
}