Get Shipment Rates
Explore over 30 shipment rates across different shipment routes (intrastate, interstate and international)
Payload Description
Here's the documentation for the payload in a tabular form:
Field
Type
Required
Validation Rules
Description
type
String
Yes
Must be one of interstate, intrastate, international_us, frozen-international, international
The type of shipment.
toAddress.name
String
Yes
Max length: 255
Recipient's name.
toAddress.email
String
Yes
Must be a valid email address, Max length: 255
Recipient's email.
toAddress.address
String
Yes
Max length: 255
Recipient's address.
toAddress.phone
String
Yes
Must match the regex: ^\d{11}$ (11 digits)
Recipient's phone number.
fromAddress.name
String
Yes
Max length: 255
Sender's name.
fromAddress.email
String
Yes
Must be a valid email address, Max length: 255
Sender's email.
fromAddress.address
String
Yes
Max length: 255
Sender's address.
fromAddress.phone
String
Yes
Must match the regex: ^\d{11}$ (11 digits)
Sender's phone number.
parcels.width
Numeric
Yes
Must be a number, Minimum value: 1
Parcel width.
parcels.length
Numeric
Yes
Must be a number, Minimum value: 1
Parcel length.
parcels.height
Numeric
Yes
Must be a number, Minimum value: 1
Parcel height.
parcels.weight
Numeric
Yes
Must be a number, Minimum value: 0.01
Parcel weight.
items
Array
Yes
Must be an array, Minimum of 1 item
List of items.
items.*.name
String
Yes
Max length: 255
Item name.
items.*.description
String
No
Optional
Item description.
items.*.weight
Numeric
Yes
Must be a number, Minimum value: 0.01
Item weight.
items.*.category
String
Yes
Max length: 255
Item category.
items.*.amount
Numeric
Yes
Must be a number, Minimum value: 500
Item amount (price).
items.*.quantity
Integer
Yes
Must be an integer, Minimum value: 1
Item quantity.
items.*.hscode.code
String
Yes, If type is international
Must be a size 6 integer/codee
Notes:
The phone fields for both the
toAddressandfromAddressmust contain exactly 11 digits, enforced by a regular expression.Parcel dimensions (width, length, height) and weight must be numeric, with weight having a minimum value of
0.01.Items require at least one entry in the array, and each item has specific validations for its name, description, weight, category, amount (minimum 500), and quantity (minimum 1).
interstate: Shipping between different states within the same country.
intrastate: Shipping within a single state.
international_us: Shipping within the United States.
international: Shipping between different countries.
frozen-international: Shipping frozen items (e.g., foodstuffs) internationally. Supported countries include shipping from Nigeria to the US, Canada, and the UK.
Request Sample
curl --location 'https://delivery-staging.apiideraos.com/api/v2/token/tariffs/allprice' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Secret Key' \
--data-raw '{
"type": "intrastate",
"toAddress": {
"name": "hey mary",
"email": "[email protected]",
"address": "Lekki phase 1, Lekki, Nigeria",
"phone": "09012344467"
},
"fromAddress": {
"name": "mary john",
"email": "[email protected]",
"address": "Victoria island, Lagos, Nigeria",
"phone": "09123456789"
},
"parcels": {
"width": 32.5,
"length": 32.5,
"height": 32.5,
"weight": "2"
},
"items": [
{
"name": "item 1",
"description": "item 1",
"weight": "506.0",
"category": "beauty",
"amount": "46000000.0",
"quantity": "23"
}
]
}'Response Sample
{
"status": false,
"message": "The to address.phone format is invalid., The from address.phone format is invalid., The parcels.weight must be at least 0.01."
}Last updated