Calculate shipping pricing from sender & receiver information.
POST /rates
Elements
Request
| Name | Type | Description |
|---|---|---|
| DepartureCountryCode | string | Sender country in ISO 3166-1 alpha-2. |
| DeparturePostcode | string | Sender postcode. |
| DepartureLocation | string | Sender location in International Air Transport Association (IATA) code. |
| ArrivalCountryCode | string | Receiver country in ISO 3166-1 alpha-2. |
| ArrivalPostcode | string | Receiver postcode. |
| ArrivalLocation | string | Receiver location in International Air Transport Association (IATA) code. |
| PaymentCurrencyCode | string | Rate currency in ISO 4217 3-Letter code. |
| WeightMeasure | string | Weight unit. KG,LBS |
| Weight | number ¹ | Weight value. |
| NumofItem | number ¹ | Number of items in parcel. Default:1 |
| ServiceType | string | Service type code. |
| DimensionUnit | string | Dimension unit. CM,INCH |
| CustomCurrencyCode | string | Customs currency in ISO 4217 3-Letter code. |
| CustomAmount | numeric ¹ | Customs value. |
| Items | Array of Items | Items details. |
Items
| Name | Type | Description |
|---|---|---|
| Weight | number ¹ | Weight value. |
| Length | number ¹ | Cubic length value in cm. |
| Width | number ¹ | Cubic width value in cm. |
| Height | number ¹ | Cubic height value in cm. |
| CubicWeight | number ¹ | Cubic weight value. |
Response
| Name | Type | Description |
|---|---|---|
| PricingResponseDetails | array of PricingResponseDetails | A list of pricing results. |
PricingResponseDetails
| Name | Type | Description |
|---|---|---|
| CurrencyCode | string | Rate currency in ISO 4217 3-Letter code. |
| ProductCode | string | Service type code. |
| BasicAmount | number | Base charge amount. |
| TaxAmount | number | Tax value. |
| FSAmount | number | Fuel-surcharge value. |
| TotalAmount | number | Total value. |
| ErorMessage | string | Error message (if any) returned from the rate request. |
| Others | array of Others | List of other charges. |
Others
| Name | Type | Description |
|---|---|---|
| ItemID | string | Unique ID of the charges. |
| ItemName | string | Charge name. |
| ItemValueType | string | Charge type. $, % |
| ItemRefCode | string | Charge reference. |
| ItemType | string | N/A |
| ItemValue | number | Charge value. |
| ItemOperator | string | Charge operator. +,- |
Reference
¹ Refer Notes section for required format.
Sample
Request
{
"DepartureCountryCode": "SG",
"DeparturePostcode": "208573",
"DepartureLocation": "SINGAPORE",
"ArrivalCountryCode": "MY",
"ArrivalPostcode": "53300",
"ArrivalLocation": "KUALA LUMPUR",
"PaymentCurrencyCode": "SGD",
"WeightMeasure": "KG",
"Weight": 3.5,
"NumofItem": "1",
"ServiceType": "ED",
"DimensionUnit": "CM",
"CustomCurrencyCode": "SGD",
"CustomAmount": 50.00,
"Items": [{
"Weight": 1,
"Length": 3,
"Width": 3,
"Height": 3,
"CubicWeight": 0
}, {
"Weight": 1.5,
"Length": 3,
"Width": 3,
"Height": 3,
"CubicWeight": 0
}]
}
Response
{
"PricingResponseDetails": [{
"CurrencyCode": "SGD",
"ProductCode": "ED",
"BasicAmount": 45.0,
"TaxAmount": 0.0,
"FSAmount": 0.0,
"TotalAmount": 45.0,
"ErorMessage": "",
"Others": [{
"ItemID": "5A1D798A5DDE13708C9C16CE9796C50C",
"ItemName": "Remote Charges",
"ItemValueType": "$",
"ItemRefCode": "Charge",
"ItemType": "",
"ItemValue": "30",
"ItemOperator": "+"
}]
}]
}