List Categories
GET {{baseUrl}}/categories?page=1&keyword=Dress
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.
🌐 Multi-Lang Support
The following are translate-able by the Header Values, such as
ACCEPT-LANGUAGE&CONTENT-LANGUAGE:
Variable Title nameitems.name
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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
ACCEPT-LANGUAGE | string | Set Language Code you want to get the response with. Retrieve a list of supported languages using the Language Endpoint. Use the iso_code value you get from the language endpoint as a value in this header. | |
CONTENT-LANGUAGE | string | (OPTIONAL) Show the used language of the response. Note that not passing a value here or passing the default value of the iso_code as ar will not appear in the response. | |
Accept | string |
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":[]},{"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":[]}],"sub_categories":[{"id":1255216786,"name":"فواكه صيفية","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiles"},"sort_order":1,"items":[]}]},{"id":1240558514,"name":"Dress","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profiles"},"sort_order":18,"items":[]}],"pagination":{"count":4,"total":4,"perPage":15,"currentPage":1,"totalPages":1,"links":[]}}