Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Orders
  • Welcome 👋
  • Get Started
  • Create Your First App
  • Authorization
  • Webhooks
  • Conditional Webhooks
  • Security Considerations
  • Multi-Language Support
  • Responses
  • Pagination
  • Rate Limiting
  • Versioning
  • Change Log
  • Support
  • APIs
    • Orders
      • Create Order
        POST
      • List Orders
        GET
      • Order Details
        GET
      • Create Drafted Order
        POST
      • Update Order
        PUT
      • Duplicate Order
        POST
      • Order Actions
        POST
    • Order Status
      • Update Order Status
      • Create Custom Order Status
      • List Order Statuses
      • Order Status Details
      • Update Custom Order Status
      • Update Bulk Orders Statuses
      • Sort Orders Statuses
    • Order Histories
      • List Order Histories
      • Create Order History
    • Order Tags
      • Create Order Tag
      • List Order Tags
      • Delete Order Tag
    • Order Invoice
      • Create Invoice
      • List Invoices
      • Invoice Details
      • Send Order Invoice
      • Create Order Invoice
    • Order Reservations
      • List Order Reservations
    • Order Items
      • List Order Items
      • Create Order Item
      • Update Order Item
      • Delete Order Item
    • Products
      • Create Product
      • List Products
      • Product Details
      • Update Product
      • Delete Product
      • Change Product Status
      • Product Details By SKU
      • Update Product By SKU
      • Delete Product By SKU
      • Update Product Price By SKU
      • Update Bulk Product Prices
      • Import Products
      • Bulk Product Actions
    • Product Options
      • Create Product Option
      • Product Option Details
      • Update Product Option
      • Delete Product Option
    • Product Quantity
      • List Product Quantities
      • Update Bulk Quantities
      • List Quantity Change Reasons
      • List Quantity Audit
      • Update Bulk Quantities by SKU
      • Update Quantity
      • Update Quantity By SKU
    • Product Variants
      • List Product Variants
      • Product Variant Details
      • Update Product Variant
      • Update Product Variant Quantity
    • Product Tags
      • Create Product Tag
      • List Product Tags
    • Product Images
      • Attach Image by SKU
      • Attach Video by SKU
      • Attach Youtube Video
      • Attach Image
      • Update Image
      • Delete Image
    • Product Option Values
      • Create Product Option Value
      • Product Option Value Details
      • Update Product Option Value
      • Delete Product Option Value
    • Abandoned Carts
      • List Abandoned Carts
      • Abandoned Cart Details
    • Customer Groups
      • Create Customer Group
      • List Customer Groups
      • Add Customers To Group Customer
      • Update Default Customer Group
      • Update Customer Group
      • Delete Customer Group
    • Customers
      • Create Customer
      • List Customers
      • Customer Details
      • Update Customer
      • Delete Customer
      • Ban Customer
      • Un-Ban customer
      • Import Customers
    • Digitals Product
      • Attach Digital Code
      • Attach Digital File
      • Delete Digital File
    • Categories
      • Create Category
      • List Categories
      • Category Details
      • Update Category
      • Delete Category
      • Category Children
      • Categories Search
      • List Category Products
    • Exports
      • Export Orders
      • Exports Logs
      • List Export Templates
      • Create Export Template
      • Update Export Template
      • Delete Export Template
      • List Export Columns
      • Export Customers
      • Export Custom URLs
      • Export Products
    • Shipments
      • Create Shipment
      • List Shipments
      • Shipment Details
      • Shipment Tracking
      • Update Shipment Details
      • Cancel Shipment
      • Return Shipment
    • Shipping Companies
      • List Shipping Companies
      • Shipping Company Details
      • List Estimate Rates
      • Create Shipping Company
      • Update Shipping Company
      • Delete Shipping Company
      • Shipping Company Options
    • Shipping Zones
      • Create Shipping Zone
      • List Shipping Zones
      • Shipping Zone Details
      • Update Shipping Zone
      • Delete Shipping Zone
    • Shipping Rules
      • List Shipping Rules
      • Shipping Rule Details
      • Delete Shipping Rule
    • Countries
      • List Countries
      • Country Details
    • Product Option Templates
      • List Option Templates
      • Option Template Details
      • Delete Option Template
      • Update Option Template
      • Create Option Template
    • Taxes
      • Create Tax
      • List Taxes
      • Tax Details
      • Update Tax
      • Delete Tax
    • Coupons
      • Create Coupon
      • List Coupons
      • Coupon Details
      • Update Coupon
      • Delete Coupon
      • List Coupon Codes
    • Affiliates
      • List Affiliates
      • Affiliate Details
      • Create Affiliate
      • Update Affiliate
      • Delete Affiliate
    • Order Assignment
      • List Auto Assignment Rules
      • Order Assigned Employees Details
      • Update Auto Assignment Rule
      • Create Auto Assignment Rules
    • Special Offers
      • Create Special Offer
      • List Special Offers
      • Special Offer Details
      • Update Special Offer
      • Delete Special Offer
      • Change Special Offer Status
    • Transactions
      • List Transactions
      • Transaction Details
      • Update Transaction
    • Payments
      • Available Payment Methods
      • List Banks
      • Payment Bank Details
    • Settlements
      • List Instant Settlements
      • Create Instant Settlement
      • Update Instant Settlement
      • Instant Settlement Details
    • Settings
      • Settings List
      • Update Setting Slug
      • Setting Details
    • Merchant
      • User Information Details
      • Store Information
    • Brands
      • Create Brand
      • List Brands
      • Brand Details
      • Update Brand
      • Delete Brand
    • Branches
      • Create Branch
      • List Branches
      • Branch Details
      • Update Branch
      • Delete Branch
    • Currencies
      • Activate Currencies
      • List Currencies
      • List Available Currencies
    • SEO
      • List SEO Settings
      • Update SEO Settings
    • Cities
      • List Cities
    • DNS Records
      • List DNS Records
      • Create DNS Record
      • Delete DNS Record
    • Languages
      • Add Language
      • List Languages
      • Update Language
    • Employees
      • List Employees
    • Advertisements
      • Create Advertisement
      • List Advertisements
      • Advertisement Details
      • Update Advertisement
      • Delete Advertisement
    • Webhooks
      • List Active Webhooks
      • List Events
      • Register Webhook
      • Deactivate Webhook
      • Update Webhook
    • Custom URLs
      • Import Custom URLs
    • Loyalty Points
      • Customer Loyalty Points
      • Update Customer Loyalty Points
    • Reviews
      • List Reviews
      • Review Details
      • Update Review
  • Webhooks - Store Events
    • Order
    • Product
    • Customer
    • Shippings
    • Shipments
    • Brand
    • Invoice
    • Category
    • Store
    • Special Offer
    • Cart
    • Miscellaneous
  1. Orders

