This document was designed for IT professionals as a technical document to communicate and understand the Rate Calculator API
All decimal values must be based on the US format.
This API must be called for each service type that you want to display rates for.
https://nservice.aramex.co.za/Json/JsonV1/GetRate
| Field Name | Description | Mandatory | Field Length | Data Type |
|---|---|---|---|---|
| email_address | Aramex.com email address used for authentication | Yes | 300 | string |
| password | Aramex.com password used for authentication | Yes | 300 | string |
| account_number | Your Aramex account number | Yes | 100 | string |
| sender_country_code | The country code for the sender | Yes | 10 | string |
| sender_country_name | The country name for the sender | No | 50 | string |
| sender_suburb | The suburb name for the sender | Yes | 50 | string |
| sender_postal_code | The suburb postal code for the sender. Please use the Postal Code API for validation | Yes | 10 | string |
| sender_country_code | The country code for the receiver | Yes | 10 | string |
| receiver_country_name | The country name for the receiver | No | 50 | string |
| receiver_suburb | The suburb name for the receiver | Yes | 50 | string |
| receiver_postal_code | The suburb postal code for the receiver. Please use the Postal Code API for validation | Yes | 10 | string |
| payment_type | P for account holders. 3 for Third party. Third party is used when the sender address is not the same as the account address | Yes | 10 | string |
| service_type |
For Domestic shipments SMP = Same day shipment EMD = Early morning delivery ONP = Overnight delivery PEC = Economy PEX = Road Express For International shipments PPX = Priority Parcel Express PDX = Priority Document Express |
Yes | 10 | string |
| is_documents | If the sender is shipping documents | Yes | 5 | boolean |
| require_insurance |
If you require Aramex to insure your shipment. By default Aramex provides insurance up to the value of R3000.00. If you require insurance, this will be calculated on your parcel value in the parcels array. |
Yes | 5 | boolean |
| Field Name | Description | Mandatory | Field Length | Data Type |
|---|---|---|---|---|
| weight | The weight of the parcel | Yes | 10.2 | decimal |
| length | The length of the parcel. Value must be in CM | Yes | 10.2 | decimal |
| width | The width of the parcel. Value must be in CM | Yes | 10.2 | decimal |
| height | The height of the parcel. Value must be in CM | Yes | 10.2 | decimal |
| quantity | The number of parcels of the same weight and dimensions | Yes | 3 | int |
| parcel_value | The value of the parcel, used for insurance | No | 10.2 | decimal |
| Field Name | Description | Field Length | Data Type |
|---|---|---|---|
| status_code | The status code for the transaction submitted. The status code will state if the transaction was successful or if it failed | 3 | int |
| status_description | The description associated with the status code | 255 | string |
| rate | The shipping charge including all charges and VAT | 10.2 | decimal |
| change_description | if changes were made to the suburb and postal code during the validation period, the changes will be returned in this field | 255 | string |
| expected_delivery_date | The expected delivery date. This is the date that your delivery should take place which caters for public holidays and weekends. | 10 | string |