1. Create Shipment (Value-Based)

View as Markdown
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

Headers

X-API-KeystringOptional
Your shop's API key

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