Skip to main content
POST
shipping.services.lookup

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

Postal code.

Required string length: 1 - 20
country
string
required

Country.

Allowed value: "IN"
service
string

Parcel, heavy or freight service.

Required string length: 1 - 100
option
string

Service option.

Required string length: 1 - 100
packageType
string

Package type.

Required string length: 1 - 100
paymentType
enum<string>

Payment mode.

Available options:
prepaid,
cod
weightGrams
number

Weight in grams.

Required range: x <= 100000000
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

postalCode
string
required

Postal code.

Required string length: 1 - 20
country
string
required

Two-letter country code.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
serviceable
boolean
required

Whether the requested postal service is available.

services
object[]
required

Available services and published facts.

Maximum array length: 100