List Brands
GET {{baseUrl}}/brands?keyword=ZARA&page=1
You can list all brands related to your store directly from this endpoint. Also, it allows you to filter them using a keyword, the endpoint would return any brand 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 name
description
OAuth Scopes
brands.read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
keyword | string | A keyword to filter brands that match specific name. | |
page | number | The Pagination page number |
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
{"success":true,"status":200,"data":[{"id":1473353380,"name":"زارا","description":"زارا","banner":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","logo":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","ar_char":"ز","en_char":"z"},{"id":883017162,"name":"بربري","description":"بربري","banner":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","logo":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","ar_char":"ب","en_char":"b"}],"pagination":{"count":2,"total":2,"perPage":15,"currentPage":1,"totalPages":1,"links":[]}}