Light Mode

List Brands

GET/brands

Last modified: 13 days ago

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

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Query Params

keyword

string

optional

A keyword to filter brands that match specific name.

page

integer

optional

The Pagination page number

with

enum<string>

optional

Use with=translations to fetch list of brands with translations

Allowed value:

translations

Example:

translations

Request samples

Responses

A successful call returns a payload that contains a current list of brands.(200)

With translations(200)

Unauthorized(401)

A successful call returns a payload that contains a current list of brands.

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

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.

success

boolean

optional

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.

data

$ref(#/definitions/1307297)[]

optional

#/definitions/1307297

optional

pagination

#/definitions/1307303

optional

{
  "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": "zara",
      "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": "burbery",
      "metadata": {
        "title": "Zara brand",
        "description": "Brand awareness seo",
        "url": "zara/item"
      }
    }
  ],
  "pagination": {
    "count": 2,
    "total": 2,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

Last modified: 13 days ago