This document was designed for IT professionals as a technical document to communicate and understand the Waybill Submission API
All decimal values must be based on the US format.
We suggest that you have a retry function in-case our services go down.
https://nservice.aramex.co.za/Json/JsonV1/SubmitWaybill
| 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_street_address | Street address for the sender | Yes | 50 | string |
| sender_business_park | Business park or Complex or Estate name of where the sender is located | No | 50 | string |
| sender_other_address | Additional line for the sender address details | No | 50 | string |
| sender_country_code | Country code for the sender address details | Yes | 10 | string |
| sender_country_name | Country name for the sender address details | No | 100 | string |
| sender_state | City or province for the sender details | No | 50 | string |
| sender_suburb | The suburb where the sender is located | Yes | 50 | string |
| sender_postal_code | The suburbs postal code for the sender details, use the Postal code lookup API to vlidate the suburb and postal code | Yes | 50 | string |
| sender_name | Business name for the sender else use the sender contact person in this field | Yes | 50 | string |
| sender_reference1 | Senders reference | No | 100 | string |
| sender_reference2 | Additional reference for the sender | No | 100 | string |
| sender_contact_number | the mobile or telephone number used for the sender. Mobile numbers are required for sms notifications | Yes | 25 | string |
| sender_contact_person | The actual person sending the shipment. Company name can be used | Yes | 50 | string |
| receiver_street_address | Receiver street address | Yes | 50 | string |
| receiver_business_park | Business Park or Complex name or Estate name for the receiver | No | 50 | string |
| receiver_other_address | Additional address field for the receiver | No | 50 | string |
| receiver_state | The city or province name for the receiver | No | 50 | string |
| receiver_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 suburbs postal code for the receiver. Use the Postal Code API for validation | Yes | 50 | string |
| receiver_name | The receivers business name. If sending to B2C then use the persons name who is receiving the shipment | Yes | 50 | string |
| receiver_reference1 | Reference for the receiver | No | 100 | string |
| receiver_reference2 | Additional reference for the receiver | No | 100 | string |
| receiver_contact_person | The name of the person receiving the shipment | Yes | 50 | string |
| receiver_contact_number | The mobile number for the person receiving the shipment | Yes | 25 | string |
| receiver_email_address | The email address for the person receiving the shipment. If not supplied, a default value of aramex@aramex.com will be inserted | No | 300 | 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 |
| waybill_print_template |
If you require Aramex to return the waybill in the response to print/ The response will provide a URL to download or print the PDF. The URL expires in 30 minutes. A4 waybills = 9202. Labels = 9201 Aramex South Africa have developed a new printing template which includes multiple piece labels. This template is designed for 4" x 6" labels. The response will provide a URL to print the waybills. It does not provide the labels as a PDF document. The new printing URL does not expire and will be valid for 3 years 4" x 6" Label = 1 If this is not required, please use 0 |
No | 10 | int |
| waybill_pdf_fetch_type | If you require Aramex to return the shipping label, then use URL in this field else leave empty | No | 10 | string |
| special_instructions | Special instructions if required | No | 100 | string |
| waybill_number | If you require to use your own waybill numbers. These numbers have to have a prefix to make your waybill numbers unique. Leave blank for Aramex to generate the waybill numbers | No | 30 | string |
| require_insurance |
If you require Aramex to insure your shipment. By default Aramex provides insurance up to the value of R3000.00. |
Yes | 5 | boolean |
| insurance_value | The insurance value for your shipment. require_insurance has to be set to true for the insurance value to take affect | Yes | 10.2 | decimal |
| is_import | If you are importing goods from another country | Yes | 5 | boolean |
| is_document | Specify if the shipment is documents | Yes | 5 | boolean |
| Field Name | Description | Mandatory | Field Length | Data Type |
|---|---|---|---|---|
| parcel_number | Parcel numbers to make the parcels uploaded unique | Yes | 35 | string |
| parcel_description | Description of goods, required if you are shipping internationally | No | 100 | string |
| 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 |
| waybill_number | The waybill number returned if no waybill number is supplied | 30 | string |
| label_print | The PDF url for the waybill if a waybill_print_template is supplied | 300 | string |
| 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 |
| commercial_invoice | The PDF url for the Commercial Invoice if commercial_invoice_required is true | 255 | string |