List Brands

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.

Scopes

brands.read- Brands Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

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

Responses

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

application/json

Body

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

array[object (Brand) {8}]

optional

number

required

A unique identifier assigned to a specific brand.

name

string

required

The label given to a particular company, to identify its products in the market. 🌐 Support multi-language

description

string

required

A brief summary of a manufacturer or company, highlighting key attributes, values, and offerings to convey its identity and purpose. 🌐 Support multi-language

banner

string

required

A text or URL linking to a banner file, used as a visual identifier for a brand on a webpage or platform.

logo

string

required

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.

ar_char

string

required

Brand represented in Arabic character

en_char

string

required

Brand represented in English character

metadata

object

required

pagination

object (Pagination)

optional

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.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

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

🟢200With translations

🟠401Unauthorized

Request

Request samples

Responses