Skip to main content
POST
shipping.pickup.book

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
pickupLocation
string
required

Name of a saved pickup location in your account.

Required string length: 1 - 36
pickupDate
string<date>
required

Calendar date, YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
parcelCount
integer
required

Number of parcels to collect.

Required range: 1 <= x <= 100
trackingNumbers
string[]

Assigned tracking numbers; some accounts require these.

Required array length: 1 - 100 elements

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

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

Response

The result

accepted
boolean
required

Pickup request accepted; collection is not guaranteed.

pickupDate
string

Scheduled pickup date when supplied.

Required string length: 1 - 40