Collection Document (Type 40)

Data Interchange GUIDE

Shipment Pickup Request Document (type 73)

The Shipment Pickup Request document is used to store data for a collection along with its shipments and details. Transmission of this type of document corresponds to the manual submitting of a Collection and shipment records inside Aramex system.

The format of this document is in standard xml and it is made up of two main nodes within the “InfoLinkDocument” root node, namely:

AccessRequest: this contains header information for the transmission. Each document can have only one AccessRequest node.

Collection: this contains the collections details for each collection being transmitted, in addition to the HAWB elements. Each document can include as many Collection nodes as needed.

CollectionDetails: this contains the collection details within the collection. Each document can include as many CollectionDetails nodes (under the Collection node) as needed.

CollectionDetail: this contains the shipments summary within the collection. Each document can include as many CollectionDetail nodes (under the CollectionDetails node) as needed.

HAWB: this contains the HAWBs information within the request. Each document can have as many HAWBs nodes (under the Collection node) as needed.

HAWBItem: this contains the HAWBs description within the collection. Each document can include as many HAWBItem nodes (under the HAWB node) as needed.

The hierarchy of this document can be represented as follows:

AccessRequest Element 1>

AccessRequest Element 2>

< …>

AccessRequest Element n>

</AccessRequest>

Collection1 Element 1>

Collection1 Element 2>

< …>

Collection1 Element n>

<CollectionDetail1 Element 1>

< …>

<CollectionDetail1 Element n>

</CollectionDetail>

< …>

</CollectionDetails>

<HAWB>

<…>

<…>

</itemsDescription>

</HAWBItem>

< …>

</HAWB>

<…>

</Collection>

<…>

</InfoLinkDocument>

Collection Document Structure

Shipment Pickup Request Document Elements: Access Request

This section of the Shipment Pickup Request document contains header information for the data transmission batch. The following table describes each of the elements within the Access Request.

Element / Data Type / Required / Length / Allowed Values / Description
DocumentType / Integer / Y / 2 / 72 / Type of document being transmitted.
Always 73 for Shipment Pickup Request Document.
EntityID / Alphanumeric / Y / 6 / Identification Code/Number for Transmitting Party. This code should be provided to you by Aramex as part of setting you up as a transmitting party.
EntityPIN / Alphanumeric / N / 6 / Identification Pin Number for Transmitting Party. This code should be provided to you by Aramex as part of setting you up as a transmitting party (Expected to be empty for the files received from customers)
TimeStamp / DateTime / Y / 19 / Transmission Date & Time in the local time of transmitting party.
FORMAT:
YYYY-MM-DDTHH:NN:SS
For example the date/time of September 23rd 2006 09:45pm is represented as:
2006-09-23T21:45:00
Reference1 / Alphanumeric / Y / 50 / Reference field may be used to track Access Request or provide additional header information ( customer GUID expected in this reference from Customers. The GUID will be provided by ARAMEX)
Reference2 / Alphanumeric / N / 50 / Reference field may be used to track Access Request or provide additional header information. (Same value is returned back in the response in the same node)
Reference3 / Alphanumeric / N / 50 / Reference field may be used to track Access Request or provide additional header information.
Reference4 / Alphanumeric / N / 50 / Reference field may be used to track Access Request or provide additional header information.
Reference5 / Alphanumeric / N / 50 / Reference field may be used to track Access Request or provide additional header information.
ReplyEmailAddress / Alphanumeric / Y / 255 / Email Address (es) used by Aramex InfoLink to notify transmitting party of Transmission Response (Success or Failure and Errors Encountered). Separate by semi-colon (;) when using multiple e-mails addresses.
NotifyOnSuccess / Integer / Y / 1 / 0,
1 / AramexInfoLink will always notify transmitting party of Failure and Errors encountered in document transmission.
Use 0 to only be notified on transmission failure.
Use 1 to be notified on both transmission success and failure.

Shipment Pickup REQUEST DOCUMENT Elements: Collection

This section of the Shipment Pickup Request document contains details of each pickup request within the document. The following table describes each of the elements within the Collection node.

