Skip to main content
POST
shipping.pickup-location.create

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

Exact pickup location name chosen by you.

Required string length: 1 - 120
address
object
required

Pickup contact and address.

returnAddress
object

Return address; defaults to pickup address.

service
string

Parcel or freight service.

Required string length: 1 - 100
billingAddress
object
workingHours
string

Warehouse working hours.

Required string length: 1 - 200
businessType
string

Warehouse business type.

Required string length: 1 - 100
boxCount
integer

Freight box count.

Required range: 1 <= x <= 10000
invoices
object[]

Freight invoice list.

Required array length: 1 - 100 elements
freightMode
enum<string>

Who pays freight.

Available options:
prepaid,
to-pay,
third-party
insurance
object

Explicit insurance request.

Response

The result

name
string
required

Your pickup location name.

Required string length: 1 - 120
state
string
required

Location registered.

Allowed value: "created"