Request Shipping Quotes
Getting shipment quotes requires you making a post request to the shipment delivery quote endpoint ensure to pass the required header parameters and body parameters to get the appropriate response.
A sample payload to request shipment quotes
{
"origin_name": "Mrs. Hippo",
"origin_phone": "+2348170441446",
"origin_street": "Clayton St.",
"origin_city": "Ikorodu",
"origin_country": "NIGERIA",
"origin_country_code": "NG", -------->(Optional)
"origin_state": "Lagos",
"origin_state_code": "LOS", -------->(Optional)
"destination_name": "Brian",
"destination_phone": "+2348170441446",
"destination_street": "Drydock Ave Suite 610",
"destination_city": "Ikeja",
"destination_country": "NIGERIA",
"destination_country_code": "NG", -------->(Optional)
"destination_state": "Lagos",
"destination_state_code": "LOS", -------->(Optional)
"weight": "0.5",
"currency":"NGN",
"items": [
{
"name": "Test Brian Iyoha",
"quantity": "1",
"weight": "1",
"amount": "100",
"value": "120000"
}
]
}
Adding currency to the shipping quotes payload will return quotes in whatever currency that was passed.
Staging URL: Staging URL: https://sandbox.staging.sendbox.co/shipping/shipment_delivery_quote
https://live.sendbox.co/shipping/shipment_delivery_quoteThis gets shipping quotes
Request
Response
Name | Type | Description |
Authorization | String | Authorization-key |
Content-type | String | application/json |
Name | Type | Description |
origin_country | String | senders country |
origin_state | String | senders state |
origin_city | String | senders city |
destination_country | String | recipient country |
destination_state | String | recipient state |
destination_city | String | recipient city |
currency | String | shop currency |
weight | float | weight of package |
201: Created
Shipping quotes returns the different available couriers and their price rated for this particular shipment.
{
"credit_amount": null,
"payment_option": {
"code": null,
"name": null
},
"weight": 8.1,
"total_value": 0,
"destination_state_code": "LOS",
"min_quoted_fee": 1000,
"origin_state_code": "LOS",
"time_schedule_code": "anytime",
"incoming_option_code": "pickup",
"max_quoted_fee": 8783.775,
"delivery_priority_code": "next_day",
"accept_value_on_delivery": null,
"selected_rate": {
"discount": null,
"courier_id": 0,
"fee": null,
"name": null,
"courier": {
"name": null
},
"return_fee": null,
"actual_fee": null,
"fee_with_return": null,
"id": null
},
"origin_country_code": "NG",
"payment_options": [
{
"pk": "book_on_hold",
"brand": "wallet",
"code": "book_on_hold",
"mask": "Book on hold",
"friendly_brand": "You will be debited from your wallet"
}
],
"origin_city": "Ketu",
"total_quantity": 0,
"delivery_type_code": "last_mile",
"payment_option_code": null,
"destination_city": "zone 5",
"destination_country_code": "NG",
"recurrent_cards": [
{
"pk": "book_on_hold",
"brand": "wallet",
"mask": "Book on hold",
"id": null,
"friendly_brand": "You will be debited from your wallet"
}
],
"rates": [
{
"discount": null,
"courier_id": 3,
"fee": 1000,
"name": "Sixth Gear Logistics",
"courier": {
"name": "Sixth Gear Logistics"
},
"return_fee": 50,
"actual_fee": null,
"fee_with_return": 1050,
"id": "3_1000.0"
},
{
"discount": null,
"courier_id": 19,
"fee": 2200,
"name": "Parcel Line Logistics",
"courier": {
"name": "Parcel Line Logistics"
},
"return_fee": 50,
"actual_fee": null,
"fee_with_return": 2250,
"id": "19_2200.0"
},
{
"discount": null,
"courier_id": 20,
"fee": 1800,
"name": "CRS Logistics",
"courier": {
"name": "CRS Logistics"
},
"return_fee": 50,
"actual_fee": null,
"fee_with_return": 1850,
"id": "20_1800.0"
},
{
"discount": null,
"courier_id": 22,
"fee": 8783.775,
"name": "DHL",
"courier": {
"name": "DHL"
},
"return_fee": 0,
"actual_fee": null,
"fee_with_return": null,
"id": "22"
}
],
"selected_rate_id": null,
"use_selected_rate": null,
"vat": null
}
Rates in response is an array of available shipping services could be economy or standard.
Last modified 2mo ago