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.

OAuth Scopes


brands.read

Request Params

KeyDatatypeRequiredDescription
keywordstringA keyword to filter brands that match specific name.
pagenumberThe Pagination page number

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

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":[]}}