Category Children

This endpoint allows you to return specific category children by passing the category as a path parameter.

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 ********************

Path Params

category

integer

required

Unique identifiers assigned to a Category. List of Category IDs can be found here.

Query Params

page

integer

optional

The Pagination page number

Responses

🟢200Success

application/json

Body

status

integer

optional

Response Status Code

success

boolean

optional

Whether or not the response is successful

data

array [object {5}]

optional

integer

optional

Category ID

name

string

optional

Category Name

urls

object

optional

sort_order

integer

optional

Category Sort Order

items

array[string]

optional

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

optional

number of returned results

total

number

optional

number of all results

perPage

number

optional

number of results per page

<= 65

currentPage

number

optional

number of current page

totalPages

number

optional

number of total pages

links

array[string]

optional

array of linkes to next and previous pages

Example

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1255216786,
      "name": "فواكه صيفية",
      "urls": {
        "customer": "https://shtara.com/profile",
        "admin": "https://shtara.com/profile"
      },
      "sort_order": 1,
      "items": []
    }
  ],
  "pagination": {
    "count": 1,
    "total": 1,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

🟠404Not Found

🟠401Unauthorized

Request

Request samples

Responses