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"

Response

Default Response

name
string
required

Display name of the carrier

Example:

"PostNord"

slug
string
required

Unique carrier slug identifier

Example:

"postnord"

group
string

Carrier group or family name

Example:

"Nordic"

description
string

Short description of the carrier

Example:

"Nordic postal and parcel carrier"

URL to the carrier logo image

Example:

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

brandColor
string

Carrier brand color (hex)

Example:

"#0072CE"

learnMoreUrl
string<uri>

URL with more information about the carrier

Example:

"https://www.postnord.dk"

requiredFields
object[]

Configuration fields that must be provided to connect the carrier

optionalFields
object[]

Optional configuration fields for the carrier

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