Salla Docs
Categories Search
GET/categories/searchThis endpoint allows you to search through existing categories using keywords (a.k.a name of the category) as well as an array of Category IDs
Request
Request samples
[api.label.responses]
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.
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.
Category ID, is a unique identifier assigned to a specific product category, facilitating organized classification and efficient management of products within a similar group. List of categories can be found here.
Category name is a descriptive label assigned to a product category, aiding in clear identification and organization of related products. 🌐 Support multi-language
The category image
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.
Category Parent ID refers to the unique identifier assigned to the parent category of a subcategory, establishing a hierarchical relationship between different levels of product classification.
The sequence or arrangement of categories when displayed to users.
The category status indicates whether the category is currently visible and accessible to users active or intentionally concealed from view hidden. It essentially controls whether the category is publicly displayed or kept private within the system.
Whether or not the category has hidden products.
The date where the category is updated in.
The subcategories list of the main category.
You will get this object in the response if you use with=translations query parameter.
Category translations are based on the store's enabled language locale. For instance, if the store supports both Arabic and English, the translations object will return two entries: ar for Arabic and en for English.
You will get this array in the response if you use with=items query parameter.
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.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"status": 200,
"success": true,
"data": [
{
"id": 558898595,
"name": "الفساتين",
"urls": {
"customer": "https://salla.sa/dev-k9dn7fok0vih4p70/category/mENQjb",
"admin": "https://s.salla.sa/categories"
},
"parent_id": 0,
"status": "active",
"sort_order": 0,
"update_at": "2024-10-02 13:10:17",
"metadata": {
"title": "dresses",
"description": "dresses",
"url": "dresses"
}
},
{
"id": 1181713494,
"name": "البلايز",
"urls": {
"customer": "https://salla.sa/dev-k9dn7fok0vih4p70/category/NDYwBg",
"admin": "https://s.salla.sa/categories"
},
"parent_id": 0,
"status": "hidden",
"sort_order": 2,
"update_at": "2024-02-05 16:33:11",
"metadata": {
"title": "tshirts",
"description": "tshirts",
"url": "tshirts"
}
}
],
"pagination": {
"count": 2,
"total": 2,
"perPage": 20,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}