- 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
- Order Status
- Order Histories
- Order Tags
- Order Invoice
- Order Reservations
- Order Items
- Products
- Product Options
- Product Quantity
- Product Variants
- Product Tags
- Product Images
- Product Option Values
- Abandoned Carts
- Customer Groups
- Customers
- Digitals Product
- Categories
- Exports
- Shipments
- Shipping Companies
- Shipping Zones
- Shipping Rules
- Countries
- Product Option Templates
- Taxes
- Coupons
- Affiliates
- Order Assignment
- Special Offers
- Transactions
- Payments
- Settlements
- Settings
- Merchant
- Brands
- Branches
- Currencies
- SEO
- Cities
- DNS Records
- Languages
- Employees
- Advertisements
- Webhooks
- Custom URLs
- Loyalty Points
- Reviews
- Webhooks - Store Events
List Products
Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
GET
https://api.salla.dev/admin/v2
Products
Last modified:2025-02-04 11:02:03
Simplifed, Minimal Response
format=light
Note
Scopes
products.read
- Products Read OnlyRequest
Authorization
Add the parameter
Authorization
to Headers,whose value is to concatenate the Token after the Bearer.Example:
Authorization: Bearer ********************
Query Params
page
integer
optional
keyword
string
optional
status
string
optional
hidden
,sale
,out
category
string
optional
per_page
integer
optional
format
enum<string>
optional
light
valueAllowed value:
light
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/products?page&keyword&status&category&per_page&format'
Responses
🟢200Success | Full Example
application/json
Body
status
number
optional
success
boolean
optional
data
array[object (ProductDetails) {55}]
optional
id
number
required
promotion
object
required
sku
string
required
mpn
string | null
required
Example:
45343
gtin
string | null
required
Example:
14643439
type
enum<string>
required
Allowed values:
productservicegroup_productscodesdigitalfooddonatingbooking
name
string
required
short_link_code
string
required
urls
object (Urls)
required
price
object
required
taxed_price
object
required
pre_tax_price
object
required
tax
object
required
description
string
required
quantity
integer
required
unlimited_quantity
boolean
required
status
enum<string>
required
Allowed values:
saleouthiddendeleted
is_available
boolean
required
views
integer
required
sale_price
object
required
sale_end
string
required
require_shipping
boolean
required
cost_price
number
required
weight
number
required
weight_type
enum<string>
required
Allowed values:
kgglboz
with_tax
boolean
required
url
string
required
images
array [object {9}]
required
sold_quantity
integer
required
rating
object
required
regular_price
object
required
max_items_per_user
number
required
maximum_quantity_per_order
number | null
required
show_in_app
boolean
required
notify_quantity
string | null
required
hide_quantity
boolean
required
channels
array[string]
required
Allowed values:
appweb
managed_by_branches
boolean
required
service_blocks
object
required
calories
string | null
required
Example:
500.00
starting_price
object
required
Example:
500.00
allow_attachments
boolean
required
is_pinned
boolean
required
pinned_date
string
required
sort
number
required
active_advance
boolean
required
enable_upload_image
boolean
required
updated_at
string
required
options
array[object (MiniProductOption) {13}]
required
skus
array[object (ProductVariant) {21}]
required
metadata
object
required
booking_details
object
required
categories
array[object (Category) {14}]
required
brand
object (Brand)
required
tags
array [object {2}]
required
pagination
object (Pagination)
optional
count
number
required
total
number
required
perPage
number
required
<= 65
currentPage
number
required
totalPages
number
required
links
object
required
Examples
{ "status": 200, "success": true, "data": [ { "id": 1672932878, "promotion": { "title": "ramadan promtotion", "sub_title": "special ramadan offers" }, "sku": "", "thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca2j2PAGrqqeDROY.jpg", "mpn": "58636897", "gtin": "45344432343", "type": "product", "name": "T-Shirt", "short_link_code": "qQvmmRb", "urls": { "customer": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672932878", "admin": "https://s.salla.sa/products/1672932878" }, "price": { "amount": 100, "currency": "SAR" }, "taxed_price": { "amount": 100, "currency": "SAR" }, "pre_tax_price": { "amount": 100, "currency": "SAR" }, "tax": { "amount": 0, "currency": "SAR" }, "description": "", "quantity": "50", "status": "sale", "is_available": true, "views": 0, "sale_price": { "amount": 0, "currency": "SAR" }, "sale_end": {}, "require_shipping": true, "cost_price": "35", "weight": 1, "weight_type": "kg", "with_tax": true, "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672932878", "main_image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG0rwqcTY2CC2j2PAGrqqeDROY.jpg", "images": [ { "id": 1699133464, "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2G3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg", "main": false, "three_d_image_url": "", "alt": "image", "video_url": "", "type": "image", "sort": 5 } ], "sold_quantity": 0, "rating": { "total": 0, "count": 0, "rate": 0 }, "regular_price": { "amount": 100, "currency": "SAR" }, "max_items_per_user": 0, "maximum_quantity_per_order": 10, "show_in_app": true, "notify_quantity": "10", "hide_quantity": false, "unlimited_quantity": true, "managed_by_branches": false, "services_blocks": { "installments": [] }, "calories": "350", "customized_sku_quantity": false, "channels": [ "web", "app" ], "metadata": { "title": "Chocolate bar", "description": "Chocolate bar made with natural ingredients", "url": "https://link" }, "allow_attachments": false, "is_pinned": false, "pinned_date": "2024-03-06 13:50:32", "sort": 0, "enable_upload_image": false, "updated_at": "2024-03-06 13:50:32", "options": [ { "id": 782399854, "name": "Color", "description": "This item is one of the best seller", "type": "radio", "required": false, "associated_with_order_time": 0, "availability_range": false, "not_same_day_order": false, "choose_date_time": false, "from_date_time": "2022-06-23 01:04:38", "to_date_time": "2025-06-23 01:04:38", "sort": 5, "advance": true, "display_type": "text", "visibility": "always", "translations": { "ar": { "option_name": "Color", "description": "This item is one of the best seller" } }, "values": [ { "id": 422377234, "name": "Blue", "price": { "amount": 0, "currency": "SAR" }, "formatted_price": "", "display_value": "", "advance": true, "option_id": 782399854, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "Blue" } }, "is_default": false, "is_out_of_stock": false }, { "id": 1783843123, "name": "Red", "price": { "amount": 0, "currency": "SAR" }, "formatted_price": "", "display_value": "", "advance": true, "option_id": 782399854, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "Red" } }, "is_default": false, "is_out_of_stock": false } ] }, { "id": 2022330687, "name": "Size", "description": "The size of the product", "type": "radio", "required": false, "associated_with_order_time": 0, "availability_range": false, "not_same_day_order": false, "choose_date_time": true, "from_date_time": "2022-06-23 01:04:38", "to_date_time": "2029-06-23 01:04:38", "sort": 0, "advance": true, "display_type": "text", "visibility": "always", "translations": { "ar": { "option_name": "Size", "description": "وصف هذا المنتج بالعربي" } }, "values": [ { "id": 1144986140, "name": "Small", "price": { "amount": 0, "currency": "SAR" }, "formatted_price": "", "display_value": "", "advance": true, "option_id": 2022020687, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "Small" } }, "is_default": false, "is_out_of_stock": false }, { "id": 369375517, "name": "Large", "price": { "amount": 0, "currency": "SAR" }, "formatted_price": "", "display_value": "", "advance": true, "option_id": 2022020687, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "Large" } }, "is_default": false, "is_out_of_stock": false } ] } ], "skus": [ { "id": 1936825372, "price": { "amount": 100, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "cost_price": { "amount": 0, "currency": "SAR" }, "sale_price": {}, "has_special_price": false, "stock_quantity": 12, "unlimited_quantity": true, "notify_low": "13", "barcode": "abc01", "sku": "23-4324432", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 782399854, 2022020687 ], "related_option_values": [ 410377234, 1144986140 ], "weight": 12, "weight_type": "kg", "weight_label": "١ كجم", "is_user_subscribed_to_sku": false, "is_default": false }, { "id": 1298053917, "price": { "amount": 100, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "cost_price": { "amount": 0, "currency": "SAR" }, "sale_price": {}, "has_special_price": false, "stock_quantity": 10, "unlimited_quantity": true, "notify_low": "10", "barcode": "abc01", "sku": "23-4324432", "mpn": "1891251919", "gtin": "58636897", "related_options": [ 782399854, 2022020687 ], "related_option_values": [ 369375517, 410377234 ], "weight": 1, "weight_type": "kg", "weight_label": "١ كجم", "is_user_subscribed_to_sku": false, "is_default": false }, { "id": 524016158, "price": { "amount": 100, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "cost_price": { "amount": 0, "currency": "SAR" }, "sale_price": {}, "has_special_price": false, "stock_quantity": 11, "unlimited_quantity": true, "notify_low": "10", "barcode": "abc01", "sku": "23-4324432", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 782399854, 2022020687 ], "related_option_values": [ 1144986140, 1783823123 ], "weight": 1, "weight_type": "kg", "weight_label": "١ كجم", "is_user_subscribed_to_sku": false, "is_default": false }, { "id": 1761671455, "price": { "amount": 100, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "cost_price": { "amount": 0, "currency": "SAR" }, "sale_price": {}, "has_special_price": false, "stock_quantity": 11, "unlimited_quantity": true, "notify_low": "10", "barcode": "abc01", "sku": "23-4324432", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 782399854, 2022020687 ], "related_option_values": [ 369375517, 1783823123 ], "weight": 1, "weight_type": "kg", "weight_label": "١ كجم", "is_user_subscribed_to_sku": false, "is_default": false } ], "categories": [], "tags": [] }, { "id": 1994210129, "promotion": { "title": "Ramadan promotion", "sub_title": "special ramadan offers" }, "sku": "45344432343", "mpn": "1891251919", "gtin": "45344432343", "type": "product", "name": "تنورة", "short_link_code": "bYNPQN", "urls": { "customer": "https://salla.sa/dev-wofftr4xsra5xtlv/تنورة/p1994210129", "admin": "https://s.salla.sa/products/1994210129" }, "price": { "amount": 79, "currency": "SAR" }, "taxed_price": { "amount": 79, "currency": "SAR" }, "pre_tax_price": { "amount": 79, "currency": "SAR" }, "tax": { "amount": 0, "currency": "SAR" }, "description": "product description", "quantity": 1, "status": "sale", "is_available": true, "views": 0, "sale_price": { "amount": 79, "currency": "SAR" }, "sale_end": "2025-06-23", "require_shipping": false, "cost_price": "10", "weight": 0.25, "weight_type": "kg", "with_tax": true, "url": "https://salla.sa/dev-wofftr4xsra5xtlv/تنورة/p1994210129", "main_image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/oA7b8BnGGsopb0pgw6dRKmgTEa88QOmKgX9ht83A.jpg", "images": [ { "id": 1784733955, "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/wotC9bwJrWpHK92YWgpq3F90BvCnVEuomf3Dy7Hw.jpg", "main": false, "three_d_image_url": "", "alt": "", "video_url": "", "type": "image", "sort": 0 }, { "id": 1145896972, "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/pXQK99ETNfrqS3uyOwndFQRGzYJTtlEpdBYRp42N.jpg", "main": false, "three_d_image_url": "", "alt": "", "video_url": "", "type": "image", "sort": 0 }, { "id": 371863309, "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/Nx6dWmJgPDTTfMdnusVlYxEL0Sj9ObBMgM7e6IcO.jpg", "main": false, "three_d_image_url": "", "alt": "", "video_url": "", "type": "image", "sort": 0 }, { "id": 1677151758, "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/w2zyTvXyO8DTqgcLJhSYwYvS8wYiQv5lEZV17pnp.jpg", "main": false, "three_d_image_url": "", "alt": "", "video_url": "", "type": "image", "sort": 0 }, { "id": 1037856015, "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/8R2Gk5mtNsxr6NZ1msMPj0FBRes6KfIwtxWmKTcj.jpg", "main": false, "three_d_image_url": "", "alt": "", "video_url": "", "type": "image", "sort": 0 } ], "sold_quantity": "1", "rating": { "total": 0, "count": 1, "rate": 0 }, "regular_price": { "amount": 159, "currency": "SAR" }, "max_items_per_user": 0, "maximum_quantity_per_order": "5", "show_in_app": true, "notify_quantity": "10", "hide_quantity": false, "unlimited_quantity": false, "managed_by_branches": false, "services_blocks": { "installments": [] }, "calories": 500, "starting_price": {}, "metadata": { "title": "Ramadan promotion", "description": "special offer" }, "allow_attachments": false, "is_pinned": false, "pinned_date": "2021-08-26 09:58:29", "sort": 0, "enable_upload_image": false, "updated_at": "2022-02-06 11:45:30", "options": [ { "id": 1891251919, "name": "المقاس", "description": "This item is one of the best seller", "type": "radio", "required": false, "associated_with_order_time": 0, "availability_range": false, "not_same_day_order": false, "choose_date_time": true, "from_date_time": "2022-06-23 01:04:38", "to_date_time": "2025-06-23 01:04:38", "sort": 0, "advance": true, "display_type": "text", "visibility": "always", "translations": { "ar": { "option_name": "المقاس", "description": "This item is one of the best seller" } }, "values": [ { "id": 35556073, "name": "44 - XL", "price": { "amount": 0, "currency": "SAR" }, "display_value": "1891251919", "advance": true, "option_id": 1891251919, "image_url": "https://imageLink/png", "hashed_display_value": "name", "translations": { "ar": { "option_details_name": "44 - XL" } } }, { "id": 1610328554, "name": "42 - L", "price": { "amount": 0, "currency": "SAR" }, "display_value": "", "advance": true, "option_id": 1891251919, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "42 - L" } } }, { "id": 700500203, "name": "40 - M", "price": { "amount": 0, "currency": "SAR" }, "display_value": "", "advance": true, "option_id": 1891251919, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "40 - M" } } }, { "id": 2074990580, "name": "38 - S", "price": { "amount": 0, "currency": "SAR" }, "display_value": "", "advance": true, "option_id": 1891251919, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "38 - S" } } }, { "id": 1435170549, "name": "36 - XS", "price": { "amount": 0, "currency": "SAR" }, "display_value": "", "advance": true, "option_id": 1891251919, "image_url": "https://imageLink/png", "hashed_display_value": "", "translations": { "ar": { "option_details_name": "36 - XS" } } } ] } ], "skus": [ { "id": 2124894995, "price": { "amount": 79, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "sale_price": { "amount": 79, "currency": "SAR" }, "stock_quantity": 100, "barcode": "abc01", "sku": "23-4324432", "mpn": "58636897", "gtin": "45344432343", "related_options": [ 35556073 ], "related_option_values": [ 35556073 ], "weight": 12, "weight_type": "kg", "weight_label": "٠٫٢٥ كجم" }, { "id": 1217163804, "price": { "amount": 79, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "sale_price": { "amount": 79, "currency": "SAR" }, "stock_quantity": 0, "barcode": "abc01", "sku": "23-4324432", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 1610328554 ], "related_option_values": [ 1610328554 ], "weight": 12, "weight_type": "kg", "weight_label": "٠٫٢٥ كجم" }, { "id": 443191581, "price": { "amount": 79, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "sale_price": { "amount": 79, "currency": "SAR" }, "stock_quantity": 1, "barcode": "abc01", "sku": "23-4324432", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 700500203 ], "related_option_values": [ 700500203 ], "weight": 12, "weight_type": "kg", "weight_label": "٠٫٢٥ كجم" }, { "id": 1949806622, "price": { "amount": 79, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "sale_price": { "amount": 79, "currency": "SAR" }, "stock_quantity": 0, "barcode": "abc01", "sku": "23-4324432", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 2074990580 ], "related_option_values": [ 2074990580 ], "weight": 12, "weight_type": "kg", "weight_label": "٠٫٢٥ كجم" }, { "id": 1176297247, "price": { "amount": 79, "currency": "SAR" }, "regular_price": { "amount": 0, "currency": "SAR" }, "sale_price": { "amount": 79, "currency": "SAR" }, "stock_quantity": 1, "barcode": "abc01", "sku": "45344432343", "mpn": "45344432343", "gtin": "58636897", "related_options": [ 1435170549 ], "related_option_values": [ 1435170549 ], "weight": 12, "weight_type": "kg", "weight_label": "٠٫٢٥ كجم" } ], "categories": [ { "id": 1032561074, "name": "الفساتين", "urls": { "customer": "https://salla.sa/dev-wofftr4xsra5xtlv/الفساتين/c1032561074", "admin": "https://s.salla.sa/categories" }, "items": [], "parent_id": 0, "status": "active", "sort_order": 1, "update_at": { "date": "2022-04-25 19:46:26.000000", "timezone_type": 3, "timezone": "Asia/Riyadh" } } ], "brand": {}, "tags": [] } ], "pagination": { "count": 20, "total": 90, "perPage": 20, "currentPage": 3, "totalPages": 5, "links": { "previous": "http://api.salla.dev/admin/v2/products?page=2", "next": "http://api.salla.dev/admin/v2/products?page=4" } } }
🟢200Success | Light Format
🟠401Unauthorized