Create brand

TypeScript

import { Configuration, BrandsApi } from "@zippendo/sdk"

const api = new BrandsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.createOrgBrand({ orgId: "...", createOrgBrandRequest: { /* ... */ } })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.BrandsApi(client).create_org_brand("...", zippendo.CreateOrgBrandRequest())

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\BrandsApi(new GuzzleHttp\Client(), $config);
$result = $api->createOrgBrand("...", new \Zippendo\Sdk\Model\CreateOrgBrandRequest([]));

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.BrandsAPI.CreateOrgBrand(ctx, "...").CreateOrgBrandRequest(*zippendo.NewCreateOrgBrandRequest()).Execute()

curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "companyName": "Acme ApS",
  "vatNumber": "DK12345678",
  "customs": {
    "eori": "DK12345678"
  },
  "addressLine1": "Vestergade 12",
  "addressLine2": "3. sal",
  "city": "København",
  "postalCode": "1456",
  "country": "DK",
  "primaryColor": "#1D4ED8",
  "secondaryColor": "#F59E0B",
  "slug": "acme",
  "useOrgCustoms": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme',
    companyName: 'Acme ApS',
    vatNumber: 'DK12345678',
    customs: {eori: 'DK12345678'},
    addressLine1: 'Vestergade 12',
    addressLine2: '3. sal',
    city: 'København',
    postalCode: '1456',
    country: 'DK',
    primaryColor: '#1D4ED8',
    secondaryColor: '#F59E0B',
    slug: 'acme',
    useOrgCustoms: true
  })
};

fetch('https://api.zippendo.com/orgs/{orgId}/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/brands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme\",\n  \"companyName\": \"Acme ApS\",\n  \"vatNumber\": \"DK12345678\",\n  \"customs\": {\n    \"eori\": \"DK12345678\"\n  },\n  \"addressLine1\": \"Vestergade 12\",\n  \"addressLine2\": \"3. sal\",\n  \"city\": \"København\",\n  \"postalCode\": \"1456\",\n  \"country\": \"DK\",\n  \"primaryColor\": \"#1D4ED8\",\n  \"secondaryColor\": \"#F59E0B\",\n  \"slug\": \"acme\",\n  \"useOrgCustoms\": true\n}")
  .asString();

{
  "id": "brnd_8f3kd92ld0",
  "orgId": "org_8f3kd92ld0",
  "name": "Acme",
  "slug": "acme",
  "useOrgCustoms": true,
  "logoUrl": "/orgs/org_1/brands/brnd_1/logo",
  "archivedAt": "2026-08-05T10:00:00.000Z",
  "createdAt": "2026-06-22T14:30:00.000Z",
  "updatedAt": "2026-06-22T14:30:00.000Z",
  "companyName": "Acme ApS",
  "vatNumber": "DK12345678",
  "customs": {
    "eori": "DK12345678"
  },
  "addressLine1": "Vestergade 12",
  "addressLine2": "3. sal",
  "city": "København",
  "postalCode": "1456",
  "country": "DK",
  "primaryColor": "#1D4ED8",
  "secondaryColor": "#F59E0B"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

POST

orgs

{orgId}

brands

TypeScript

import { Configuration, BrandsApi } from "@zippendo/sdk"

const api = new BrandsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.createOrgBrand({ orgId: "...", createOrgBrandRequest: { /* ... */ } })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.BrandsApi(client).create_org_brand("...", zippendo.CreateOrgBrandRequest())

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\BrandsApi(new GuzzleHttp\Client(), $config);
$result = $api->createOrgBrand("...", new \Zippendo\Sdk\Model\CreateOrgBrandRequest([]));

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.BrandsAPI.CreateOrgBrand(ctx, "...").CreateOrgBrandRequest(*zippendo.NewCreateOrgBrandRequest()).Execute()

curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "companyName": "Acme ApS",
  "vatNumber": "DK12345678",
  "customs": {
    "eori": "DK12345678"
  },
  "addressLine1": "Vestergade 12",
  "addressLine2": "3. sal",
  "city": "København",
  "postalCode": "1456",
  "country": "DK",
  "primaryColor": "#1D4ED8",
  "secondaryColor": "#F59E0B",
  "slug": "acme",
  "useOrgCustoms": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme',
    companyName: 'Acme ApS',
    vatNumber: 'DK12345678',
    customs: {eori: 'DK12345678'},
    addressLine1: 'Vestergade 12',
    addressLine2: '3. sal',
    city: 'København',
    postalCode: '1456',
    country: 'DK',
    primaryColor: '#1D4ED8',
    secondaryColor: '#F59E0B',
    slug: 'acme',
    useOrgCustoms: true
  })
};

