Light Mode

List Categories

GET/categories

Last modified: 17 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

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)

Success | `With` Query Parameter translations(200)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 846957281,
      "name": "خضروات",
      "urls": {
        "customer": "https://shtara.com/profile",
        "admin": "https://shtara.com/profiles"
      },
      "sort_order": 0,
      "items": []
    },
    {
      "id": 181391824,
      "name": "User Name",
      "urls": {
        "customer": "https://shtara.com/profile",
        "admin": "https://shtara.com/profiles"
      },
      "sort_order": 0,
      "items": []
    },
    {
      "id": 205564386,
      "name": "فواكه",
      "urls": {
        "customer": "https://shtara.com/profile",
        "admin": "https://shtara.com/profiles"
      },
      "sort_order": 1,
      "items": [
        {
          "id": 1255216786,
          "name": "فواكه صيفية",
          "sort_order": 1,
          "items": []
        }
      ]
    },
    {
      "id": 1240558514,
      "name": "Dress",
      "urls": {
        "customer": "https://shtara.com/profile",
        "admin": "https://shtara.com/profiles"
      },
      "sort_order": 18,
      "items": []
    }
  ]
}

Last modified: 17 days ago