Brand Details

This endpoint allows you to return the complete details for a specific brand by passing the brand as a path parameter.

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 ********************

Path Params

brand

integer

required

Unique identifier assigned to the Brand. List of Brand IDs can be found here

Query Params

with

enum<string>

optional

Use with=translations to fetch list of brands with translations

Allowed value:

translations

Example:

translations

Responses

🟢200Success

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

object (Brand)

optional

Detailed structure of the brand model object showing its fields and data types.

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 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.

ar_char

string

required

Brand represented in Arabic characters.

en_char

string

required

Brand represented in English characters.

metadata

object

required

Example

{
  "status": 200,
  "success": true,
  "data": {
    "id": 510571718,
    "name": "hayat",
    "description": "Al Hayat Brand",
    "banner": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "logo": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "ar_char": "حياه",
    "en_char": "Hayat",
    "metadata": {
      "title": "Zara brand",
      "description": "Brand awareness seo",
      "url": "zara/item"
    }
  }
}

🟢200With translations

🟠404Record Not Found

🟠401Unauthorized

Request

Request samples

Responses