Skip to main content
POST
shipping.serviceability.check

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

Pickup postal code in India.

Required string length: 1 - 6
Pattern: ^[0-9]{6}$
deliveryPostalCode
string
required

Delivery postal code in India.

Required string length: 1 - 6
Pattern: ^[0-9]{6}$
parcel
object
cashOnDelivery
boolean

Whether payment is collected on delivery.

orderId
string

Record ID in your connected shipping account.

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

Amount in INR, with at most two decimal places.

Required range: 0 <= x <= 10000000Must be a multiple of 0.01
mode
enum<string>

Transport mode filter.

Available options:
air,
surface
isReturn
boolean
default:false

Return shipment; requires declaredValue.

documentOnly
boolean
default:false

Show document carriers only.

localOnly
boolean
default:false

Show local carriers only.

qualityCheck
boolean
default:false

Require return quality checks.

Response

The result

results
object[]
required

Available carrier services and INR quotes; prices are not locked.

Maximum array length: 50