Light Mode
List Categories
GET
/categoriesLast modified: 12 days ago
This endpoint allows you to list all categories related to your store directly from this endpoint. Also, it allows you to filter them using a keyword, the endpoint would return any category which name matches this keyword.
Request
Query Params
page
integer
optional
The Pagination page number
keyword
string
optional
A keyword to filter categories by a specific name.
status
string
optional
The status of the category, whether or not it is active
or hidden
with
array[string]
optional
Returns the response with translations or items (or both). Takes values with separated comma or array of either items, translations or both in this case:with=items
OR with=translations
OR with[]=items&with[]=translations
OR with=items,translations
Example:
translations
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
Example | Default Response
{
"status": 200,
"success": true,
"data": [
{
"id": 1390018242,
"name": "laptops",
"image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/QEFy9wUtKnazAVvm3t3WSYg2z1LTnxUzvrceFo2s.jpg",
"urls": {
"customer": "https://store.test/ar/jalal56s/laptops/c1390018242",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 0,
"status": "active",
"show_in": {
"app": true,
"salla_points": true
},
"has_hidden_products": true,
"update_at": "2024-10-24 13:24:48",
"metadata": {
"title": null,
"description": null,
"url": null
},
"sub_categories": []
},
{
"id": 115638743,
"name": "welcome jojo",
"image": null,
"urls": {
"customer": "https://store.test/ar/jalal56s/welcome-jojo/c115638743",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 0,
"status": "active",
"show_in": {
"app": true,
"salla_points": false
},
"has_hidden_products": false,
"update_at": "2024-10-24 14:19:55",
"metadata": {
"title": null,
"description": null,
"url": null
},
"sub_categories": []
},
{
"id": 40297589,
"name": "قطط",
"image": null,
"urls": {
"customer": "https://store.test/ar/jalal56s/قطط/c40297589",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 1,
"status": "active",
"show_in": {
"app": false,
"salla_points": false
},
"has_hidden_products": false,
"update_at": "2024-10-21 14:44:57",
"metadata": {
"title": "قطط",
"description": "welcome",
"url": "قطط"
},
"sub_categories": []
},
{
"id": 774382199,
"name": "طعام كلاب",
"image": null,
"urls": {
"customer": "https://store.test/ar/jalal56s/كلاب/c774382199",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 2,
"status": "hidden",
"show_in": {
"app": false,
"salla_points": false
},
"has_hidden_products": false,
"update_at": "2024-10-21 14:45:27",
"metadata": {
"title": null,
"description": null,
"url": null
},
"sub_categories": []
},
{
"id": 712043358,
"name": "العناية",
"image": null,
"urls": {
"customer": "https://store.test/ar/jalal56s/العناية/c712043358",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 3,
"status": "active",
"show_in": {
"app": false,
"salla_points": false
},
"has_hidden_products": false,
"update_at": "2024-10-21 14:51:38",
"metadata": {
"title": null,
"description": null,
"url": null
},
"sub_categories": []
},
{
"id": 537348185,
"name": "جميع الأقسام",
"image": null,
"urls": {
"customer": "https://store.test/ar/jalal56s/جميع-الأقسام/c537348185",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 3,
"status": "active",
"show_in": {
"app": true,
"salla_points": false
},
"has_hidden_products": false,
"update_at": "2024-09-06 13:01:49",
"metadata": {
"title": null,
"description": null,
"url": null
},
"sub_categories": []
},
{
"id": 355378101,
"name": "فساتين",
"image": null,
"urls": {
"customer": "https://store.test/ar/jalal56s/فساتين-سهرة/c355378101",
"admin": "/categories"
},
"parent_id": 0,
"sort_order": 4,
"status": "active",
"show_in": {
"app": true,
"salla_points": false
},
"has_hidden_products": false,
"update_at": "2024-09-07 14:34:09",
"metadata": {
"title": null,
"description": null,
"url": null
},
"sub_categories": []
}
],
"pagination": {
"count": 7,
"total": 7,
"perPage": 20,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}
Last modified: 12 days ago