Light Mode

List Categories

GET/categories

Last modified: 19 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.

`categories.read`- Categories Read Only

Request

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

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)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

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

$ref(#/definitions/1387918)[]

optional

#/definitions/1387918

optional

pagination

#/definitions/1307303

optional

{
  "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": []
  }
}

Last modified: 19 days ago