Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs
    Light Mode

    List Products

    GET/products
    Last modified: a month ago

    This endpoint allows you to list all available products related to your store.

    :::check[Simplifed, Minimal Response]
    If you want to receive a simple, data-reduced response when consuming the List Products endpoint, you can use the query parameter format=light
    :::

    :::note[Note]
    This endpoint allows you to filter the list of available products by matching the following parameters:

    • keyword
    • status
    • category
      :::
    `products.read`- Products Read Only

    Request

    Query Params
    page
    integer 
    optional

    The Pagination page number

    keyword
    string 
    optional

    A keyword to filter products are match specific name or SKU value.

    status
    string 
    optional

    Get products are match specific status. Available values hidden,sale,out

    category
    string 
    optional

    Get products included in specific category.

    per_page
    integer 
    optional

    Products limit per page

    format
    enum<string> 
    optional

    Fetches simplifed product data using the light value

    Allowed value:
    light

    Request samples

    Responses

    Success | Full Example(200)
    Success | Light Format(200)
    Success | Full Example
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    object {0}
    Example
    Example
    {
      "status": 200,
      "success": true,
      "data": [
        {
          "id": 1672932878,
          "promotion": {
            "title": null,
            "sub_title": null
          },
          "sku": "",
          "thumbnail": "https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/2E0Z2t6Q8FG3ca2j2PAGrqqeDROY.jpg",
          "mpn": null,
          "gtin": null,
          "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": null,
          "status": "sale",
          "is_available": true,
          "views": 0,
          "sale_price": {
            "amount": 0,
            "currency": "SAR"
          },
          "sale_end": null,
          "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": null,
          "show_in_app": true,
          "notify_quantity": null,
          "hide_quantity": false,
          "unlimited_quantity": true,
          "managed_by_branches": false,
          "services_blocks": {
            "installments": []
          },
          "calories": null,
          "customized_sku_quantity": false,
          "channels": [
            "web",
            "app"
          ],
          "metadata": {
            "title": null,
            "description": null,
            "url": null
          },
          "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": null,
              "type": "radio",
              "required": false,
              "associated_with_order_time": 0,
              "availability_range": false,
              "not_same_day_order": false,
              "choose_date_time": null,
              "from_date_time": null,
              "to_date_time": null,
              "sort": null,
              "advance": true,
              "display_type": "text",
              "visibility": "always",
              "translations": {
                "ar": {
                  "option_name": "Color",
                  "description": null
                }
              },
              "values": [
                {
                  "id": 422377234,
                  "name": "Blue",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "formatted_price": "",
                  "display_value": null,
                  "advance": true,
                  "option_id": 782399854,
                  "image_url": null,
                  "hashed_display_value": null,
                  "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": null,
                  "advance": true,
                  "option_id": 782399854,
                  "image_url": null,
                  "hashed_display_value": null,
                  "translations": {
                    "ar": {
                      "option_details_name": "Red"
                    }
                  },
                  "is_default": false,
                  "is_out_of_stock": false
                }
              ]
            },
            {
              "id": 2022330687,
              "name": "Size",
              "description": null,
              "type": "radio",
              "required": false,
              "associated_with_order_time": 0,
              "availability_range": false,
              "not_same_day_order": false,
              "choose_date_time": null,
              "from_date_time": null,
              "to_date_time": null,
              "sort": null,
              "advance": true,
              "display_type": "text",
              "visibility": "always",
              "translations": {
                "ar": {
                  "option_name": "Size",
                  "description": null
                }
              },
              "values": [
                {
                  "id": 1144986140,
                  "name": "Small",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "formatted_price": "",
                  "display_value": null,
                  "advance": true,
                  "option_id": 2022020687,
                  "image_url": null,
                  "hashed_display_value": null,
                  "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": null,
                  "advance": true,
                  "option_id": 2022020687,
                  "image_url": null,
                  "hashed_display_value": null,
                  "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": null,
              "has_special_price": false,
              "stock_quantity": null,
              "unlimited_quantity": true,
              "notify_low": null,
              "barcode": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                782399854,
                2022020687
              ],
              "related_option_values": [
                410377234,
                1144986140
              ],
              "weight": null,
              "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": null,
              "has_special_price": false,
              "stock_quantity": null,
              "unlimited_quantity": true,
              "notify_low": null,
              "barcode": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                782399854,
                2022020687
              ],
              "related_option_values": [
                369375517,
                410377234
              ],
              "weight": null,
              "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": null,
              "has_special_price": false,
              "stock_quantity": null,
              "unlimited_quantity": true,
              "notify_low": null,
              "barcode": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                782399854,
                2022020687
              ],
              "related_option_values": [
                1144986140,
                1783823123
              ],
              "weight": null,
              "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": null,
              "has_special_price": false,
              "stock_quantity": null,
              "unlimited_quantity": true,
              "notify_low": null,
              "barcode": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                782399854,
                2022020687
              ],
              "related_option_values": [
                369375517,
                1783823123
              ],
              "weight": null,
              "weight_type": "kg",
              "weight_label": "١ كجم",
              "is_user_subscribed_to_sku": false,
              "is_default": false
            }
          ],
          "categories": [],
          "tags": []
        },
        {
          "id": 1994210129,
          "promotion": {
            "title": null,
            "sub_title": null
          },
          "sku": null,
          "mpn": null,
          "gtin": null,
          "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": null,
          "require_shipping": false,
          "cost_price": null,
          "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": null,
          "show_in_app": true,
          "notify_quantity": null,
          "hide_quantity": false,
          "unlimited_quantity": false,
          "managed_by_branches": false,
          "services_blocks": {
            "installments": []
          },
          "calories": null,
          "starting_price": null,
          "metadata": {
            "title": null,
            "description": null
          },
          "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": null,
              "type": "radio",
              "required": false,
              "associated_with_order_time": 0,
              "availability_range": false,
              "not_same_day_order": false,
              "choose_date_time": null,
              "from_date_time": null,
              "to_date_time": null,
              "sort": null,
              "advance": true,
              "display_type": "text",
              "visibility": "always",
              "translations": {
                "ar": {
                  "option_name": "المقاس",
                  "description": null
                }
              },
              "values": [
                {
                  "id": 35556073,
                  "name": "44 - XL",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "display_value": null,
                  "advance": true,
                  "option_id": 1891251919,
                  "image_url": null,
                  "hashed_display_value": null,
                  "translations": {
                    "ar": {
                      "option_details_name": "44 - XL"
                    }
                  }
                },
                {
                  "id": 1610328554,
                  "name": "42 - L",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "display_value": null,
                  "advance": true,
                  "option_id": 1891251919,
                  "image_url": null,
                  "hashed_display_value": null,
                  "translations": {
                    "ar": {
                      "option_details_name": "42 - L"
                    }
                  }
                },
                {
                  "id": 700500203,
                  "name": "40 - M",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "display_value": null,
                  "advance": true,
                  "option_id": 1891251919,
                  "image_url": null,
                  "hashed_display_value": null,
                  "translations": {
                    "ar": {
                      "option_details_name": "40 - M"
                    }
                  }
                },
                {
                  "id": 2074990580,
                  "name": "38 - S",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "display_value": null,
                  "advance": true,
                  "option_id": 1891251919,
                  "image_url": null,
                  "hashed_display_value": null,
                  "translations": {
                    "ar": {
                      "option_details_name": "38 - S"
                    }
                  }
                },
                {
                  "id": 1435170549,
                  "name": "36 - XS",
                  "price": {
                    "amount": 0,
                    "currency": "SAR"
                  },
                  "display_value": null,
                  "advance": true,
                  "option_id": 1891251919,
                  "image_url": null,
                  "hashed_display_value": null,
                  "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": 0,
              "barcode": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                35556073
              ],
              "related_option_values": [
                35556073
              ],
              "weight": null,
              "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": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                1610328554
              ],
              "related_option_values": [
                1610328554
              ],
              "weight": null,
              "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": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                700500203
              ],
              "related_option_values": [
                700500203
              ],
              "weight": null,
              "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": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                2074990580
              ],
              "related_option_values": [
                2074990580
              ],
              "weight": null,
              "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": null,
              "sku": null,
              "mpn": null,
              "gtin": null,
              "related_options": [
                1435170549
              ],
              "related_option_values": [
                1435170549
              ],
              "weight": null,
              "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": null,
          "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"
        }
      }
    }
    Last modified: a month ago