Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Example:

"org_8f3kd92ld0"

brandId
string
required

Brand ID

Example:

"brnd_8f3kd92ld0"

Response

Default Response

id
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

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

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

Example:
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"