Skip to main content
POST
shipping.label.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
trackingNumber
string
required

Carrier tracking number, 4 to 100 letters, digits or . _ / -.

Required string length: 4 - 100
Pattern: ^[A-Za-z0-9._/-]+$
format
enum<string>
default:pdf

Label format.

Available options:
pdf

Response

The result

file
object
required

Document copied to your private file storage.

notCreatedIds
string[]
required

Requested record IDs whose documents were not created.

Maximum array length: 100

Record ID in your connected shipping account.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._-]+$