Element / Data Type / Required / Length / Allowed Values / Description
Entity / Alphanumeric / Y / 3 / Identification Code/Number for Station.
Note: either station 3-letter code or entity ID number may be used here. This should be a valid Station Code/Number as provided by ARAMEX.
AccEntity / Alphanumeric / Y / 3 / Identification Code/Number for Customer Account Station.
Note: either station 3-letter code or entity ID number may be used here. This should be a valid Station Code/Number as provided by ARAMEX.
PlacedDate / DateTime / Y / 19 / Collection placed date and time.
FORMAT:
YYYY-MM-DDTHH:NN:SS
Contact / Alphanumeric / Y / 255 / Contact person.
Address / Alphanumeric / Y / 1024 / Pickup address
Address2 / Alphanumeric / N / 1024 / Additional information about the address.
City / Alphanumeric / Y / 255 / PickupCity.
State / Alphanumeric / N / 30 / Pickup state.
PostCode / Alphanumeric / N / 40 / Pickup postcode.
Phone / Alphanumeric / Y / 50 / Customer telephone number.
Preferred format:
+<Country code> (<area code>) <number>
Ex: +962 (6) 5515111
Country / Alphanumeric / Y / 2 / 2-Letter Standard ISO Country Code for Pickup Country.
Refer to Appendix B2 for a complete list of Country codes.
Fax / Alphanumeric / N / 50 / Fax number.
Preferred format:
+<Country code> (<area code>) <number>
Ex: +962 (6) 5515111
OfficeClosingTime / Alphanumeric / Y / 5 / Office closing time.
FORMAT:
HH:NN for example: 18:30
PickupLocation / Alphanumeric / N / 50 / Pickup Location
PickupDate / DateTime / Y / 19 / Date and Time the shipment will be picked from the customer.
FORMAT:
YYYY-MM-DDTHH:NN:SS
PickupReadyTime / Alphanumeric / Y / 5 / Time when the pickup will be ready.
FORMAT:
HH:NN
PickupLatestTime / Alphanumeric / Y / 5 / Latest time to pickup a collection.
FORMAT:
HH:NN
HAWB / Node / N / This Node contains the HAWB details and the HAWBItem nodes mentioned below.
Reference / Alphanumeric / N / 255 / Reference field may be used to track collections or provide additional information.
Reference2 / Alphanumeric / N / 255 / Reference field may be used to track collections or provide additional information.

Shipment Pickup REQUEST DOCUMENT Elements: HAWB

This section of the Shipment Pickup Request document contains details of each shipment within the pickup request (Collection node). In fact, each HAWB node is a child node of the Collection node, see figure 1.1 above for more details. The following table describes each of the elements within the HAWB node.

Element / Data Type / Required / Length / Allowed Values / Description
HAWBNumber / Integer / N / 12 / House Airbill Number

Shipment Pickup Response Document

The format of this document is in xml and it is made up of two main nodes within the “InfoLinkDocument” root node, namely:

AccessResponse: this contains header information for the transmission. Each document can have only one AccessResponse node.

Collection: : this contains the results of the collection which was transmitted.

AccessRsponse

AccessRsponse Element 1>

AccessRsponse Element 2>

< …>

AccessRsponse Element n>

</AccessRsponse

Collection1 Element 1>

Collection1 Element 2>

< …>

Collection1 Element n>

<…>

</Collection>

<…>

</InfoLinkDocument>

Shipment Pickup Response Document Elements: AccessResponse

This section of the Shipment Pickup Response Document contains header information during the reception of data by the customer. The following table describes each of the elements within the Access Response.

Element / Data Type / Length / Description
DocumentType / Integer / 2 / Type of document being received.
Always 72 for Collection Document.
Version / Alphanumeric / 4 / Version of ARAMEX InfoLink Data Interchanged used.
Always 1.00 for this version.
EntityID / Alphanumeric / 6 / Identification number for the receiving party. This code should be provided to you by ARAMEX as part of setting your entity up on InfoLink.

Shipment Pickup Response Document Elements: Collection

This section of the Shipment Pickup response document contains the response values for each collection in the request document:

Element / Data Type / Length / Description
CollectionRef / Alphanumeric / 12 / Collection Reference; returned when the pickup was successfully submitted
Result / Boolean / 1 / Returns true if the call was successful
ValidationResult / Alphanumeric / 255 / Returns the validation string incase the Result was false

Automatic Transmission of InfoLink Files

Transmission of InfoLink documents happens through a standard HTTP POST command issued on the customer computer to ARAMEX InfoLink server.

Transmission Method: HTTP POST

Transmission URL:

User Name: <Valid user ID>

Password: <Valid password>

In this process, customer prepares InfoLink XML Document according to the specifications provided. This should be constructed through a locally developed package at customer site.

The InfoLink XML Document is then transmitted to ARAMEX through HTTP Post at the InfoLink Server address and the response document will be returned with the processing results.

Version 1 / PagE 1