> For the complete documentation index, see [llms.txt](https://eshop.gitbook.io/eshopbox-developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eshop.gitbook.io/eshopbox-developers/product/brands.md).

# Brands

A **brand** is the image and personality of a product or service that a business provides. A product's features, such as logos or slogans, make it unique and different.

## The `Brand` Object

{% tabs %}
{% tab title="Attributes" %}

| Attributes                 | Type                                                                    | Description                                                                                      |
| -------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `id`                       | `number`                                                                | Unique identification id for a brand                                                             |
| `brandName`                | `string`                                                                | Name of the brand                                                                                |
| `verticals`                | [`object`](/eshopbox-developers/product/brands.md#the-verticals-object) | Verticals object related to the brand                                                            |
| `accountId`                | `number`                                                                | Account id against which the brand is created                                                    |
| `brandCode`                | `string`                                                                | Unique code for every brand                                                                      |
| `brandStatus`              | [`string`](/eshopbox-developers/product/brands.md#enum-brandstatus)     | Status of brand `Enum : 0 , 1`                                                                   |
| `webSiteLink`              | `string`                                                                | Website link of the brand                                                                        |
| `brandLogoImage`           | `string`                                                                | Brand logo image url                                                                             |
| `tmRegistrationStatus`     | `string`                                                                | This defines the status of the TM(Trade Mark) certificate                                        |
| `tmCertificateScannedCopy` | `string`                                                                | Scanned copy of the TM certificate                                                               |
| `tAckNo`                   | `string`                                                                | The number assigned to the acknowledgment certificate when you apply for TM certificate          |
| `tmRegistrationNo`         | `string`                                                                | The TM certificate registration number                                                           |
| `tmRegistrationDate`       | `string`                                                                | The date on which you have applied for the TM certificate                                        |
| `tmAckCert`                | `string`                                                                | This is the acknowledgment certificate which proves that you have applied for the TM certificate |
| `createdAt`                | `string`                                                                | created timestamp of brand e.g: "2020-03-12 00:00:00"                                            |
| `updatedAt`                | `string`                                                                | updated timestamp of brand e.g: "2020-03-12 00:00:00"                                            |
| {% endtab %}               |                                                                         |                                                                                                  |

{% tab title="Sample Object" %}

```
{
     "id": "1",
            "brandName": "Kapas Kraft",
            "verticals": [
                {
                    "verticalId": "1",
                    "verticalName": "apparels",
                    "verticalCode": "apl",
                    "mainImage": "abc.jpg",
                    "hoverImage": "abc.jpg"
                },
                {
                    "verticalId": "2",
                    "verticalName": "footwear",
                    "verticalCode": "ftq",
                    "mainImage": "abc.jpg",
                    "hoverImage": "abc.jpg"
                }
            ],
            "accountId": "123",
            "brandCode": "ABC123",
            "brandStatus": "1",
            "webSiteLink": "http://Kapas Kraft",
            "brandLogoImage": "Kpas Kraft logo.jpg",
            "tmRegistrationStatus": "abc",
            "tmCertificateScannedCopy": "URL",
            "tAckNo": "1",
            "tmRegistrationNo": "123",
            "tmRegistrationDate": "2019-03-20 00:00:00",
            "tmAckCert": "URL",
            "createdAt": "2018-09-11T14:17:31.000+05:30",
            "updatedAt": "2018-09-14T19:11:38.000+05:30"
    }
```

{% endtab %}
{% endtabs %}

### The verticals object

| Attribute                  | Type     | Description                     |
| -------------------------- | -------- | ------------------------------- |
| `verticals[].verticalId`   | `number` | Unique id of the vertical       |
| `verticals[].verticalName` | `string` | Name of the vertical            |
| `verticals[].verticalCode` | `string` | Unique code of the vertical     |
| `verticals[].mainImage`    | `string` | Main image url of the vertical  |
| `verticals[].hoverImage`   | `string` | Hover image url of the vertical |

### Enum: brandStatus

| Attribute | Type     | Description           |
| --------- | -------- | --------------------- |
| `0`       | `string` | The brand is inactive |
| `1`       | `string` | The brand is active   |