fetch('https://api.zippendo.com/orgs/{orgId}/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/brands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme\",\n  \"companyName\": \"Acme ApS\",\n  \"vatNumber\": \"DK12345678\",\n  \"customs\": {\n    \"eori\": \"DK12345678\"\n  },\n  \"addressLine1\": \"Vestergade 12\",\n  \"addressLine2\": \"3. sal\",\n  \"city\": \"København\",\n  \"postalCode\": \"1456\",\n  \"country\": \"DK\",\n  \"primaryColor\": \"#1D4ED8\",\n  \"secondaryColor\": \"#F59E0B\",\n  \"slug\": \"acme\",\n  \"useOrgCustoms\": true\n}")
  .asString();

{
  "id": "brnd_8f3kd92ld0",
  "orgId": "org_8f3kd92ld0",
  "name": "Acme",
  "slug": "acme",
  "useOrgCustoms": true,
  "logoUrl": "/orgs/org_1/brands/brnd_1/logo",
  "archivedAt": "2026-08-05T10:00:00.000Z",
  "createdAt": "2026-06-22T14:30:00.000Z",
  "updatedAt": "2026-06-22T14:30:00.000Z",
  "companyName": "Acme ApS",
  "vatNumber": "DK12345678",
  "customs": {
    "eori": "DK12345678"
  },
  "addressLine1": "Vestergade 12",
  "addressLine2": "3. sal",
  "city": "København",
  "postalCode": "1456",
  "country": "DK",
  "primaryColor": "#1D4ED8",
  "secondaryColor": "#F59E0B"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

Authorizations

Authorization

string

header

required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId

string

required

Organization ID

Example:

"org_8f3kd92ld0"

Body

application/json

name

string

required

Brand display name

Required string length: 1 - 120

Example:

"Acme"

companyName

string | null

Legal entity name printed on this brand's documents

Maximum string length: 200

Example:

"Acme ApS"

vatNumber

string | null

VAT/tax ID for this brand's shipments and documents

Maximum string length: 40

Example:

"DK12345678"

customs

object | null

Customs identifiers keyed by type

Show child attributes

Example:

{ "eori": "DK12345678" }

addressLine1

string | null

Street address line 1

Maximum string length: 200

Example:

"Vestergade 12"

addressLine2

string | null

Street address line 2

Maximum string length: 200

Example:

"3. sal"

city

string | null

City

Maximum string length: 100

Example:

"København"

postalCode

string | null

Postal code

Maximum string length: 20

Example:

"1456"

country

string | null

Country (ISO 3166-1 alpha-2)

Required string length: 2

Example:

"DK"

primaryColor

string | null

Primary brand color — document title and table headers

Pattern: ^#[0-9a-fA-F]{6}$

Example:

"#1D4ED8"

secondaryColor

string | null

Secondary brand color — subtitle, section headings, totals accent

Pattern: ^#[0-9a-fA-F]{6}$

Example:

"#F59E0B"

slug

string

URL-safe identifier, unique within the org. Derived from the name when omitted.

Required string length: 2 - 60

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Example:

"acme"

useOrgCustoms

boolean

Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all.

Example:

true

Response

Default Response

string

required

Unique brand identifier

Example:

"brnd_8f3kd92ld0"

orgId

string

required

Owning organization

Example:

"org_8f3kd92ld0"

name

string

required

Brand display name

Example:

"Acme"

slug

string

required

URL-safe identifier, unique within the organization

Example:

"acme"

useOrgCustoms

boolean

required

Example:

true

logoUrl

string | null

required

Authenticated URL for the brand logo, or null when none is set

Example:

"/orgs/org_1/brands/brnd_1/logo"

archivedAt

string | null

required

When the brand was archived; null when active

Example:

"2026-08-05T10:00:00.000Z"

createdAt

string

required

Creation timestamp (ISO 8601)

Example:

"2026-06-22T14:30:00.000Z"

updatedAt

string

required

Last update timestamp (ISO 8601)

Example:

"2026-06-22T14:30:00.000Z"

companyName

string | null

Legal entity name printed on this brand's documents

Maximum string length: 200

Example:

"Acme ApS"

vatNumber

string | null

VAT/tax ID for this brand's shipments and documents

Maximum string length: 40

Example:

"DK12345678"

customs

object | null

Customs identifiers keyed by type

Show child attributes

Example:

{ "eori": "DK12345678" }

addressLine1

string | null

Street address line 1

Maximum string length: 200

Example:

"Vestergade 12"

addressLine2

string | null

Street address line 2

Maximum string length: 200

Example:

"3. sal"

city

string | null

City

Maximum string length: 100

Example:

"København"

postalCode

string | null

Postal code

Maximum string length: 20

Example:

"1456"

country

string | null

Country (ISO 3166-1 alpha-2)

Required string length: 2

Example:

"DK"

primaryColor

string | null

Primary brand color — document title and table headers

Pattern: ^#[0-9a-fA-F]{6}$

Example:

"#1D4ED8"

secondaryColor

string | null

Secondary brand color — subtitle, section headings, totals accent

Pattern: ^#[0-9a-fA-F]{6}$

Example:

"#F59E0B"

Overview

SDKs

MCP server

System

Tokens

Orgs

Brands

Addresses

Carriers

Rules

Quotes

Shipments

Orders

Order Channels

Carrier Catalog

Billing

Webhooks

Authorizations

Path Parameters

Body

Response