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. Products
  • 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
      • List Orders
      • Order Details
      • Create Drafted Order
      • Update Order
      • Duplicate Order
      • Order Actions
    • 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
        POST
      • List Products
        GET
      • Product Details
        GET
      • Update Product
        PUT
      • Delete Product
        DELETE
      • Change Product Status
        POST
      • Product Details By SKU
        GET
      • Update Product By SKU
        PUT
      • Delete Product By SKU
        DELETE
      • Update Product Price By SKU
        POST
      • Update Bulk Product Prices
        POST
      • Import Products
        POST
      • Bulk Product Actions
        POST
    • 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. Products

Product Details

Production
https://api.salla.dev/admin/v2
Production
https://api.salla.dev/admin/v2
GET
https://api.salla.dev/admin/v2
/products/{product}
Products
Last modified:2025-02-04 08:45:24
This endpoint allows you to return specific product details by passing the product as a path parameter.
Scopes
products.read- Products Read Only

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
product
integer 
required
Unique identification number assigned to a Product. List of Product ID 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/products/'

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
object (ProductDetails) 
optional
Detailed structure of the Product model object showing its fields and data types.
id
number 
required
A unique identifier for a specific product within a database.
promotion
object 
required
Product promotion details
sku
string 
required
Stock Keeping Unit is a unique alphanumeric code used to identify and manage specific products within a company's inventory.
mpn
string  | null 
required
Manufacturer Part Number (MPN) is a unique identifier assigned by manufacturers to products.
Example:
45343
gtin
string  | null 
required
"Global Trade Item Number" (GTIN), a unique and standardized identifier used to uniquely represent products in the global marketplace.
Example:
14643439
type
enum<string> 
required
The categorization of a product based on its characteristics, features, or intended use.
Allowed values:
productservicegroup_productscodesdigitalfooddonatingbooking
name
string 
required
A label for an item, aiding in easy identification and categorization within a product listing. 🌐 Supports multi-language
short_link_code
string 
required
A short and simplified alphanumeric code or URL used to provide a quick and easy way to access or share a specific product's webpage or information.
urls
object (Urls) 
required
To help companies and merchants, Salla provides a “urls” attribute that has been added to different modules to guide the merchants to have the full URL of this module from both scopes, the dashboard scope as a store admin, and as a customer.
price
object 
required
taxed_price
object 
required
pre_tax_price
object 
required
Product price details before the tax is applied.
tax
object 
required
Product tax price details
description
string 
required
A detailed information about an item. 🌐 Support multi-language
quantity
integer 
required
The number of items available in stock.
unlimited_quantity
boolean 
required
Whether or not the product is of unlimited quantity.
status
enum<string> 
required
Product status refers to the current state of availability of a particular item within a product catalog or inventory.
Allowed values:
saleouthiddendeleted
is_available
boolean 
required
Whether or not the product is available.
views
integer 
required
The total number of times a specific product has been viewed by users.
sale_price
object 
required
The information about the discounted price or special pricing for a product.
sale_end
string 
required
The date or time when a promotional sale or discount on a product is scheduled to expire.
require_shipping
boolean 
required
Whether or not the product necessitates a physical delivery process or can be provided digitally without shipping.
cost_price
number 
required
The amount a business pays to acquire or manufacture a product before any additional expenses, such as overhead or markup, are applied
weight
number 
required
The weight of the product represented in numerical form if applicable.
weight_type
enum<string> 
required
The classification or unit of measurement used to specify the weight of an object or item, such as kilograms (kg), pounds (lb), ounces (oz), or grams (g).
Allowed values:
kgglboz
with_tax
boolean 
required
Whether or not a tax applied to this product or not.
url
string 
required
The hyperlink that leads to a specific product's page.
images
array [object {9}] 
required
Visual representations or pictures of a product, to showcase its appearance, features, and details to potential customers.
sold_quantity
integer 
required
The total number of items of the product that have been purchased or sold over a certain period.
rating
object 
required
Product rating details, include information about the ratings and reviews provided by customers for a specific product.
regular_price
object 
required
Product regular price details.
max_items_per_user
number 
required
The limit set on the number of products that an individual user is allowed to purchase.
maximum_quantity_per_order
number  | null 
required
Maximum quantity per order for the customer or the maximum quantity for the product.
show_in_app
boolean 
required
Whether or not to show the product in the App.
notify_quantity
string  | null 
required
Notify quantity of the product.
hide_quantity
boolean 
required
Whether or not to hide the product quantity.
channels
array[string]
required
The product to appear in specific channels.
Allowed values:
appweb
managed_by_branches
boolean 
required
Whether or not to indicate if the product is managed by branches.
service_blocks
object 
required
External services for the prodcut.
calories
string  | null 
required
Calories amount of the product.
Example:
500.00
starting_price
object 
required
The merchant owner should activate this feature from his store from here.
Example:
500.00
allow_attachments
boolean 
required
Whether or not to allow adding attachments to the prodcut details.
is_pinned
boolean 
required
Whether or not to show if the prodcut is pinned.
pinned_date
string 
required
The date which the product was pinned at.
sort
number 
required
Sorting order of the product.
active_advance
boolean 
required
Whether or not to activate advance product details.
enable_upload_image
boolean 
required
Whether or not to allow image uploading.
updated_at
string 
required
Product last updated date.
options
array[object (MiniProductOption) {13}] 
required
The additional choices that can be selected to customize the product according to preferences.
skus
array[object (ProductVariant) {21}] 
required
Product variants SKUs details
metadata
object 
required
The data that describes other data, providing details on its creation, format, and context.
booking_details
object 
required
The information related to a specific booking, such as date, time, location, and other relevant particulars
categories
array[object (Category) {14}] 
required
The various sections or attributes that describe a product, such as name, price, description, specifications, and availability.
brand
object (Brand) 
required
Detailed structure of the brand model object showing its fields and data types.
tags
array [object {2}] 
required
Example
{
  "status": 200,
  "success": true,
  "data": {
    "id": 1672932878,
    "promotion": {
      "title": "Eid Promotion",
      "sub_title": "Eid Offers"
    },
    "sku": "23-TD23-32",
    "thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca2j2PAGrqqeDROY.jpg",
    "mpn": "1891251919",
    "gtin": "58636897",
    "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": 0,
    "status": "sale",
    "is_available": true,
    "views": 0,
    "sale_price": {
      "amount": 0,
      "currency": "SAR"
    },
    "sale_end": "2025-06-23",
    "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": "500",
    "customized_sku_quantity": false,
    "channels": [
      "web",
      "app"
    ],
    "metadata": {
      "title": "title of the item promoted",
      "description": " The item promoted is the best ",
      "url": "https://linkForItem"
    },
    "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": " The item promoted is the best",
        "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": "Color",
            "description": " The item promoted is the best"
          }
        },
        "values": [
          {
            "id": 422377234,
            "name": "Blue",
            "price": {
              "amount": 0,
              "currency": "SAR"
            },
            "formatted_price": "",
            "display_value": "",
            "advance": true,
            "option_id": 782399854,
            "image_url": "https://linkForItem",
            "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://linkForItemTag",
            "hashed_display_value": "",
            "translations": {
              "ar": {
                "option_details_name": "Red"
              }
            },
            "is_default": false,
            "is_out_of_stock": false
          }
        ]
      },
      {
        "id": 2022330687,
        "name": "Size",
        "description": " The item promoted is the best ",
        "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": "Size",
            "description": " The item promoted is the best "
          }
        },
        "values": [
          {
            "id": 1144986140,
            "name": "Small",
            "price": {
              "amount": 0,
              "currency": "SAR"
            },
            "formatted_price": "",
            "display_value": "",
            "advance": true,
            "option_id": 2022020687,
            "image_url": "https://linkForItem",
            "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://linkForItem",
            "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": "0",
        "unlimited_quantity": true,
        "notify_low": "10",
        "barcode": "abc01",
        "sku": "23-TD23-32",
        "mpn": "58636897",
        "gtin": "58636897",
        "related_options": [
          782399854,
          2022020687
        ],
        "related_option_values": [
          410377234,
          1144986140
        ],
        "weight": 1,
        "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": "12",
        "barcode": "abc01",
        "sku": "23-TD23-32",
        "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": "5",
        "unlimited_quantity": true,
        "notify_low": "10",
        "barcode": "abc01",
        "sku": "23-TD23-32",
        "mpn": "58636897",
        "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": "10",
        "unlimited_quantity": true,
        "notify_low": "10",
        "barcode": "abc01",
        "sku": "23-TD23-32",
        "mpn": "58636897",
        "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": []
  }
}
🟠404Not Found
🟠401Unauthorized
Modified at 2025-02-04 08:45:24
Previous
List Products
Next
Update Product