List Orders

This endpoint allows you to list all orders related to your store.

Tip

Also, the endpoint enables you to filter the orders using a set of optional parameters.

Deprecation Notice

All Apps created after 15th of August, 2024 will not be able to use the expanded query parameter.

Scopes

orders.read - Orders Read Only

curl --location --request GET 'https://api.salla.dev/admin/v2/orders?keyword=&payment_method=&status=&from_date=&to_date=&country=&city=&product=&branch=&tags=&expanded=&page=&reference_id=&coupon=&customer_id=&shipping_app_id=&source=&sort_by=&accounting_services=&unread=&assign_employee=&selling_channel=&created_by'

{ "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": {} } }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

keyword

enum<string>

optional

Listing the orders by keywords such as tag_name and shipping_number

Allowed values:

customer.mobilecustomer.nameshipping_numberreference_idtag_name

payment_method

array[string]

optional

Find orders for specific payment method. List of available payment methods can be found here

status

array[string]

optional

Find orders for specific status (array of ID integers). List of statuses can be found here

from_date

string <date>

optional

Find orders created after a specific date.

Example:

2024-01-01

Match pattern:

yyyy-mm-dd

to_date

string <date>

optional

Find orders created before a specific date.

Example:

2024-01-02

Match pattern:

yyyy-mm-dd

country

integer

optional

Find orders for specific country. List of countries can be found here

city

string

optional

Find orders for specific city. List of cities can be found here

Example:

jeddah

product

string

optional

Find orders for specific product via its name variable. List of products can be found here

branch

array[string]

optional

Find orders for specific branch (array of integers). List of branches can be found here

Request

Responses