Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Example:

"org_01HZX9K2QF"

carrierId
string
required

Carrier ID

Example:

"carr_01HZX9K2QF"

Response

Default Response

id
string
required

Unique carrier identifier

Example:

"carr_01HZX9K2QF"

name
string
required

Carrier display name

Example:

"PostNord"

carrierSlug
string
required

Carrier slug identifier

Example:

"postnord"

config
object
required

Carrier configuration (required and optional fields)

Example:
orgId
string
required

Owning organization ID

Example:

"org_01HZX9K2QF"

brandId
string | null
required

Brand this record belongs to, or null when it is organization-wide

Example:

"brnd_8f3kd92ld0"

createdAt
string
required

Creation timestamp (ISO 8601)

Example:

"2026-06-22T09:00:00.000Z"

updatedAt
string
required

Last update timestamp (ISO 8601)

Example:

"2026-06-22T09:00:00.000Z"

Carrier logo URL

Example:

"https://cdn.zippendo.com/logos/postnord.svg"

brandColor
string

Carrier brand color (hex)

Example:

"#005BAA"

deprecated
boolean

Whether this integration is deprecated (still works, but discouraged)

Example:

true

deprecationMessage
string

Guidance shown alongside the deprecated tag (e.g. what to migrate to)

Example:

"The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration."

beta
boolean

Whether this integration is newly launched and still being verified in production

Example:

true

generatesCustomsDocuments
boolean

Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label.

Example:

true

generatesCommercialInvoice
boolean

Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents.

Example:

true