List Categories

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.

Scopes

categories.read- Categories 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

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

Responses

🟢200Success

application/json

Body

status

number

optional

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

optional

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 (Category) {14}]

optional

number

required

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.

name

string

required

Category name is a descriptive label assigned to a product category, aiding in clear identification and organization of related products. 🌐 Support multi-language

image

string

required

The category image

urls

object (Urls)

required

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.

parent_id

integer

required

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.

sort_order

integer | null

required

The sequence or arrangement of categories when displayed to users.

status

enum<string>

required

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.

Allowed values:

activehidden

show_in

object

required

has_hidden_products

boolean

required

Whether or not the category has hidden products.

update_at

string

required

The date where the category is updated in.

metadata

object

required

sub_categories

array[string]

required

The subcategories list of the main category.

translations

object

required

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.

items

array[object (Category) {14}]

required

You will get this array in the response if you use with=items query parameter.

pagination

object (Pagination)

optional

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

Example | Default ResponseExample | `with=translations` Query ParameterExample | `with=items` Query Parameter

{
  "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": "This product is amazing",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
      },
      "sub_categories": []
    },
    {
      "id": 115638743,
      "name": "welcome jojo",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/QEFy9wUtKnazAVvm3t3WSYg2z1LTnxUzvrceFo2s.jpg",
      "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": "This product is amazing",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
      },
      "sub_categories": []
    },
    {
      "id": 40297589,
      "name": "قطط",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/QEFy9wUtKnazAVvm3t3WSYg2z1LTnxUzvrceFo2s.jpg",
      "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": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/QEFy9wUtKnazAVvm3t3WSYg2z1LTnxUzvrceFo2s.jpg",
      "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": "This product is amazing",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
      },
      "sub_categories": []
    },
    {
      "id": 712043358,
      "name": "العناية",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/QEFy9wUtKnazAVvm3t3WSYg2z1LTnxUzvrceFo2s.jpg",
      "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": "This product is amazing",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
      },
      "sub_categories": []
    },
    {
      "id": 537348185,
      "name": "جميع الأقسام",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/QEFy9wUtKnazAVvm3t3WSYg2z1LTnxUzvrceFo2s.jpg",
      "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": "This product is amazing",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
      },
      "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": "This product is amazing",
        "description": "This Product is one of the amazing things you can buy for yourself",
        "url": "https://salla.sa/dev-mvxlkrylzfanmuri/t-shirt/p1672908878"
      },
      "sub_categories": []
    }
  ],
  "pagination": {
    "count": 7,
    "total": 7,
    "perPage": 20,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

🟠401Unauthorized

Request

Request samples

Responses