Skip to navigation

4. Create Shipment (Weight-Based)

View as Markdown

Creates a shipment priced by weight. amount should match the value returned by Calculate Pricing for this weight/route — the server may reject mismatched amounts.

Body parameters

FieldTypeRequiredDescription
senderNamestringYesPickup contact name
senderPhonestringYesE.164 format, e.g. +265991234567
senderCitystringYesPickup city
receiverNamestringYesDelivery contact name
receiverPhonestringYesE.164 format
receiverCitystringYesDelivery city
serviceTypestringYesstandard or express
declaredValuenumberYesValue of goods in MWK, for insurance purposes
amountnumberYesShipping cost in MWK, from Calculate Pricing
weightnumberYesPackage weight in kg
pricingTypestringYesMust be weight_based
descriptionstringYesOrder/contents description
ecommerceOrderIdstringYesYour platform’s order ID, for reconciliation
shopIdstringYesYour shop code, provided by Impala Courier

Authentication

X-API-Keystring
API Key authentication via header

Headers

X-API-KeystringOptional
Your shop's API key

Request

This endpoint expects an object.
amountintegerRequired
shopIdstringRequired
weightdoubleRequired
senderCitystringRequired
senderNamestringRequired
descriptionstringRequired
pricingTypestringRequired
senderPhonestringRequired
serviceTypestringRequired
receiverCitystringRequired
receiverNamestringRequired
declaredValueintegerRequired
receiverPhonestringRequired
ecommerceOrderIdstringRequired

Response

Created
dataobject
successboolean