When to use this. Brands are the primary way to separate product data, certificates, and
workflows for different labels within one organisation. At least one brand must exist before
you can create styles or items. Use these endpoints to create brands, update their details,
change their lifecycle state, and delete brands that are no longer needed.
The workflow
A brand is a designer-organisation-level record. The usual path is to create the brand, then create seasons and styles that reference it. Brands can be deactivated when a label is retired (styles on existing records are preserved) or deleted when they have never been used.1
Create the brand
POST /api/brands with the brand name and optional address, country, and user-defined ID.
New brands default to the Active state.2
Create styles or items in it
POST /api/styles and POST /api/items both require a brand — a style or item cannot be
created without one. The brand ID from the create response is the value to pass.3
Find brands
GET /api/brands with filters (name, state, city, country, user-defined ID) to look brands
up later or validate an integration’s data.4
Retire or delete the brand
PUT /api/brands/{id} with state: "Inactive" to deactivate — inactive brands can no
longer be selected on new styles or items but remain visible on existing ones.
DELETE /api/brands/{id} for brands that were never attached to any style or item.Walkthrough
Create a new brand for a label based in Copenhagen. The brand starts in theActive state by
default.
id — styles and
items reference brands by it.
Field reference
Roles & permissions
Managing brands requires thebrands permission on a designer (brand) account —
typically CompanyAdmin. Supplier accounts collaborate on styles and items but do not manage
a brand’s configuration.
At least one active brand must exist in your organisation before styles or items can be
created. Creating the first brand is therefore usually the first admin step when onboarding a
new organisation.
When things go wrong
Errors use the standard envelope (status: "error", a code, and error.details[]). See
Errors & responses for the full list of codes and how to resolve them.
Common cases specific to brands:
- 404
resource_error.brand_not_found— The brand ID does not exist or belongs to a different organisation. - 409 conflict — Attempting to delete a brand that is assigned to one or more styles or
items. Set it to
Inactiveinstead. - 400
validation_error.required_field—namewas missing from a create or update request.
What to call next
Seasons
Create the seasons your styles will be filed under — a style requires both a brand and a
season.
Style categories
Define style categories to organise your styles within a brand.
Size ranges
Set up size ranges that styles and items use within the brand.
Colors
Build the reusable colour library that styles and items reference as colourways.