List Brands
GET
/brandsThis 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.
Request
A keyword to filter brands that match specific name.
The Pagination page number
Use with=translations
to fetch list of brands with translations
Request samples
Responses
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
A unique identifier assigned to a specific brand.
The label given to a particular company, to identify its products in the market. 🌐 Support multi-language
A brief summary of a manufacturer or company, highlighting key attributes, values, and offerings to convey its identity and purpose. 🌐 Support multi-language
A text or URL linking to a banner file, used as a visual identifier for a brand on a webpage or platform.
A text-based representation or URL link that directs to the logo file, used as a visual symbol to identify and represent a brand on a webpage or platform.
Brand represented in Arabic character
Brand represented in English character
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"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",
"metadata": {
"title": "Zara brand",
"description": "Brand awareness seo",
"url": "zara/item"
}
},
{
"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",
"metadata": {
"title": "Zara brand",
"description": "Brand awareness seo",
"url": "zara/item"
}
}
],
"pagination": {
"count": 2,
"total": 2,
"perPage": 15,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}