List Product Quantities

This endpoint allows you to fetch a list of products quantities

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 ********************

Query Params

keyword

string

optional

Search using a keyword

tags

array[string]

optional

Fetch products included in specific tags based on the tag ID. Get a list of Product Tag IDs from here

Example:

["tags[]=43957834"]

branch

integer

optional

Fetch products included in specific branch based on the branch ID. Get a list of Branch IDs from here

Example:

branch=43957834

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

integer

required

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

required

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 (ProductQuantities) {9}]

required

integer

required

A unique identifier or code assigned to a specific product within a database, inventory system, or catalog to distinguish it from other products and enable efficient tracking and management.

name

string

required

A Product Name is a succinct label for a specific item, aiding in easy identification and categorization within a product listing.

image

string | null

required

The web addresses or hyperlinks that point to the online locations of images associated with the product, making it possible to display those images on websites, e-commerce platforms, or other online channels.

sku_id

integer | null

required

A unique identifier for the sku or variant.

sku

string | null

required

The product's SKU

quantity

integer

required

The number of units or items of the product that is available in stock, to track and manage the available supply of a product.

price

string

required

Product price value

unlimited_quantity

boolean

required

Option to indicate the product is of unlimited quantity

variant

string | null

required

SKU or variant name; only in case this variable is variant or null

pagination

object (Pagination)

required

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.

Examples

SuccessEmpty ResponseNo Results

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1541523973,
      "name": "فستان",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/ACknxzEIkcTdaFr1DETbQlXo5UwupBedJ9ZGyR8v.jpg",
      "sku_id": 1804462637,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": "299.00",
      "unlimited_quantity": true,
      "variant": "44 - XL"
    },
    {
      "id": 761810984,
      "name": "Variant product",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
      "sku_id": 822792308,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": true,
      "variant": "White - Medium - 12 PCs"
    },
    {
      "id": 761810984,
      "name": "Variant product",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
      "sku_id": 47710069,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": true,
      "variant": "White - Medium - 24 PCs"
    },
    {
      "id": 761810984,
      "name": "Variant product",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
      "sku_id": 1555832438,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": true,
      "variant": "White - Large - 1 PCs"
    },
    {
      "id": 761810984,
      "name": "Variant product",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
      "sku_id": 781794679,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": true,
      "variant": "White - Large - 12 PCs"
    },
    {
      "id": 761810984,
      "name": "T-Shirt",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6QDfgdca620rwqcTY2CC2j2PAGrqqeDROY.jpg",
      "sku_id": 2019974256,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": true,
      "variant": "White - Large - 24 PCs"
    },
    {
      "id": 1969594838,
      "name": "BenQ Monitor",
      "image": "",
      "sku_id": "23-TD23-32",
      "sku": "23-TD23-32",
      "quantity": 100,
      "price": 3200,
      "unlimited_quantity": false,
      "variant": "White - Medium - 24 PCs"
    },
    {
      "id": 578835251,
      "name": "Mouse",
      "image": "https://cdn.salla.sa/VXWrx/cNX0O1TGlm9pMqGFLEpjLRsoDoHyqPhiRJw7rNhL.png",
      "sku_id": 2101189545,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": false,
      "variant": "black - small"
    },
    {
      "id": 578835251,
      "name": "test cinfig",
      "image": "https://cdn.salla.sa/VXWrx/cNX0O1TGlm9pMfgEfejLRsoDoHyqPhiRJw7rNhL.png",
      "sku_id": 1327151786,
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 0,
      "unlimited_quantity": false,
      "variant": "yellow - small"
    },
    {
      "id": 1835408106,
      "name": "test variable",
      "image": "",
      "sku_id": 624931309,
      "sku": "23-TD23-32",
      "quantity": 4,
      "price": "500.00",
      "unlimited_quantity": false,
      "variant": "XL - black"
    },
    {
      "id": 1835408106,
      "name": "test variable",
      "image": "",
      "sku_id": 1876700541,
      "sku": "23-TD23-32",
      "quantity": 5,
      "price": "250.00",
      "unlimited_quantity": false,
      "variant": "XL - red"
    },
    {
      "id": 365113875,
      "name": "Samsung Charger",
      "image": "",
      "sku_id": "23-TD23-32",
      "sku": "23-TD23-32",
      "quantity": 0,
      "price": 120,
      "unlimited_quantity": false,
      "variant": "White - 2 PCs"
    },
    {
      "id": 2086964817,
      "name": "iPhone case",
      "image": "",
      "sku_id": "23-TD23-32",
      "sku": "23-TD23-32",
      "quantity": 12,
      "price": 0,
      "unlimited_quantity": false,
      "variant": "black Iphone14 pro"
    }
  ],
  "pagination": {
    "count": 15,
    "total": 45,
    "perPage": 15,
    "currentPage": 2,
    "totalPages": 3,
    "links": {
      "next": "http://api.salla.dev/admin/v2/products/quantities?page=3",
      "previous": "http://api.salla.dev/admin/v2/products/quantities?page=1"
    }
  }
}

🟠401unautorized