Create Shipment (Value-Based) | Impala Courier

curl -X POST https://api.impala-courier.com/api/public/shipments#postApiPublicShipments2 \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "amount": 15000,
  "shopId": "{{shopCode}}",
  "senderCity": "Blantyre",
  "senderName": "John Doe",
  "description": "Order #12346 - Electronics",
  "pricingType": "value_based",
  "senderPhone": "+265991234567",
  "serviceType": "express",
  "receiverCity": "Lilongwe",
  "receiverName": "Jane Smith",
  "declaredValue": 50000,
  "receiverPhone": "+265987654321",
  "pricingItemIds": [
    1,
    2
  ],
  "ecommerceOrderId": "SHOP-12346"
}'

Creates a shipment priced by declared value/item tier instead of weight. Use pricingItemIds from Get Pricing Items instead of a weight field.

Body parameters (differences from weight-based)

Field	Type	Required	Description
pricingType	string	Yes	Must be `value_based`
pricingItemIds	array of numbers	Yes	IDs from Get Pricing Items, replaces `weight`

All other fields (sender/receiver info, serviceType, declaredValue, amount, description, ecommerceOrderId, shopId) are the same as the weight-based endpoint.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

amountintegerRequired

shopIdstringRequired

senderCitystringRequired

senderNamestringRequired

descriptionstringRequired

pricingTypestringRequired

senderPhonestringRequired

serviceTypestringRequired

receiverCitystringRequired

receiverNamestringRequired

declaredValueintegerRequired

receiverPhonestringRequired

pricingItemIdslist of integersRequired

ecommerceOrderIdstringRequired

Response

Created

dataobject

successboolean

5. Create Shipment (Value-Based)

Authentication

Headers

Request

Response