BackchannelDocs
🇺🇸 English🇧🇷 Português
Contact
System/Brands

Brands

The Brand object is the root of your multi-tenant hierarchy. Each brand manages its own inventory, fulfillment logic, and ERP endpoints.

Brand Hierarchy

A single Organization can have multiple Brands. Each Brand acts as an isolated sandbox for inventory and orders.

Organization
Brand A
Brand B

The Brand Object

Detailed reference for all fields in the brand entity.

Profile & Category

FieldTypeDescription
idRequired
string

Unique brand identifier. Prefixed with 'brand_'.

Example: brand_01JGK9
nameRequired
string

Official legal name of the business unit.

Example: Nike Brazil
slug
string

URL-friendly identifier for front-end routing.

Example: nike-brazil
category
enum

Business vertical: 'fashion', 'electronics', 'food'.

Example: fashion

ERP Configuration

FieldTypeDescription
erp_provider
enum

The type of backend system connected. Values: 'sap', 'linx', 'oracle', 'netsuite'.

Example: linx
erp_status
string

Current connectivity state: 'connected', 'degrading', 'disconnected'.

last_sync_at
datetime

ISO 8601 timestamp of the last successful master data push.

List Brands

GET /v1/brands

Paging Parameters

FieldTypeDescription
limit
integer

Number of records to return. Default 20, Max 100.

offset
integer

Number of brands to skip for pagination.

Create Brand

POST /v1/brands

Provision a new brand node. This will prepare the environment for SKU ingestion and order routing.

{
  "name": "Puma Heritage",
  "category": "Footwear",
  "erp_provider": "oracle",
  "metadata": {
    "region": "LATAM"
  }
}