API Reference / BrandService
BrandService
GetBrand
Request
| Field | Type | Validation | Description |
|---|---|---|---|
| id | string | min_len: 1 | ULID of the resource |
Response
| Field | Type | Description |
|---|---|---|
| brand | Brand |
UpdateBrand
Request
| Field | Type | Validation | Description |
|---|---|---|---|
| id | string | min_len: 1 | ULID of the resource |
| name | string | min_len: 1 | |
| logo_url | string | — | |
| description | string | — |
Response
| Field | Type | Description |
|---|---|---|
| brand | Brand |
ListBrandsByAccountID
Request
| Field | Type | Validation | Description |
|---|---|---|---|
| account_id | string | min_len: 1 |
Response
| Field | Type | Description |
|---|---|---|
| brands | Brand[] |
Messages
Brand
| Field | Type | Description |
|---|---|---|
| id | string | ULID of the resource |
| brand_type | BrandType | |
| name | string | |
| logo_url | string | |
| description | string | |
| created_at | timestamp | |
| updated_at | timestamp |
Enums
BrandType
| Name | Number |
|---|---|
| BRAND_TYPE_UNSPECIFIED | 0 |
| BRAND_TYPE_CPG | 1 |
| BRAND_TYPE_RETAIL | 2 |
| BRAND_TYPE_RESTAURANT | 3 |