Brands
Manage product brands.
Base URL: /api/v1/partner/brands
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| POST | / | Create Brand |
| PUT | /{brandId} | Update Brand |
| DELETE | /{brandId} | Delete Brand |
Create Brand
POST /api/v1/partner/brands
Create a new brand. Send a BrandAddRequest in the request body with the brand details.
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Name |
active | boolean | No | Whether active |
website | string | No | Website URL |
phoneNo | string | No | Phone number |
brandLogo | CompanyAsset | No | Brand Logo |
vendorList | string[] | No | Vendor List |
platformBrandId | string | No | Platform Brand identifier |
externalId | string | No | External system identifier |
leadTime | long | No | Lead timestamp (epoch ms) |
minDaysOnHand | long | No | Min Days On Hand |
maxDaysOnHand | long | No | Max Days On Hand |
{
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"brandLogo": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"vendorList": [],
"platformBrandId": "abc123",
"externalId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
}
Response
Returns a Brand object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
name | string | No | Name |
active | boolean | No | Whether active |
website | string | No | Website URL |
phoneNo | string | No | Phone number |
brandLogo | CompanyAsset | No | Brand Logo |
vendorList | string[] | No | Vendor List |
isDefault | boolean | No | Is Default |
externalId | string | No | External system identifier |
platformBrandId | string | No | Platform Brand identifier |
globalBrandId | string | No | Global Brand identifier |
leadTime | long | No | Lead timestamp (epoch ms) |
minDaysOnHand | long | No | Min Days On Hand |
maxDaysOnHand | long | No | Max Days On Hand |
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"brandLogo": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
}
Update Brand
PUT /api/v1/partner/brands/{brandId}
Update an existing brand by ID. Send the full Brand object in the request body.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
brandId | string | The brand i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
name | string | No | Name |
active | boolean | No | Whether active |
website | string | No | Website URL |
phoneNo | string | No | Phone number |
brandLogo | CompanyAsset | No | Brand Logo |
vendorList | string[] | No | Vendor List |
isDefault | boolean | No | Is Default |
externalId | string | No | External system identifier |
platformBrandId | string | No | Platform Brand identifier |
globalBrandId | string | No | Global Brand identifier |
leadTime | long | No | Lead timestamp (epoch ms) |
minDaysOnHand | long | No | Min Days On Hand |
maxDaysOnHand | long | No | Max Days On Hand |
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"brandLogo": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
}
Response
Returns a Brand object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
name | string | No | Name |
active | boolean | No | Whether active |
website | string | No | Website URL |
phoneNo | string | No | Phone number |
brandLogo | CompanyAsset | No | Brand Logo |
vendorList | string[] | No | Vendor List |
isDefault | boolean | No | Is Default |
externalId | string | No | External system identifier |
platformBrandId | string | No | Platform Brand identifier |
globalBrandId | string | No | Global Brand identifier |
leadTime | long | No | Lead timestamp (epoch ms) |
minDaysOnHand | long | No | Min Days On Hand |
maxDaysOnHand | long | No | Max Days On Hand |
{
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"active": false,
"website": "https://example.com",
"phoneNo": "555-0100",
"brandLogo": {
"id": "abc123",
"companyId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"name": "string",
"key": "string",
"type": {},
"publicURL": "string",
"active": false,
"priority": 0,
"secured": true,
"thumbURL": "string",
"mediumURL": "string",
"largeURL": "string",
"largeX2URL": "string",
"origURL": "string",
"platformFileUrl": "string"
},
"vendorList": [],
"isDefault": false,
"externalId": "abc123",
"platformBrandId": "abc123",
"globalBrandId": "abc123",
"leadTime": 1704067200000,
"minDaysOnHand": 0,
"maxDaysOnHand": 0
}
Delete Brand
DELETE /api/v1/partner/brands/{brandId}
Delete a brand by its ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
brandId | string | The brand i d |