List Categories
GET {{baseUrl}}/categories
You can 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.
Note: This endpoint returns categories and their children (sub categories) if exist.
OAuth Scopes
categories.read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | The Pagination page number | |
keyword | string | A keyword to filter categories by a specific name. |
RESPONSES
status: OK
{"status":200,"success":true,"data":[{"id":846957281,"name":"خضروات","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiles"},"sort_order":0,"items":[],"sub_categories":[]},{"id":181391824,"name":"salama","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiles"},"sort_order":0,"items":[],"sub_categories":[]},{"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":[],"sub_categories":[]}],"sub_categories":[{"id":1255216786,"name":"فواكه صيفية","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiles"},"sort_order":1,"items":[],"sub_categories":[]}]},{"id":1240558514,"name":"Dress","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiles"},"sort_order":18,"items":[],"sub_categories":[]}],"pagination":{"count":4,"total":4,"perPage":15,"currentPage":1,"totalPages":1,"links":[]}}