Get Quotes for Shipment

Fetch available shipping quotes for a shipment

/rates/shipment/quotes

POST https://api.terminal.africa/v1/rates/shipment/quotes

This endpoint allows you to retrieve rates for a shipment. To return cash on delivery rates for carriers who supports cash-on-delivery, set cash_on_delivery to true

Headers

Name	Type	Description
Authorization*	string	Set value to Bearer SECRET_KEY
Content-Type*	string	Set value to application/json

Request Body

Name	Type	Description
pickup_address*	object	Pickup Address Object. Refer to Create Address under Addresses to see attributes required to create a pickup address
delivery_address*	object	Delivery Address Object. Refer to Create Address under Addresses to see attributes required to create a delivery address
carrier_id	string	Unique id for carrier. Include carrier_id to return rates for specific carrier
currency	string	Currency for rates. Defaults to NGN. Available options are AED, AUD, CAD, CNY, EUR, GBP, GHS, HKD, KES, NGN, TZS, UGX, USD, ZAR.
parcel*	object	Parcel Object. Refer to Create Parcel under Parcels API Endpoints to see attributes required. packaging_id not necessary in parcel object
cash_on_delivery	Boolean	Set to true to return cash on rates that supports cash on delivery.

200 Rates retrieved successfully.

{
	status: true,
	message: 'Rates retrieved successfully',
	data: [{
		amount: 14000,
		carrier_id: 'loYZh5J47D6gJUKOExXeO1RLcMARScLi',
		carrier_logo: 'https://ucarecdn.com/dcdd8109-af8c-4057-8104-192be821dd6e/download4.png',
		carrier_name: 'DHL Express',
		carrier_rate_description: 'EXPRESS 12:00 DOC',
		currency: 'NGN',
		delivery_time: 'Within 5 days.',
		id: 'bQVMwQZndHbIq6PQD5oiaGWxetLCXGkp',
		includes_insurance: false,
		insurance_coverage: 0,
		insurance_fee: 0,
		metadata: {},
		pickup_time: 'Tue Jul 13 2021 before 17:00 GMT',
		rate_id: 'RT-30798955894',
		shipment: 'RAl6LhWojcnJtlojLcw4XWgSpjBsjF38',
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'
	},{
		amount: 12500,
		carrier_id: 'hWiA1ZLw3SIr3VeCEbUKpjqVsijHrNjZ',
		carrier_logo: 'https://ucarecdn.com/c2d4dcb2-1483-47a5-ab14-447a990f5827/60dc7947195c0078fabff349_1200pxUnited_Parcel_Service_logo_2014svg.png',		
		carrier_name: 'United Parcel Services',
		carrier_rate_description: '',
		currency: 'NGN',
		delivery_time: 'Delivery within 1, 2, or 3 days based on where your package started and where it’s being sent.',		
		id: 'eDcN2a86N5OdWp3rzJLF2qoovG2BqLkC',
		includes_insurance: false,
		insurance_coverage: 0,
		insurance_fee: 0,
		metadata: {},
		pickup_time: 'Tue Jul 13 2021 before 17:00 GMT',
		rate_id: 'RT-97421991024',
		shipment: 'RAl6LhWojcnJtlojLcw4XWgSpjBsjF38',
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'
	},{
		amount: 11000,
		carrier_id: 'xOkhPcycBm75msJ8l6BU81vWRaA3p0tp',
		carrier_logo: 'https://ucarecdn.com/3273a236-bd33-4c37-9f87-2bcf4e59275f/6035307b31150075cabc780d_EeNJnpVz_400x400.jpg',
		carrier_name: 'Sendbox',
		carrier_rate_description: 'Standard Delivery',
		currency: 'NGN',
		delivery_time: 'Between 5 - 7 business days.',		
		id: 'A7c64epPiVyz2NZ5Cs3uNWuPznXUKFwj',
		includes_insurance: false,
		insurance_coverage: 0,
		insurance_fee: 0,
		metadata: {},	
		pickup_time: 'Between 12 - 24 hours',
		rate_id: 'RT-49826156746',
		shipment: 'RAl6LhWojcnJtlojLcw4XWgSpjBsjF38',	
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'
	}],
	pageData: {
    "total": 3,
    "perPage": 100,
    "page": 1,
    "pageCount": 1		
	}
}