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_4d8af01qw2"

Body

application/json
name
string
required

Token name for identification

Required string length: 1 - 100
Example:

"Warehouse integration"

scopes
enum<string>[]
required

Permission scopes for the token

Minimum array length: 1

Permission scope controlling access to a resource and action

Available options:
read:api_tokens,
write:api_tokens,
read:orgs,
write:orgs,
read:users,
write:users,
read:roles,
write:roles,
read:org_members,
write:org_members,
read:carriers,
write:carriers,
read:addresses,
write:addresses,
read:shipping_rules,
write:shipping_rules,
read:shipments,
write:shipments,
read:orders,
write:orders,
read:order_channels,
write:order_channels,
read:return_portals,
write:return_portals,
read:printers,
write:printers,
read:webhooks,
write:webhooks,
read:automations,
write:automations,
read:integrations,
write:integrations,
read:all,
write:all
Example:
expiresInDays
integer

Token expiry in days (optional, max 365)

Required range: 1 <= x <= 365
Example:

90

brandId
string | null

Restrict this token to a single brand. Requests made with it can only read and write that brand's data. Omit for organization-wide access.

Example:

"brnd_8f3kd92ld0"

Response

Default Response

id
string
required

Unique API token identifier

Example:

"tok_6e2fa83ij9"

name
string
required

Token name for identification

Example:

"Warehouse integration"

tokenPrefix
string
required

First 12 chars of the token for identification

Example:

"zipp_live_8f"

scopes
string[]
required

Permission scopes granted by the token

Example:
brandId
string | null
required

Brand this token is restricted to, or null for organization-wide access

Example:

"brnd_8f3kd92ld0"

lastUsedAt
string | null
required

Timestamp the token was last used (ISO 8601), null if never used

Example:

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

expiresAt
string | null
required

Expiry timestamp (ISO 8601), null if it never expires

Example:

"2026-09-20T14:30:00.000Z"

createdAt
string
required

Creation timestamp (ISO 8601)

Example:

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

token
string
required

Full API token (only shown once)

Example:

"zipp_live_8f3kd92ld0a7b6c5d4e3f2a1"