Skip to main content
POST
shipping.booking.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
sender
object
required

Sender contact and address, supplied for transport.

recipient
object
required

Recipient contact and address; for a return this is the pickup person.

pickupLocation
string
required

Exact name of your registered pickup location.

Required string length: 1 - 120
orderNumber
string
required

Your unique order number; carrier uses it to prevent duplicate bookings.

Required string length: 1 - 100
packages
object[]
required

One to 100 physical packages; multiple packages are one linked order.

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

Shipment payment type.

Available options:
prepaid,
cod
direction
enum<string>
required

Transport direction.

Available options:
forward,
return,
replacement
returnAddress
object

Return or reverse delivery address.

items
object[]

Order contents.

Required array length: 1 - 100 elements
invoice
object
collectAmount
object

Cash to collect, separate from the API fee.

declaredValue
object

Declared shipment value.

service
string

Requested delivery service.

Required string length: 1 - 100
trackingNumber
string

Printed shipment tracking number in your own carrier account.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9-]+$
qualityCheck
object
deliveryOptions
object
customs
object

International and customs facts.

label
object

Optional label generated with booking.

schedulePickup
object

Optional pickup scheduled with booking.

originalTrackingNumber
string

Printed shipment tracking number in your own carrier account.

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

Printed shipment tracking number in your own carrier account.

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

Reason for return.

Required string length: 1 - 200
payToCustomer
object
billTo
object

Third party billing contact.

billingReference
string

Your billing reference.

Required string length: 1 - 200
creditReference
string

Your credit reference.

Required string length: 1 - 200
vendorCode
string

Your sender vendor code.

Required string length: 1 - 200
marketplaceName
string

Marketplace name.

Required string length: 1 - 200
chequePayment
boolean

Cheque collection requested.

chequePayee
string

Cheque payee.

Required string length: 1 - 200
chequePayableAt
string

Cheque payment location.

Required string length: 1 - 200
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

trackingNumber
string
required

Printed shipment tracking number in your own carrier account.

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

Your order number.

Required string length: 1 - 100
state
string
required

Shipment booked for transport.

Allowed value: "booked"
packages
object[]

Linked package tracking numbers.

Maximum array length: 100
label
object

Requested label file.

pickupState
enum<string>

Optional pickup result.

Available options:
accepted,
pending,
failed