List Brands

GET {{baseUrl}}/brands?keyword=<string>&page=<integer>

This endpoint allows you to 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.

brands.read- Brands Read Only

Request Params

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

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cnumber\u003e&quot;,&quot;success&quot;:&quot;\u003cboolean\u003e&quot;,&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;banner&quot;:&quot;\u003cstring\u003e&quot;,&quot;logo&quot;:&quot;\u003cstring\u003e&quot;,&quot;ar_char&quot;:&quot;\u003cstring\u003e&quot;,&quot;en_char&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;banner&quot;:&quot;\u003cstring\u003e&quot;,&quot;logo&quot;:&quot;\u003cstring\u003e&quot;,&quot;ar_char&quot;:&quot;\u003cstring\u003e&quot;,&quot;en_char&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;}}],&quot;pagination&quot;:{&quot;count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total&quot;:&quot;\u003cnumber\u003e&quot;,&quot;perPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currentPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;totalPages&quot;:&quot;\u003cnumber\u003e&quot;,&quot;links&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}