List Orders

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
GET
https://api.salla.dev/admin/v2
/orders
Orders
Last modified:2025-03-24 08:57:10
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

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
tags
array[string]
optional
Find orders for specific tags (array of ID integers). List of tags can be found here
expanded
boolean 
deprecated
Get full details of orders same as order details response by setting the value to true.
page
integer 
optional
The Pagination page number
reference_id
integer 
optional
Unique identification refrence number that appears to the store owner
coupon
string 
optional
Discount code, extracted from discount.code
customer_id
number 
optional
Customer unique identification number.
shipping_app_id
array[string]
optional
Number array of Shipping Application unique identification number.
source
array[string]
optional
Order source.
sort_by
enum<string> 
optional
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.
Allowed values:
idtotalupdated_atcreated_at
accounting_services
enum<string> 
optional
To filter the orders that did not get sent to the accounting services.
Allowed values:
qoyoddaftrazoho_books
unread
boolean 
optional
Find the unread orders that merchant did not open yet.
assign_employee
array[string]
optional
Find the orders that are assigned to one or more employees. List of employees can be found here
selling_channel
array[string]
optional
The order-selling channel which can be one of the allowed enum values
Allowed values:
mobilemobile-appdesktopaffiliatemahly-app
created_by
integer 
optional
Employee unique identification number who created the order(s). List of employees can be found here

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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'

Responses

🟢200Success
application/json
Body
status
number 
optional
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.
success
boolean 
optional
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.
data
array[object (ListOrders) {15}] 
optional
Detailed structure of the List Order model object showing its fields and data types.
id
number 
required
A unique alphanumeric code or identifier assigned to a specific order.
reference_id
number 
required
A specific alphanumeric code or identifier associated with an order.
total
object 
required
The amount representing the total expense incurred for all the items in the order.
date
object (Date) 
required
Date of the order.
status
object (NewOrderStatus) 
required
Status of the order.
draft
boolean 
required
Whether or not the order is a draft or no.
read
boolean 
required
Whether or not the order is read by the merchant or not
can_cancel
boolean 
required
Whether or not the order is allowed to be cancelled by store customers.
True value should be set if the order status is in under review and in progress, as according to the store settings.
can_reorder
boolean 
required
Whether or not the order allowed to be re-order by customers.
payment_method
string 
required
The order's payment method
is_pending_payment
boolean 
required
Whether or not the order is waiting to be paid or the order status is payment_pending.
pending_payment_ends_at
string 
required
The time untill the payment has to be made by the cusotmer
features
object 
required
Order features details.
items
array [object {3}] 
required
Order items (products)
customer
object (Customer) 
required
Customer details.
pagination
object (Pagination) 
optional
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.
count
number 
required
Number of returned results.
total
number 
required
Number of all results.
perPage
number 
required
Number of results per page.
<= 65
currentPage
number 
required
Number of current page.
totalPages
number 
required
Number of total pages.
links
object 
required
Array of linkes to next and previous pages.
Example
{
  "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": {}
  }
}
🟠401Unauthorized
Modified at 2025-03-24 08:57:10
Previous
Create Order
Next
Order Details