List Products
GET {{baseUrl}}/products?page=1&keyword=Iphone&status=out&category=241974822&per_page=65
You can list all available products related to your store directly from this endpoint.
Also, it allows you to filter them using a keyword, status, and category parameters. The endpoint would retrieve any product that matches used filters.
🌐 Multi-Lang Support
The following are translate-able by the Header Values, such as
ACCEPT-LANGUAGE&CONTENT-LANGUAGE:
Variable Title namepromotion.titlepromotion.subtitledescriptioncategories.name
OAuth Scopes
products.read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | The Pagination page number | |
keyword | string | A keyword to filter products are match specific name or sku. | |
status | string | Get products are match specific status. available values hidden,sale,out | |
category | number | Get products included in specific category. | |
per_page | number | Products limit per page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
ACCEPT-LANGUAGE | string | Set Language Code you want to get the response with. Retrieve a list of supported languages using the Language Endpoint. Use the iso_code value you get from the language endpoint as a value in this header. | |
CONTENT-LANGUAGE | string | (OPTIONAL) Show the used language of the response. Note that not passing a value here or passing the default value of the iso_code as ar will not appear in the response. | |
Accept | string |
RESPONSES
status: OK
{"status":200,"success":true,"data":[{"id":2127310087,"promotion":{"title":"جديد","sub_title":"عطر فاخر"},"sku":"MU-1213","type":"product","name":"ليمون بلدي","short_link_code":"XeReZj","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profile7"},"price":{"amount":9.9,"currency":"SAR"},"description":"","quantity":13,"status":"hidden","is_available":false,"views":0,"sale_price":{"amount":0,"currency":"SAR"},"sale_end":null,"require_shipping":true,"cost_price":0,"weight":0,"with_tax":true,"url":"https://shtara.com/profile","images":[{"id":1379665616,"url":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","main":true,"alt":"","video_url":"","type":"image","sort":0},{"id":381263673,"url":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","alt":"salamatest","video_url":"","type":"image","sort":1}],"sold_quantity":0,"rating":{"total":0,"count":1,"rate":0},"regular_price":{"amount":9.9,"currency":"SAR"},"max_items_per_user":0,"show_in_app":true,"notify_quantity":null,"unlimited_quantity":false,"managed_by_branches":false,"allow_attachments":false,"is_pinned":false,"pinned_date":"2018-11-27 12:21:16","enable_upload_image":true,"updated_at":"2021-02-19 00:40:22","options":[{"id":1833119338,"name":"User Name","description":null,"type":"radio","required":false,"associated_with_order_time":0,"sort":null,"display_type":"text","visibility":"always","values":[{"id":667315336,"name":"salamavalueupdated","price":{"amount":0,"currency":"SAR"},"display_value":null,"option_id":1833119338,"image_url":null,"hashed_display_value":null}]},{"id":1130246629,"name":"option1","description":null,"type":"radio","required":false,"associated_with_order_time":0,"sort":null,"display_type":"text","visibility":"always","values":[{"id":322122678,"name":"XL","price":{"amount":0,"currency":"SAR"},"display_value":"XL","option_id":1130246629,"image_url":null,"hashed_display_value":"XL"}]},{"id":636207668,"name":"kkkkkk","description":null,"type":"radio","required":false,"associated_with_order_time":0,"sort":null,"display_type":"text","visibility":"always","values":[{"id":1318371393,"name":"XkLX","price":{"amount":0,"currency":"SAR"},"display_value":"XkLX","option_id":636207668,"image_url":null,"hashed_display_value":"XkLX"}]}],"skus":[{"id":652911549,"price":{"amount":110,"currency":"SAR"},"regular_price":{"amount":234,"currency":"SAR"},"sale_price":{"amount":100,"currency":"SAR"},"stock_quantity":13,"barcode":"barcode-ABC","sku":"sku-variant-1551119600","related_option_values":[667315336,322122678,569679762,1318371393]},{"id":1966914519,"price":{"amount":9.9,"currency":"SAR"},"regular_price":{"amount":0,"currency":"SAR"},"sale_price":null,"stock_quantity":null,"barcode":null,"sku":null,"related_option_values":[667315336,322122678,1552401892,1318371393]},{"id":1799056677,"price":{"amount":9.9,"currency":"SAR"},"regular_price":{"amount":0,"currency":"SAR"},"sale_price":null,"stock_quantity":null,"barcode":null,"sku":null,"related_option_values":[667315336,322122678,1209980149,1318371393]},{"id":673658412,"price":{"amount":9.9,"currency":"SAR"},"regular_price":{"amount":0,"currency":"SAR"},"sale_price":null,"stock_quantity":null,"barcode":null,"sku":null,"related_option_values":[667315336,322122678,393917653,1318371393]}],"categories":[],"brand":null},{"id":443968257,"promotion":{"title":null,"sub_title":"instagram.com"},"sku":"","type":"product","name":"باذنجان رومي","short_link_code":"zvEvwl","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profile7"},"price":{"amount":6.6,"currency":"SAR"},"description":"\u003cp\u003e\u003cbr\u003e\u003c/p\u003e","quantity":null,"status":"sale","is_available":true,"views":0,"sale_price":{"amount":0,"currency":"SAR"},"sale_end":null,"require_shipping":true,"cost_price":null,"weight":0,"with_tax":true,"url":"https://shtara.com/profile","images":[{"id":2045134034,"url":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","main":true,"alt":"","video_url":"","type":"image","sort":0}],"sold_quantity":0,"rating":{"total":0,"count":1,"rate":0},"regular_price":{"amount":6.6,"currency":"SAR"},"max_items_per_user":0,"show_in_app":true,"notify_quantity":null,"unlimited_quantity":true,"managed_by_branches":false,"allow_attachments":false,"is_pinned":false,"pinned_date":"2018-11-27 12:22:05","enable_upload_image":true,"updated_at":"2021-03-09 18:17:06","options":[],"skus":[],"categories":[],"brand":null},{"id":268879884,"promotion":{"title":null,"sub_title":"amazon.com"},"sku":"","type":"product","name":"بطاطا","short_link_code":"NKQKgG","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profile4"},"price":{"amount":5.5,"currency":"SAR"},"description":"\u003cp\u003e\u003cbr\u003e\u003c/p\u003e","quantity":2,"status":"sale","is_available":true,"views":0,"sale_price":{"amount":0,"currency":"SAR"},"sale_end":null,"require_shipping":true,"cost_price":null,"weight":1,"with_tax":true,"url":"https://shtara.com/profile","images":[{"id":1096007902,"url":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","main":true,"alt":"","video_url":"","type":"image","sort":0}],"sold_quantity":0,"rating":{"total":0,"count":1,"rate":0},"regular_price":{"amount":5.5,"currency":"SAR"},"max_items_per_user":0,"show_in_app":true,"notify_quantity":null,"unlimited_quantity":false,"managed_by_branches":false,"allow_attachments":false,"is_pinned":false,"pinned_date":"2018-11-27 12:23:57","enable_upload_image":true,"updated_at":"2021-04-07 22:58:25","options":[],"skus":[],"metadata":{"title":"metafromapi","description":"descfromAPI"},"categories":[],"brand":null}],"pagination":{"count":3,"total":26,"perPage":3,"currentPage":1,"totalPages":9,"links":{"next":"http://api.salla.dev/admin/v2/products?per_page=3\u0026page=2"}}}