Submit Collection

Introduction

This document was designed for IT professionals as a technical document to communicate and understand the Collection 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.

Json Post URL

https://nservice.aramex.co.za/Json/JsonV1/SubmitCollection

Json Objects

ReceiveJson

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_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_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 or Estate name of where the receiver is located	No	50	string
receiver_country_code	Country code for the receiver address details	Yes	10	string
receiver_state	City or province for the receiver details	No	50	string
receiver_suburb	The suburb where the receiver is located	Yes	50	string
receiver_postal_code	The suburbs postal code for the receiver details, use the Postal code lookup API to vlidate the suburb and postal code	Yes	50	string
receiver_name	Business name for the receiver else use the receiver contact person in this field	Yes	50	string
receiver_contact_number	the mobile or telephone number used for the receiver. Mobile numbers are required for sms notifications	Yes	25	string
receiver_contact_person	The actual person receiver the shipment. Company name can be used	Yes	50	string
reference1	Senders reference	No	100	string
reference2	Additional reference for the sender	No	100	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
pickup_date	The date when the shipment needs to be collected yyyy-MM-dd	Yes	10	string
ready_time	The time when the driver can collect. The ready time must be 3 hours before submission HH:mm:ss	Yes	8	string
closing_time	The closing time of the business or person collecting from HH:mm:ss	Yes	8	string
comments	Comments	No	255	string
client_reference	Reference for the Client	No	255	string
is_postnet	Is Postnet	No	5	bool

Parcels

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.	No	10.2	decimal

ReturnJson

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
collection_reference	The collection reference if the collection was booked successfully	30	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

Json String Sample

ReceiveJson