Price method
POST /v3/Calculate
Uri parameters
None
Body parameters
Name | Description | Type | Additional description |
---|---|---|---|
Customernr | Schenker customer number | String | Required |
SenderZip | From zip code | String | Required |
ReceiverZip | To zip code | String | Required |
VolumeD3 | Parcel volume - use dm3 (cubic decimetres). At least one of the properties VolumeD3, weight, NumberOfLoadMeters or NumberOfPalletSpaces must be provided. If all is null you will get an error. | Int32 | |
Weight | Parcel weight. At least one of the properties weight, NumberOfLoadMeters, NumberOfPalletSpaces or VolumeD3 must be provided. If all is null you will get an error. | Int32 | |
PickupDate | When to pick up the shipment, e.g. 2019-01-24 | DateTime | |
UnitCode | Default: KL. Use if weight or volume is not used. Weight and NumberOfUnits must be provided together with UnitCode. Depending on custom customer agreements - you may use the special code. Special customer code: 51..99, Kolli: KL, Paller: PL | String | |
NumberOfUnits | Number of units. Default 1. | Int32 | |
NumberOfLoadMeters | Number of load meters. At least one of these properties, NumberOfLoadMeters, NumberOfPalletSpaces, weight or VolumeD3, must be provided. | Decimal | |
NumberOfPalletSpaces | Number of pallet spaces. At least one of these properties, NumberOfPalletSpaces, weight, NumberOfLoadMeters or VolumeD3, must be provided. | Int32 | |
ProductCode | Product code. Request the Product API for details of all alternatives. Examples: '43' (System), '44' (System premium) | String | Required |
Services | Service/option types, List of strings. Note, to send a list in the URL, repeat them. E.g: ?service=1&service=2. Request the Product API for details of all alternatives. Example: '16' (Pre-notice e-mail), '35' (Fix Day) | List`1 | |
Parcels | List of parcels in the shipment with weight, length, height and width. Providing this information will enable the API to provide more accurate pricing | Collection of ParcelModel | |
PaymentCode | Define who's paying for the transport. Default is sender. If you choose the recipient or other you need to add their customer nr. Notice that you also need access to the customer number. | PaymentCodeEnum |
Request body sample:
{ "Customernr": "sample string 1", "SenderZip": "sample string 2", "ReceiverZip": "sample string 3", "VolumeD3": 1, "Weight": 1, "PickupDate": "2024-11-21T11:19:21", "UnitCode": "sample string 7", "NumberOfUnits": 1, "NumberOfLoadMeters": 1.1, "NumberOfPalletSpaces": 1, "ProductCode": "sample string 11", "Services": [ "sample item string 1", "sample item string 2" ], "Parcels": [ { "weight": 1.1, "height": 1.1, "length": 1.1, "width": 1.1 } ], "PaymentCode": 1 }
Response sample:
{ "Freight": { "FreightCost": 1.1, "Details": [ { "Description": "sample string 1", "Cost": 1.1 } ] }, "Services": [ { "ServiceName": "sample string 1", "ServiceCode": "sample string 2", "ServiceCost": 1.1 } ], "Total": 1.1 }