Create Brand

Production

POST

https://api.salla.dev/admin/v2/brands

Brands

Last modified:2024-12-29 06:40:32

This endpoint allows you to create a new brand in the store

Scopes

brands.read_write- Brands Read & Write

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Header Params

Content-Type

string

optional

multipart/form-data

Body Params application/json

name

string

required

The unique name or label associated with a specific company, manufacturer, or producer of products or services. 🌐 Support multi-language

logo

string <binary>

required

Brand logo (string or file) is the visual representation of a brand, either in the form of an image or a file, with recommended dimensions typically set at 100x80** pixels

banner

string <binary>

optional

A text-based representation or URL link that directs to an image file, used as a visual symbol to identify and represent a brand on a webpage or platform.

description

string

optional

Brand description is a brief overview that highlights key attributes, values, and qualities associated with a particular manufacturer or company, providing insights into its identity and offerings. 🌐 Support multi-language

metadata_title

string

optional

Metadata Title which is a concise label used to optimize search engine results and enhance the visibility of a Brand page. 🌐Support multi-language

metadata_description

string

optional

SEO Metadata Description:Concise content enhancing search visibility and social sharing. 🌐 Support multi-language

metadata_url

string

optional

SEO Metadata URL: Web link for enhanced search engine visibility and social media sharing. 🌐 Support multi-language

translations

object

optional

Brand translations are based on the store's enabled language locale. For instance, if the store supports both Arabic and English, the translations object will return two entries: ar for Arabic and en for English.

object

required

Example

{
    "name": "ابل",
    "logo": "",
    "banner": "",
    "description": "شركه ابل",
    "metadata_title": "ابل",
    "metadata_description": "شركه ابل",
    "metadata_url": "apple",
    "translations": {
        "en": {
            "name": "Apple",
            "description": "Apple brand",
            "metadata_title": "Apple",
            "metadata_description": "Apple brand",
            "metadata_url": "apple",
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.salla.dev/admin/v2/brands' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "ابل",
    "logo": "",
    "banner": "",
    "description": "شركه ابل",
    "metadata_title": "ابل",
    "metadata_description": "شركه ابل",
    "metadata_url": "apple",
    "translations": {
        "en": {
            "name": "Apple",
            "description": "Apple brand",
            "metadata_title": "Apple",
            "metadata_description": "Apple brand",
            "metadata_url": "apple",
        }
    }
}'

Responses

🟢201New brand created successfully.

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": 201,
  "success": true,
  "data": {
    "id": 1283560901,
    "name": "salamaBrand",
    "description": "Al Salama Brand",
    "banner": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "logo": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "ar_char": "س",
    "en_char": "s",
    "metadata": {
      "title": "Zara brand",
      "description": "Brand awareness seo",
      "url": "zara/item"
    }
  }
}

🟠422Error Validation

🟠401Unauthorized

Modified at 2024-12-29 06:40:32

Brands

List Brands