Your Guide To Embedding Aramex’s Shipping Services API Manual

User Manual:

Open the PDF directly: View PDF .
Page Count: 53

Download
Open PDF In Browser	View PDF

Aramex’s Guide to Embedding
the Shipping Services API

Your Guide to Embedding Aramex’s
Shipping Services API

Table of Contents
Version History ........................................................................................................ 6
Getting Started: Shipping API ....................................................................................... 7
Security Certificate: .................................................................................................. 7
Shipping Services API ................................................................................................. 8
Introduction: ........................................................................................................ 8
Features: ............................................................................................................ 8
Security: .......................................................................................................... 8
Encryption: ....................................................................................................... 8
Simple and easy to use: ........................................................................................ 8
Flexibility: ........................................................................................................ 8
Accuracy and error handling: .................................................................................. 9
Main Functionalities: .............................................................................................. 9
Creating shipments: ............................................................................................. 9
Printing labels: ................................................................................................... 9
Creating pickups: ................................................................................................ 9
Cancelling pickups: .............................................................................................. 9
Using Shipping Services API: How does it Work? ................................................................ 10
Xml Structure Diagrams: ........................................................................................... 10
Shipping Services Service .......................................................................................... 11
1

Methods: ........................................................................................................ 12
1.1

Shipment Creation method: ............................................................................ 12

1.2

Label Printing Method ................................................................................... 13

1.3

Pickup Creation Method ................................................................................. 14

1.4

Pickup Cancellation Method ............................................................................ 15

Elements Data structure ...................................................................................... 16
2.1

General Request Elements .............................................................................. 16
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

2.2

General Response Elements ............................................................................ 18

2.3

Shipment Creation Elements ........................................................................... 19

2.4

Pickup Creation Elements ............................................................................... 21

Complex Data Type Structure ............................................................................... 24

Data Type Element Description.............................................................................. 29
4.1

Client Info ................................................................................................. 29

Testing credentials ................................................................................................. 30
4.2

Transaction ............................................................................................... 30

4.3

Shipment .................................................................................................. 31

4.4

Party ....................................................................................................... 33

4.5

Address .................................................................................................... 33

4.6

Contact .................................................................................................... 34

4.7

Shipment Details ......................................................................................... 35

4.8

Date Time ................................................................................................. 37

4.9

Shipment Items ........................................................................................... 37

4.10

Attachment ............................................................................................... 37

4.11

Label Info.................................................................................................. 38

4.12

Dimensions ................................................................................................ 38

4.13

Weight ..................................................................................................... 39

4.14

Money ...................................................................................................... 39

4.15

Volume..................................................................................................... 39

4.16

Pickup Details............................................................................................. 40

4.17

Pickup Item ............................................................................................... 41

APPENDIX: Aramex and General References .................................................................... 42
Appendix A – Product Types .................................................................................... 42
Appendix B – Shipment Payment Methods .................................................................... 43
Appendix C – Service Codes ..................................................................................... 43
Appendix D – ISO Country Codes ............................................................................... 44
Appendix E – Currency Codes ................................................................................... 47

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

List of Tables
Table 1: The Shipping Services Service Diagram ............................................................... 11
Table 2: Shipment Creation Request & Response .............................................................. 12
Table 3: Label Printing Request & Response .................................................................... 13
Table 4: Pickup Creation Request & Response ................................................................. 14
Table 5: Pickup Cancelation Request & Response ............................................................. 15
Table 6: General Request Elements - Client Info & Transaction ............................................. 16
Table 7: General Response Elements ............................................................................ 18
Table 8: Shipment Creation Request Elements ................................................................. 19
Table 9: Shipment Creation Response Element ................................................................ 20
Table 10: Pickup Creation Request Elements ................................................................... 21
Table 11: Pickup Creation Response Element .................................................................. 23
Table 12: Data Type Structure .................................................................................... 24
Table 13: List of Elements present in the Client Structure ................................................... 29
Table 14: List of Elements present in the Transaction Structure ............................................ 30
Table 15: List of Elements present in the Shipment Structure ............................................... 31
Table 16: List of Elements present in the Party Structure .................................................... 33
Table 17: List of Elements present in the Address Structure ................................................. 33
Table 18: List of Elements present in the Contact Structure ................................................. 34
Table 19: list of Elements present in the Shipment Details Structure ...................................... 35
Table 20: list of Elements present in the Date Time Structure .............................................. 37
Table 21: list of Elements present in the Shipment Item Structure ......................................... 37
Table 22: list of Elements present in the Attachment Structure ............................................ 37
Table 23: list of Elements present in the Label Info Structure ............................................... 38
Table 24: list of Elements present in the Dimensions Structure ............................................. 38
Table 25: list of Elements present in the Weight Structure .................................................. 39
Table 26: list of Elements present in the Money Structure ................................................... 39
Table 27: list of Elements present in the Volume Structure .................................................. 39
Table 28: list of Elements present in the Pickup Details Structure .......................................... 40
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Table 29: list of Elements present in the Pickup Item Structure ............................................ 41

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

List of Figures
Fig.1. Shipping WSDL Service .................................................................................... 11
Fig.2. Shipment Creation Structure Request ................................................................. 12
Fig.3. Shipment Creation Structure Response ............................................................... 12
Fig.4. Label Printing Structure Request ....................................................................... 13
Fig.5. Label Printing Structure Response ..................................................................... 13
Fig.6. Pickup Creation Structure Request..................................................................... 14
Fig.7. Pickup Creation Structure Response ................................................................... 14
Fig.8. Pickup Cancelation Structure Request................................................................. 15
Fig.9. Pickup Cancelation Structure Response ............................................................... 15
Fig.10. Client Info Structure Diagram .......................................................................... 16
Fig.11. Transaction Structure Diagram ........................................................................ 17
Fig.12. Notification Structure Diagram ........................................................................ 18
Fig.13. Transaction Structure Diagram ........................................................................ 18
Fig.14. Has Errors Structure Diagram .......................................................................... 18
Fig.16. Label Info Structure Diagram .......................................................................... 20
Fig.17. Processed Shipment Structure Diagram .............................................................. 20
Fig.18. Pickup Structure Diagram .............................................................................. 21
Fig.19. Pickup Item Details Structure Diagram ............................................................... 22
Fig.20. Shipment Structure Diagram ........................................................................... 23
Fig.21. Address Structure Diagram ............................................................................. 24
Fig.23. Contact Structure Diagram ............................................................................. 25
Fig.24. Party Structure Diagram ................................................................................ 26
Fig.25. Money Structure Diagram ............................................................................... 26
Fig.26. Weight Structure Diagram .............................................................................. 26
Fig.27. Attachment Structure Diagram ........................................................................ 27
Fig.28. Dimensions Structure Diagram ......................................................................... 27
Fig.29. Volume Structure Diagram ............................................................................. 27
Fig.30. Shipment Label Structure Diagram ................................................................... 28
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Version History
Version

Change

Document Creation

New Sections
- Addition of testing
credentials (page 30)
- Addition of the security
certificate details (page
7)

Effective Date
June 2011

1st of January 2013

New Condition
- In data type element
description “Money” =
Cash on delivery currency
must be in USD. (page 39)
- In data type element
description “Contact” =
Cell Phone field is
Mandatory (page 34)
- In data type element
“Address” = if a postcode
has more than one city
then the response SOAP
will return the list of cities
to be re-entered into the
request. (page 35)
New Information
- Appendix A, addition of
EPX product type (page
42)

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Getting Started: Shipping API
The Aramex Shipping API (Application Programing Interface) allows your system to communicate
directly with our shipping and tracking systems over the internet. Aramex Shipping API provides you
with a wide range of functionalities which enables your system and applications to integrate directly
with Aramex’s systems in an easy and automated way. The APIs are built based on SOAP (Simple
Object Access Protocol) and provide a secure channel of communication, as all web calls are made
through secured HTTPS.
A SOAP message is an ordinary XML document containing the following elements:
•
•
•
•

An Envelope element that identifies the XML document as a SOAP message (required)
A Header element containing header information (optional)
A Body element containing call and response information (required)
A Fault element containing errors and status information (optional)

Security Certificate
To connect securely through HTTPs to our testing website the certificate in the following link will need to be
downloaded, a manual is also present through the below link to guide the user through the download and
installation of the certificate:

http://www.aramex.com/PKI/trust.aspx
This certificate should be imported and trusted on the machine or user account used to connect to our testing
website.

Testing URL
http://ws.dev.aramex.net/shippingapi/shipping/service_1_0.svc

Live URL
http://ws.aramex.net/shippingapi/shipping/service_1_0.svc

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Shipping Services API
Introduction
This document contains a complete guide on how to use the Shipping Services API, which is one of the
main functionalities required by customers to start shipping. The Shipping Services Service is part of
the Aramex Shipping API allowing you to create shipments, generate labels, create and cancel pick up
requests.

Features
The Shipping Services API provides these features:

Security
Two levels of security are provided for each method:
a) Each submitted request should contain a valid email address and password which are obtained
by registering your email address on aramex.com. This is used for authorizing the request.
b) Each submitted request should contain a valid account number and a valid PIN code. This is
used to authenticate and verify the identity of the customer.

Encryption
By using HTTPS all transmission are insured to be encrypted.

Simple and easy to use
Creating shipments, requesting pickups and other functionalities are easily generated by providing
very basic and simple information about the shipper, consignee and shipments

Flexibility





Users can have different means of providing the same information.
Pickup request can be generated with detailed shipments information, or just a summary
about the shipments. Shipments can be added to a pickup request after the request has been
created.
A printing label can be requested within the shipment creation request or as a separate label
printing request by simply providing the Airway bill number to print.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Accuracy and error handling
During the process of shipment or pickup creation, the submitted information such as addresses,
payment methods and more, goes through a detailed validation procedure to insure the validity and
correctness. In case of errors, detailed descriptive error messages are provided in the generated
response.

Main Functionalities
Creating shipments
Allows you to create shipments, providing a wide range of options for customers to provide full details
about their shipments, such as:
1. Attaching additional documentation:
a) Clients can attach Performa Invoices, clearance forms or any other documentation required.
2. Generating a label for the Shipment being created.
3. Providing us with sensitive details such as Operations (Handling) instructions.
4. Adding Shipments to an existing pickup, given that the pickup is un-assigned or pending details.
Printing labels
Allows you to generate shipping labels for an existing shipment. Users will be provided with the report
ID used to generate the label. Also, different label formats are available for customers to use and the
customer can specify which format by providing the report ID in the request.
Two methods are provided for getting and printing the label from the customer side, a URL to
download the PDF file, or a data stream that will be provided in the response message.
Creating pickups
Allows you to create pickups, providing flexible options such as:
1. After a pickup is created, shipments can be added later to it through the Create Shipments
function, given that the pickup is un-assigned or pending details.
Cancelling pickups
Allows you to cancel an existing pickup, assuming it has not been assigned to a courier or processed
by the dispatcher.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Using Shipping Services API: How does it Work?
•
The Shipping Services API uses a Web Service Definition Language (WSDL) that can be
downloaded at http://www.aramex.com/developers/aramex-apis/42194/Shipping-Services-API,
enabling developers to add reference to the web service in their code.
•

The user must be registered at http://www.aramex.com with a valid user name and password.

•
Sample Codes are available in VB.NET, C# and PHP, downloadable at
http://www.aramex.com/developers/aramex-apis/42194/Shipping-Services-API.
Users are free to use any development tool provided these tools support the WSDL and messages
conform to the standards and structure required. However the preferred programming languages for
client implementations are:
•
•
•

Visual Basic 2005 (with VB.NET framework 2) or later
C#
PHP

Xml Structure Diagrams:
XML request or reply messages have to be constructed like below. The Tables below show the structure,
element, child element, semantics as well as the validation conditions in the Shipping Services API XML.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Shipping Services Service
Table 1: The Shipping Services Service Diagram

Diagram

Description
This Service
includes
several
methods as
shown in Fig.1.
Each method
has an Input
(Request) and
Output
(Response),
with their
designed
parameters.

Fig.1. Shipping WSDL Service

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

1 Methods
A General outlook on the method diagrams, their overall description and requirements.

1.1

Shipment Creation method:
Table 2: Shipment Creation Request & Response

Diagram

Description

Shipment Creation
Request:
This method allows
users to create
shipments on Aramex
system.
The required nodes
to be filled are: Client
Info and Shipments,
Their elements and
further description
can be found in Table
6 and
Table 8

Fig.2. Shipment Creation Structure Request

Fig.3. Shipment Creation Structure Response

Shipment Creation
Response:

Informs the user on
the status of their
submitted shipment.
When created an AWB
number is supplied, if
not then an error
message specifically
states the location of
the error and its
nature. The
Transaction
Parameter is sent as
filled in the request
for identification
purposes. Their
elements and further
description can be
found in Table 7 and
Table 9

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

1.2

Label Printing Method
Table 3: Label Printing Request & Response

Diagram

Description

Label Printing
Request:

Fig.4. Label Printing Structure Request

This method allows the
user to print a label for
an existing shipment,
whether they created it
themselves through the
shipping creation
method or a previously
existing shipment
present in aramex
system.
The required nodes to
be filled are ClientInfo
and ShipmentNumber. If
there is a duplicate
Shipment Number then
the ProductGroup and
OriginAddress are
required. Their elements
and further description
can be found in. Fig. 16 –
Table 8 and Table 6

Label Printing
Response:

Fig.5. Label Printing Structure Response

Returns the created label,
if all the required
information in the
request is inserted and
validated correctly.
The Transaction and
Shipment Number
parameters are returned
from the request for
identification purposes.
Their elements and
further description can
be found in Fig.30 –
Table 12 and Table 7

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

1.3

Pickup Creation Method
Table 4: Pickup Creation Request & Response

Diagram

Description

Pickup Creation
Request:

Fig.6. Pickup Creation Structure Request

This method allows
users to create a
pickup request.
The nodes required
to be filled are as
follows: ClientInfo
and Pickup. Their
elements and
further description
can be found in
Table.6. , Fig.16. –
Table 8 and Table
10

Pickup Creation
Response:

Fig.7. Pickup Creation Structure Response

Informs the user on
the status of their
pickup, when
created a Collection
(Pickup) reference is
supplied, if not then
an error message
specifically states
the location of the
error and its nature.
The Transaction
Parameter is sent as
filled in the request
for identification
purposes. Their
elements and
further description
can be found in
Table 7 and Table
11

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

1.4

Pickup Cancellation Method
Table 5: Pickup Cancelation Request & Response

Diagram

Description
Pickup
Cancelation
Request:
This method
allows you to
cancel a pickup
as long as it is
un-assigned or
pending details.
Their elements
and further
description can
be found in
Table 6.

Fig.8. Pickup Cancelation Structure Request

Pick up
Cancelation
Response:

Fig.9. Pickup Cancelation Structure Response

Informs the user
that the pickup
was successfully
canceled.
Their elements
and further
description can
be found in
Table 7.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

2 Elements Data structure
2.1

General Request Elements

These elements are present in all the methods of Shipping Services API (shipment creation,
printing label, pickup creation and pickup cancellation), in addition to other specified elements.
Table 6: General Request Elements - Client Info & Transaction

Diagram

Description

Client Info:
The Client Info element is present in all the
methods of this service.
All its child elements are required to be filled.
The user name and password are validated to
allow access to the service.
Version element, is the Version of the API the
customer is using, which needs to be specified in
the request
Account Number, Pin, Entity and Country Code are
all needed to verify the users account and obtain
vital information from it, such as the ability to
create third party shipments among other features
provided for each account.

Fig.10. Client Info Structure Diagram

For a more detailed description of the elements
refer to Table 13.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Transaction:
The Transaction element is not validated and is also
present in all the method requests and returned in
all their responses for identification purposes.
Any type of data can be included by the customer.
For a more detailed description of the elements
refer to Table 14.

Fig.11. Transaction Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

2.2

General Response Elements

The Response of any method has three standard elements (notification, transaction, HasErrors)
Table 7: General Response Elements

Diagram

Description

Notification:
Contains details of the request errors or success.
Code = To Identify the notification category.
Message = Deeper description of the Notification.
Fig.12. Notification Structure Diagram

Transaction:
Contains the data sent in the request by the user, used
mainly for identification purposes.

Fig.13. Transaction Structure Diagram

HasErrors:
Returns True if there are errors and false if there aren’t.
Fig.14. Has Errors Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

2.3

Shipment Creation Elements

The request and response elements of the Shipment Creation method are described in the tables
below:
Table 8: Shipment Creation Request Elements

Diagram

Description

Shipment:
Required –
Shipper, Consignee,
Shipping Date Time,
Due Date and
Details.
Further details on
shipment child
elements are shown
in Table 15

Fig.15. Shipment Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Label Info:
Allows you to be
able to generate
labels.
For further
information on the
child elements refer
to Table 23

Fig.16. Label Info Structure Diagram

Table 9: Shipment Creation Response Element

Diagram

Description

Processed Shipment:
When a request is processed
successfully, the elements in
processed shipment appear with
details on the shipment.
ID = The AWB ID generated.
Reference = The reference filled
in the Shipment element.
Foreign HAWB = Filled in the
Shipment Element must be
unique for every shipment in the
system.
HasErrors, Notifications = Refer
to Table 7 for details on general
response elements.
Shipment Label = if a label was
generated then the details would
be present in this element, for
more details refer to Fig 30 in
Table 12.

Fig.17. Processed Shipment Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

2.4

Pickup Creation Elements

The elements of the request and response Pickup Creation method are described in the tables below:
Table 10: Pickup Creation Request Elements

Diagram

Description

Pickup:
Required Elements – Pickup Address, Pickup
Contact, Pickup Location, Ready time, Last
Pickup time, Closing Time, Reference 1,
Pickup Items and Status.
Further details on Pickup child elements are
shown in Table 28 and Table 29.

Fig.18. Pickup Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Pickup Item Detail:
Required Elements – Product Group,
Number of Shipments, Payment.
Further details on Pickup Item Detail child
elements are shown in Table 29.

Fig.19. Pickup Item Details Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Table 11: Pickup Creation Response Element

Diagram

Description

Processed Pickup:
When a request is processed
successfully, the elements in
processed pickup appear
with details of the pickup.
ID = A reference number that
has been allocated to the
submitted pickup.

Fig.20. Shipment Structure Diagram

GUID = A unique identifier
that gets assigned to the
submitted pickup request
after being saved. This
identifier can be used in the
cancelation request at a later
stage.
Reference = The reference
filled in the request.
Processed Shipment = Refer
to Table 9

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

3 Complex Data Type Structure
The Structure and Description of the complex data types present in the elements are shown in the
table below:
Table 12: Data Type Structure

Diagram

Description

Address
The Address element contains several child
elements that are validated before the request
can be submitted successfully.
For further details on each child element refer
to Table 17

Fig.21. Address Structure Diagram

Shipment Item
ShipmentItem is a complex element consisting
of four child elements.
Every Shipment can consist of several items
and each item has the following: package type,
quantity, weight, comments and reference.
Table 21 contains further details.

Fig.22. Shipment Item Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Contact
Depending on the method chosen, certain
elements are required and others optional.

Shipment Creation:
Required – Person Name, Company Name,
Phone Number1, and Email Address.

Pickup Creation:
Required – Person Name, Company Name,
Phone Number1, and Cell Phone.
For further details on each child element refer
to Table 18

Fig.23. Contact Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Party
Party is a complex element, consisting of three
child elements (Reference 1, Reference 2, and
Account Number) and encompasses from its
data type level the Address and Contact
Elements.
This data type is applied on the Shipper,
Consignee and Third Party Elements as they
are considered a party in the transaction.
For further details on each child element refer
to Table 16

Fig.24. Party Structure Diagram

Money

Fig.25. Money Structure Diagram

Money is a complex element, consisting of two
child elements, (Currency Code and Value),
which apply to every element that is defined
by the Data Type “Money“.
For Further Details on each child element refer
to Table 26

Weight
Weight is a complex element, consisting of two
child elements, Unit and Value, which apply to
every element that is defined by the Data Type
“Weight“.
For further details on each child element refer
to Table 25
Fig.26. Weight Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Attachment
Attachment is a complex element, consisting of
three child elements, (File Name, File
Extension and File Contents) which apply to
every element that is defined by the Data Type
“Attachment“.
File contents has a maximum size of 4 MB
For further details on each child element refer
to Table 22
Fig.27. Attachment Structure Diagram

Dimensions
Dimensions is a complex element, consisting of
four child elements, (Unit, Length, Width and
Height), which apply to every element that is
defined by the Data Type “Dimensions“.
For further details on each child element refer
to Table 24

Fig.28. Dimensions Structure Diagram

Volume
Volume is a complex element, consisting of two
child elements, (Unit and Value) which apply
to every element that is defined by the Data
Type “Volume“.

Fig.29. Volume Structure Diagram

For further details on each child element refer
to Table 27

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Shipment Label
Returns the Label as URL with Label URL
element or as a file with Label File Contents.

Fig.30. Shipment Label Structure Diagram

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4 Data Type Element Description
Further details on child elements of the Shipping Services API and their attributes can be shown
below.
Element: Element Name
Data Type: The type of data that can be inserted into this field.
Required: Specifies three categories




M = Mandatory, This field must be filled in all cases.
O = Optional, This field may or may not be filled.
C = Conditional, This field may or may not be filled depending on another field being filled.

Length: The maximum number of characters allowed in this field.
Allowed Values: Specifies the accepted data by this field.

4.1

Client Info
Table 13: List of Elements present in the Client Structure

Element
User Name

Data
Type
String

Required Length Allowed
Values
M
50

Description

Password

String

A unique password to verify the user name,
sent to the user upon registration with
http://www.aramex.com

Version

String

Based on the WSDL version the user is using to
invoke the web service

Account
Entity

String

Identification Code for Transmitting Party. This
code should be provided to you by Aramex.

Account
Number
Account PIN

String

Account
Country
Code

String

The Customer’s Account number provided by
Aramex when the contract is signed.
A key that is associated with the account
number, so as to validate customer identity.
Two Letter Code Identifying the Country.
Refer to Appendix D

A unique user name sent to the user upon
registration with http://www.aramex.com

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.1.1 Testing credentials
To be able to test the Shipping Services API on our testing website, the user credentials below can be
used:
AccountCountryCode =JO
AccountEntity = AMM
AccountNumber= 20016
AccountPin = 331421
UserName = testingapi@aramex.com
Password = R123456789$r
Version = v1.0

4.2

Transaction
Table 14: List of Elements present in the Transaction Structure

Element
Reference 1

Data
Type
String

Required Length Allowed
Values
O
50

Description

Reference 2

String

Reference 3

String

Any details the user would like to add that will
be sent back in the response.

Reference 4

String

Any details the user would like to add that will
be sent back in the response.

Reference 5

String

Any details the user would like to add that will
be sent back in the response.

Any details the user would like to add that will
be sent back in the response.
Any details the user would like to add that will
be sent back in the response.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.3

Shipment
Table 15: List of Elements present in the Shipment Structure

Element

Data Type

Required Length Allowed
Values
O
50

Reference1

String

Reference2

String

Reference3

String

Foreign HAWB

String

Transport Type

Integer

Shipper

Party

Refer to Table 16 for
further details.

Consignee

Party

Refer to Table 16 for
further details.

ThirdParty

Party

Based on PaymentType
= "3"

ShippingDateTime

DateTime

The date aramex
receives the shipment to
be shipped out.

DueDate

DateTime

Comments

String

The date specified for
shipment to be
delivered to the
consignee.
Any comments on the
shipment

PickupLocation

String

OperationsInstructions String

0 or 1

Description
Any general detail the
customer would like to
add about the shipment
Any general detail the
customer would like to
add about the shipment
Any general detail the
customer would like to
add about the shipment
User’s AWB number if
present.
If filled this field must
be unique for each
shipment.
0 by Default

The location from where
the shipment should be
picked up, such as the
reception desk.
Instructions on how to
handle the shipment

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

AccountsInstructions

String

Instructions on how to
handle payment
specifics.

Details

ShipmentDetails

Details on the shipment.
Refer to Table 19 for
further details.

Attachments

List(Of
Attachments)

No files limit. The total
size must not exceed 4
MB

Pickup GUID

String

A valid GUID
value,
provided by
the Pickup
Creation
Response

To add Shipments to
existing pickups.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.4

Party
Table 16: List of Elements present in the Party Structure

Element

Data
Type

Reference 1

String

Any details the user would like to add that
will be sent back in the response.

Reference 2

String

Any details the user would like to add that
will be sent back in the response.

Account
Number

String

The Same Account number entered in the
Client Info

PartyAddress

Address

Refer to Table 17 for further details

Contact

Refer to Table 18 for further details

4.5

Required Length Allowed
Values

Description

Address
Table 17: List of Elements present in the Address Structure

Element
Line1

Data
Type
String

Line2

String

Additional Address information.

Line3

String

Additional Address information.

City

String

Address City.
Conditional: Required if the post code is
not given.

State Or
Province
Code

100

String
C

Address State or province code.
Required if The country code and city
require a State or Province Code
Postal Code, if there is a postal code in the
country code and city then it must be given.

Post Code

String

Required Length Allowed
Values
M
50
More than 3
characters

Description
Additional Address information, such as the
building number, block, street name.

If there are multiple cities for the same
post code, the list of cities will be
returned in the SOAP response
Country
Code

String

2-Letter Standard ISO Country Code.
Refer to Appendix D for a complete list of
Country codes.
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.6

Contact
Table 18: List of Elements present in the Contact Structure

Element
Department

Data
Type
String

Required Length Allowed
Values
O
50

Description

PersonName

String

Title

String

CompanyName

String

PhoneNumber1

String

Valid Phone Number

PhoneNumber1Ext String

Valid Extension to the phone number.

PhoneNumber2

String

Phone Number

PhoneNumber2Ext String

Extension to the phone number.

FaxNumber

String

Fax Number

CellPhone

String

Cell Phone Number

EmailAddress

String

Email Address

Type

String

User’s Work Department
User’s Name, Sent By or in the case of
the consignee, to the Attention of.
User’s Title
Company or Person name.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.7

Shipment Details
Table 19: list of Elements present in the Shipment Details Structure

Element

Data Type

Required Length Allowed
Values
O

Dimensions

NumberOfPieces

Integer

ActualWeight

Weight

Product Group

String

EXP, DOM

Product Type

String

Product
Type:
“OND”

Pieces > 0
MAX =
100

For
Product
Group:
“DOM”
Payment Type

String

Payment Options

String

P,
C,
3
Payment
Type = C
ASCC
ARCC
Payment
Type = P
CASH
ACCT
PPST
CRDT

Description
Measurements required in
calculating the Chargeable
Weight, If any of the dimensional
values are filled then the rest
must be filled.
Number of shipment pieces
Total actual shipment weight. If
the Dimensions are filled,
charging weight is compared to
actual and the highest value is
filled here.
EXP = Express
DOM = Domestic
Product Type involves the
specification of certain features
concerning the delivery of the
product such as: Priority, Time
Sensitivity, and whether it is a
Document or Non-Document.
Refer to Appendix A for a list of
Product Types and their Product
Groups
Method of payment for shipment.
Refer to Appendix B for more
details.
Conditional - Based on the
Payment Type "C"
ASCC = Needs Shipper Account
Number to be filled.
ARCC = Needs Consignee Account
Number to be filled.
Optional - Based on the Payment
Type "P" then it is optional to fill.
CASH = Cash
ACCT = Account

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

PPST = Prepaid Stock
CRDT = Credit
Services

String

Additional Services used in
shipping the package, Separate
by comma when selecting
multiple services.
Refer to Appendix C (Service
Codes) for valid codes.

Description of
Goods

String

100

Goods Origin
Country

String

Customs Value
amount

Money

Cash on Delivery

Money

The Nature of Shipment
Contents.
Example: Clothes, Electronic
Gadgets …..
The Origin of which the product
in the shipment came from. Refer
to Appendix D for a complete list
of Country codes.
Value Charged by Destination
Customs.
Conditional - Based on the
ProductType "Dutible"
Amount of Cash that is paid by
the receiver of the package.
Conditional - Based on the
Services "COD" being filled.

Insurance
Amount

Money

Insurance Amount charged on
shipment.

Cash Additional
Amount

Money

Cash Additional
Description

String

Collect Amount

Money

Additional Cash that can be
required for miscellaneous
purposes.
Conditional - Based on the
PaymentType "3" AND
Cash Additional Amount is
filled
Transportation Charges to be
collected from consignee.
Conditional - Based on the
PaymentType "C" +
PaymentOptions "ARCC"

Items

List(Of
ShipmentItem)

Details of the Items within a
shipment. Several items can be
added for a single shipment.
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.8

Date Time
Table 20: list of Elements present in the Date Time Structure

Element
Shipping
Date
Due Date

4.9

Data
Type
Date

Required

Date

Length

Allowed
Values

Description
The date Aramex receives the shipment to be
shipped out.
The date specified for shipment to be
delivered to the consignee.

Shipment Items
Table 21: list of Elements present in the Shipment Item Structure

Element

Data
Type

Required

Length

Package
Type

String

Weight
Quantity

Weight
Integer

C
C

Comments

String

1000

Allowed
Values

MAX =
100

Description
Type of packaging, for example. Cans, bottles,
degradable Plastic.
Conditional: If any of the Item element
values are filled then the rest must be filled.
Total Weight of the Items
Number of items
Additional Comments or Information about
the items

4.10 Attachment
Table 22: list of Elements present in the Attachment Structure

Element
File Name

Data
Type
String

Required Length
C

Allowed
Values

Description
The file name without its extension.

File
Extension

String

File
Contents

Byte()

4 MB

The extension of the file. Our system accepts
any extension
Contents of the file.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.11 Label Info
Table 23: list of Elements present in the Label Info Structure

Element
Report ID
Report
Type

Data
Type
Integer

Required Length Allowed
Values
M
9201

String

“URL” or “RPT”

Description
The Template of the report to be
generated.
Either by URL or a streamed file(RPT).
URL by Default

4.12 Dimensions
Table 24: list of Elements present in the Dimensions Structure

Element Data
Type
Length
Double

Required Length Allowed
Values
C
5
Format:
000.000
MAX = 100

Description
Measurements required in calculating the
Chargeable Weight, If any of the Dimensional
values are filled then the rest must be filled.

Width

Double

Format:
000.000
MAX = 100

Measurements required in calculating the
Chargeable Weight, If any of the Dimensional
values are filled then the rest must be filled.

Height

Double

Format:
000.000
MAX = 100

Measurements required in calculating the
Chargeable Weight, If any of the Dimensional
values are filled then the rest must be filled.

Unit

String

CM, M

Measurement Unit, If any of the Dimensional
values are filled then the rest must be filled.
CM = Centimeter
M = Meter

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.13 Weight
Table 25: list of Elements present in the Weight Structure

Element
Value

Unit

Data
Required Length Allowed
Type
Values
Double
M
6
Format:
000.000
Weight > 0
MAX = 100

Description

String

Unit of the weight

KG , LB

Shipment weight.
If the Data Entity ‘Dimensions’ are filled, charging
weight is compared to actual and the highest
value is filled here.

4.14 Money
Table 26: list of Elements present in the Money Structure

Element

Data
Type

Required

Currency
Code

String

Length Allowed
Values
3

Description
3-Letter Standard ISO Currency Code
Refer to Appendix E for a list of Currency Codes.
If Cash on delivery value is filled, then its
currency must be in USD.

Value

Double

Format:
000.000

The Monetary value.

For Cash on delivery, the currency must be in
MAX = 100 USD.

4.15 Volume
Table 27: list of Elements present in the Volume Structure

Element

Required

Length

Value

Data
Type
Double

Unit

String

Allowed
Values
Format:
000.000
Volume > 0
MAX = 100

Description

Cm3, Inch3

Unit of the volume

Shipment Volume.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.16 Pickup Details
Table 28: list of Elements present in the Pickup Details Structure

Element
Reference1

Data
Type
String

Required Length Allowed
Values
O
50

Description

Reference2

String

Any general detail the customer would like to
add about the shipment

Vehicle
Type

String

Type of Vehicle requested to transport the
shipments.

Address

Status

String

Date Time

DateTime

Ready time should always be before latest
and closing time.
Date should not be before the current day or
more than seven days in advance of the
current date.
Refer to Table 20 for further details.

Contact

Refer to Table 18 for further details.

Any general detail the customer would like to
add about the shipment

Pickup Address
10

Ready or
Pending

Pending: more information about the pickup
needs to be added, Ready: no further
information is needed and the pickup request
is ready to be assigned

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

4.17 Pickup Item
Table 29: list of Elements present in the Pickup Item Structure

Element

Data Type

Product
String
Group
Product Type String

Required Length Allowed
Values
M
3
EXP, DOM
O

Product
Type:
“OND”
For

Description
EXP = Express
DOM = Domestic
Product Type involves the specification
of certain features concerning the
delivery of the product such as: Priority,
Time Sensitivity, and whether it is a
Document or Non-Document.

Product
Group:
“DOM”

Refer to Appendix A for a list of Product
Types and their Product Groups

P,
C,
3
Pieces > 0
MAX = 100

Method of payment for shipment.
Refer to Appendix B for more details.

Payment
Type

String

Number Of
Pieces
Shipment
Weight

Integer

Weight

Number Of
Shipments
Package
Type

Integer

String

Type of packaging, for example. Cans,
bottles, degradable Plastic.

Shipment
Volume
Cash Amount
Extra
Charges
Shipment
Dimensions

Volume

Volume of the Shipment

Money
Money

O
O

Dimensions

Comments

String

Number of shipment pieces
Total actual shipment weight. If the
Dimensions are filled, charging weight is
compared to actual and the highest value
is filled here.

Pieces > 0
MAX = 100

Number of shipment

Measurements required in calculating the
Chargeable Weight, If any of the
Dimensional values are filled then the
rest must be filled.
Any Comments on the Item being picked
up.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

APPENDIX: Aramex and General References
Appendix A – Product Types
Product
Type
PDX
PPX

Name
Priority
Document
Express
Priority Parcel
Express

Dutiable Full Description
No

Urgent, time sensitive consignments containing
printed matter or document material

Product
Group
International
Express

Yes

Urgent, time sensitive consignments containing
non-printed matter or non-document material

International
Express

PLX

Priority Letter
Express

Urgent, time sensitive consignments containing
printed matter of weight less than 0.5 kg

International
Express

DDX

Deferred
Document
Express
Deferred
Parcel Express

2nd Day Delivery consignments containing
printed matter or document material

International
Express

Yes

2nd Day Delivery consignments containing nonprinted matter or non-document material

International
Express

Ground delivery consignments containing
printed matter or document material

International
Express

Yes

Ground Delivery consignments containing nonprinted matter or non-document material
Non - Document/Printed Matter (Commercial)
shipment irrespective of its weight.

International
Express
International
Express

DPX
GDX
GPX
EPX

Ground
Document
Express
Ground Parcel
Express
Economy
Parcel Express

Yes

The word “Economy” represents the action of
selling the products and services online, having
Aramex arrange the delivery locally and globally

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Appendix B – Shipment Payment Methods
Payment
Method

Stands
for

Description

Prepaid

Transportation Charges payable by shipper

Collect

Transportation Charges payable by consignee

Third
Party

Transportation Charges payable by third party. Note: in case of 3rd Party all
third party details must be filled including a valid Aramex Account Number for
Billing Party.

Appendix C – Service Codes
Service
Code
CODS

Description

Full Description
Receiver pays the cost of the goods

FIRST

Cash on
Delivery
First Delivery

FRDOM

Free Domicile

Sender pays part/or all of the customs charges and the receiver consignee
doesn’t pay anything of the shipping or handling charges.

HFPU

Hold for pick up

Receiver picks up the consignment from an Aramex/Partner facility

NOON

Noon Delivery

Committed delivery time BEFORE Noon at destination country.

SIG

Signature
Required

Physical receiver signature required upon delivery

Committed delivery time at destination country.

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Appendix D – ISO Country Codes
Country Code
AF
AL
DZ
AS
AD
AO
AI
AG
AR
AM
AW
AU
AT
AZ
BS
BH
BD
BB
BY
BE
BZ
BJ
BM
BT
BO
BA
BW
IO
BR
BN
BG
BF
BI
KH
CM
CA
RY
CV
KY
CF
TD

Country Name
AFGHANISTAN
ALBANIA
ALGERIA
AMERICAN SAMOA
ANDORRA
ANGOLA
ANGUILLA
ANTIGUA AND BARBUDA
ARGENTINA
ARMENIA
ARUBA
AUSTRALIA
AUSTRIA
AZERBAIJAN
BAHAMAS
BAHRAIN
BANGLADESH
BARBADOS
BELARUS
BELGIUM
BELIZE
BENIN
BERMUDA
BHUTAN
BOLIVIA
BOSNIA & HERZEGOVINA
BOTSWANA
BR INDIAN OCEAN TERR
BRAZIL
BRUNEI
BULGARIA
BURKINA FASO
BURUNDI
CAMBODIA
CAMEROON
CANADA
CANARY IS
CAPE VERDE
CAYMAN IS
CENTRAL AFRICAN REP
CHAD

Country Code
LY
LI
LT
LU
MO
MK
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
MD
MC
MN
MS
MA
MZ
MM
NA
NR
NP
AN
NL
NC
NZ
NI
NE
NG
NU
NF
MP
NO
OM

Country Name
LIBYA
LIECHTENSTEIN
LITHUANIA
LUXEMBOURG
MACAU
MACEDONIA
MADAGASCAR
MALAWI
MALAYSIA
MALDIVES
MALI
MALTA
MARSHALL IS
MARTINIQUE
MAURITANIA
MAURITIUS
MAYOTTE
MEXICO
MICRONESIA
MOLDOVA
MONACO
MONGOLIA
MONTSERRAT
MOROCCO
MOZAMBIQUE
MYANMAR
NAMIBIA
NAURU
NEPAL
NETHERLANDS ANTILLES
NETHERLANDS
NEW CALEDONIA
NEW ZEALAND
NICARAGUA
NIGER
NIGERIA
NIUE
NORFOLK ISLAND
NORTHERN MARIANA IS
NORWAY
OMAN

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

JE
CL
CN
CX
CC
CO
KM
CG
CK
CR
HR
CU
CY
CZ
CD
DK
DJ
DM
DO
TP
EC
EG
SV
GQ
ER
EE
ET
FK
FO
FJ
FI
FR
GF
PF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP

CHANNEL ISLANDS
CHILE
CHINA
CHRISTMAS IS
COCOS KEELING IS
COLOMBIA
COMOROS
CONGO
COOK IS
COSTA RICA
CROATIA
CUBA
CYPRUS
CZECH REPUBLIC
DEM REP OF THE CONGO
DENMARK
DJIBOUTI
DOMINICA
DOMINICAN REPUBLIC
EAST TIMOR
ECUADOR
EGYPT
EL SALVADOR
EQUATORIAL GUINEA
ERITREA
ESTONIA
ETHIOPIA
FALKLAND IS
FAROE IS
FIJI
FINLAND
FRANCE
FRENCH GUIANA
FRENCH POLYNESIA
GABON
GAMBIA
GEORGIA
GERMANY
GHANA
GIBRALTAR
GREECE
GREENLAND
GRENADA
GUADELOUPE

PK
PW
PS
PA
PG
PY
PE
PH
PN
PL
PT
PR
QA
RE
RO
RU
RW
WS
SM
ST
SA
SN
YU
SC
SL
SG
SK
SI
SB
SO
ZA
ES
LK
HL
KN
LC
PM
VC
SD
SR
SJ
SZ
SE
CH

PAKISTAN
PALAU
PALESTINE
PANAMA
PAPUA NEW GUINEA
PARAGUAY
PERU
PHILIPPINES
PITCAIRN IS
POLAND
PORTUGAL
PUERTO RICO
QATAR
REUNION IS
ROMANIA
RUSSIA
RWANDA
SAMOA
SAN MARINO
SAO TOME & PRINCIPE
SAUDI ARABIA
SENEGAL
SERBIA & MONTENEGRO
SEYCHELLES
SIERRA LEONE
SINGAPORE
SLOVAKIA
SLOVENIA
SOLOMON IS
SOMALIA
SOUTH AFRICA
SPAIN
SRI LANKA
ST HELENA
ST KITTS & NEVIS
ST LUCIA
ST PIERRE & MIQUELON
ST VINCENT GRENADINE
SUDAN
SURINAM
SVALBARD & JAN MAYEN
SWAZILAND
SWEDEN
SWITZERLAND

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

GU
GT
GN
GW
GY
HT
HM
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IM
IL
IT
CI
JM
JP
JO
KZ
KE
KI
KP
KR
KW
KG
LA
LV
LB
LS
LR

GUAM
GUATEMALA
GUINEA
GUINEA BISSAU
GUYANA
HAITI
HEARD & MCDONALD ISLANDS
HONDURAS
HONG KONG
HUNGARY
ICELAND
INDIA
INDONESIA
IRAN
IRAQ
IRELAND
ISLE OF MAN
ISRAEL
ITALY
IVORY COAST
JAMAICA
JAPAN
JORDAN
KAZAKHSTAN
KENYA
KIRIBATI
KOREA NORTH
KOREA SOUTH
KUWAIT
KYRGYZSTAN
LAOS
LATVIA
LEBANON
LESOTHO
LIBERIA

SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
US
UY
UM
UZ
VU
VA
VE
VN
VG
VI
WF
EH
YE
ZM
ZW

SYRIA
TAIWAN
TAJIKISTAN
TANZANIA
THAILAND
Timor-Lestev
TOGO
TOKELAU
TONGA
TRINIDAD & TOBAGO
TUNISIA
TURKEY
TURKMENISTAN
TURKS & CAICOS IS
TUVALU
UGANDA
UKRAINE
UNITED ARAB EMIRATES
UNITED KINGDOM
UNITED STATES
URUGUAY
US MINOR OUTLYING IS
UZBEKISTAN
VANUATU
VATICAN CITY
VENEZUELA
VIETNAM
VIRGIN IS - BRITISH
VIRGIN ISLANDS - US
WALLIS & FUTUNA IS
WESTERN SAHARA
YEMEN
ZAMBIA
ZIMBABWE

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

Appendix E – Currency Codes
Country Name
AFGHANISTAN
ALGERIA
NETHERLAND ANTILLES
ARGENTINA
MADAGASCAR
ARUBA
CHRISTMAS IS
AUSTRALIA
COCOS KEELING IS
KIRIBATI
TUVALU
HEARD & MCDONALD ISLANDS
NORFOLK ISLAND
NAURU
BAHRAIN
PANAMA
BARBADOS
BELIZE
BERMUDA
ERITREA
ETHIOPIA
VENEZUELA
BOLIVIA
BOSNIA & HERZEGOVINA
BR INDIAN OCEAN TERR
ISLE OF MAN
CHANNEL ISLANDS__
UNITED KINGDOM
BRUNEI
BURUNDI
GABON
BURKINA FASO
BENIN
EQUATORIAL GUINEA
CONGO
IVORY COAST
CENTRAL AFRICAN REP
CAMEROON
NEW CALEDONIA
NIGER
SENEGAL

Currency Code
AFA
DZD
ANG
ARS
MGF
AWG
AUD
AUD
AUD
AUD
AUD
AUD
AUD
AUD
BHD
PAB
BBD
BZD
BMD
ERB
ETB
VEB
BOB
BAD
GBP
GBP
GBP
GBP
BND
BIF
XAF
XOF
XOF
XOF
XOF
XOF
XOF
XOF
XPF
XOF
XOF

Currency Name
Afghani
Algerian Dinar
Antillean Guilder
Argentine Peso
Ariary
Aruban Florin
Australian Dollar
Australian Dollar
Australian Dollar
Australian Dollar
Australian Dollar
Australian Dollar
Australian Dollar
Australian Dollar
Bahraini Dinar
Balboa
Barbadian Dollar
Belizean Dollar
Bermudian Dollar
Birr
Birr
Bolivar
Boliviano
Bosnian Dinar
British Pound
British Pound
British Pound
British Pound
Bruneian Dollar
Burundi Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc

Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

MALI
TOGO
FRENCH POLYNESIA
WALLIS & FUTUNA IS
CHAD
CANADA
CAPE VERDE
CANARY IS
CAYMAN IS
GHANA
CHILE
COLOMBIA
COMOROS
COSTA RICA
BRAZIL
CUBA
CYPRUS
GAMBIA
GREENLAND
DENMARK
FAROE IS
MACEDONIA
UNITED ARAB EMIRATES
DJIBOUTI
SAO TOME & PRINCIPE
DOMINICAN REPUBLIC
ARMENIA
DOMINICA
ANTIGUA AND BARBUDA
ANGUILLA
GRENADA
ST LUCIA
ST KITTS & NEVIS
MONTSERRAT
ST VINCENT&GRENADINE
EGYPT
GERMANY
AUSTRIA
SPAIN
BELGIUM
IRELAND
LUXEMBOURG
MONACO
ITALY

MLF
XOF
XPF
XPF
XOF
CAD
CVE
CVE
CID
GHC
CLP
COP
KMF
CRC
BRE
CUP
CYP
GMD
DKK
DKK
DKK
MKD
AED
DJF
STD
DOP
AMD
XCD
XCD
XCD
XCD
XCD
XCD
XCD
XCD
EGP
EUR
EUR
EUR
EUR
EUR
EUR
EUR
EUR

C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
C.F.A. Franc
Canadian Dollar
Cape Verdean Escudo
Cape Verdean Escudo
Caymanian Dollar
Cedi
Chilean Peso
Colombian Peso
Comoran Franc
Costa Rican Colon
Cruzeiro
Cuban Peso
Cypriot Pound
Dalasi
Danish Krone
Danish Krone
Danish Krone
Denar
Dirham
Djibouti Franc
Dobra
Dominican Peso
Dram
East Caribbean Dollar
East Caribbean Dollar
East Caribbean Dollar
East Caribbean Dollar
East Caribbean Dollar
East Caribbean Dollar
East Caribbean Dollar
East Caribbean Dollar
Egyptian Pound
Euro
Euro
Euro
Euro
Euro
Euro
Euro
Euro
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

FINLAND
FRANCE
GREECE
MAYOTTE
NETHERLANDS
PORTUGAL
FALKLAND IS
FIJI
HUNGARY
FRENCH GUIANA
GUADELOUPE
REUNION IS
MARTINIQUE
ST PIERRE & MIQUELON
GIBRALTAR
NICARAGUA
HAITI
PARAGUAY
GUINEA BISSAU
GUYANA
HONG KONG
UKRAINE
INDIA
INDONESIA
IRAN
IRAQ
SAN MARINO
VATICAN CITY
JAMAICA
JORDAN
KENYA
PAPUA NEW GUINEA
CZECH REPUBLIC
SLOVAKIA
ICELAND
ESTONIA
CROATIA
KUWAIT
ANGOLA
MYANMAR
GEORGIA
LATVIA
LEBANON
ALBANIA

EUR
EUR
EUR
EUR
EUR
EUR
FKP
FJD
HUF
FRF
FRF
FRF
FRF
FRF
GIP
NIC
HTG
PYG
GWP
GYD
HKD
UAH
INR
IDR
IRR
IQD
ITL
ITL
JMD
JOD
KES
PGK
CZK
SKK
ISK
EEK
HRK
KWD
AOK
MMK
GEK
LVL
LBP
ALL

Euro
Euro
Euro
Euro
Euro
Euro
Falkland Pound
Fijian Dollar
Forint
French Franc
French Franc
French Franc
French Franc
French Franc
Gibraltar Pound
Gold Cordoba
Gourde
Guarani
Guinea-Bissauan Peso
Guyanese Dollar
Hong Kong Dollar
Hryvnia
Indian Rupee
Indonesian Rupiah
Iranian Rial
Iraqi Dinar
Italian Lira
Italian Lira
Jamaican Dollar
Jordanian Dinar
Kenyan Shilling
Kina
Koruna
Koruna
Krona
Kroon
Kuna
Kuwaiti Dinar
Kwanza
Kyat
Lari
Lat
Lebanese Pound
Lek
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

HONDURAS
SIERRA LEONE
ROMANIA
MOLDOVA
BULGARIA
LIBERIA
LIBYA
SWAZILAND
LITHUANIA
LESOTHO
MALAWI
MALTA
TURKMENISTAN
MAURITIUS
MOZAMBIQUE
WESTERN SAHARA
MOROCCO
NIGERIA
NAMIBIA
NEPAL
SERBIA & MONTENEGRO
VIETNAM
ISRAEL
PALESTINE
LAOS
TAIWAN
URUGUAY
DEM REP OF THE CONGO
PITCAIRN IS
COOK IS
TOKELAU
NEW ZEALAND
NIUE
POLAND
BHUTAN
YEMEN
SVALBARD & JAN MAYEN
NORWAY
MEXICO
PERU
OMAN
MAURITANIA
TONGA
PAKISTAN

HNL
SLL
ROL
MDL
BGL
LRD
LYD
SZL
LTL
LSL
MWK
MTL
TMM
MUR
MZM
MAD
MAD
NGN
NAD
NPR
YUN
VND
ILS
ILS
LAK
TWD
UYP
ZRN
NZD
NZD
NZD
NZD
NZD
PLZ
BTN
YER
NOK
NOK
MXN
PEN
OMR
MRO
TOP
PKR

Lempira
Leone
Leu
Leu
Lev
Liberian Dollar
Libyan Dinar
Lilangeni
Litas
Loti
Malawian Kwacha
Maltese Lira
Manat
Mauritian Rupee
Metical
Moroccan Dirham
Moroccan Dirham
Naira
Namibian Dollar
Nepalese Rupee
New Dinar
New Dong
New Israeli Shekel
New Israeli Shekel
New Kip
New Taiwan Dollar
New Uruguayan Peso
New Zaire
New Zealand Dollar
New Zealand Dollar
New Zealand Dollar
New Zealand Dollar
New Zealand Dollar
New Zloty
Ngultrum
North Yemeni Riyal
Norwegian Krone
Norwegian Krone
Nuevo Peso
Nuevo Sol
Omani Rial
Ouguiya
Pa'anga
Pakistani Rupee
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

MACAU
PHILIPPINES
ST HELENA
BOTSWANA
QATAR
GUATEMALA
SOUTH AFRICA
CAMBODIA
MALAYSIA
BELARUS
RUSSIA
TAJIKISTAN
MALDIVES
RWANDA
EL SALVADOR
SAUDI ARABIA
SEYCHELLES
SINGAPORE
SOLOMON IS
KYRGYZSTAN
UZBEKISTAN
SOMALIA
ANDORRA
SRI LANKA
ECUADOR
SUDAN
SURINAM
SWEDEN
SWITZERLAND
LIECHTENSTEIN
GUINEA
SYRIA
SAMOA
TANZANIA
KAZAKHSTAN
SLOVENIA
TRINIDAD & TOBAGO
MONGOLIA
TUNISIA
TURKEY
UGANDA
AMERICAN SAMOA
AZERBAIJAN
BANGLADESH

MOP
PHP
SHP
BWP
QAR
GTQ
ZAR
KHR
MYR
RUR
RUR
RUR
MVR
RWF
SVC
SAR
SCR
SGD
SBD
KGS
KGS
SOS
SPP
LKR
ECS
SDD
SRG
SEK
CHF
CHF
GNS
SYP
SAT
TZS
KZT
SIT
TTD
MNT
TND
YTL
UGX
USD
USD
USD

Pataca
Philippine Peso
Pound
Pula
Qatari Riyal
Quetzal
Rand
Riel
Ringgit
Ruble
Ruble
Ruble
Rufiyaa
Rwandan Franc
Salvadoran Colon
Saudi Riyal
Seychelles Rupee
Singapore Dollar
Solomon Islands Dollar
Som
Som
Somali Shilling
Spanish Peseta
Sri Lankan Rupee
Sucre
Sudanese Dinar
Surinamese Guilder
Swedish Krona
Swiss Franc
Swiss Franc
Syli
Syrian Pound
Tala
Tanzanian Shilling
Tenge
Tolar
Trinidad & Tobago Dollar
Tughrik
Tunisian Dinar
Turkish Lira
Ugandan Shilling
United States Dollar
United States Dollar
United States Dollar
Aramex International | Shipping Information

Your Guide to Embedding Aramex’s
Shipping Services API

BAHAMAS
GUAM
US MINOR OUTLYING IS
MICRONESIA
UNITED STATES
Timor-Lestev
PALAU
MARSHALL IS
NORTHERN MARIANA IS
THAILAND
EAST TIMOR
VIRGIN IS - BRITISH
VIRGIN ISLANDS - US
PUERTO RICO
TURKS & CAICOS IS
VANUATU
KOREA NORTH
KOREA SOUTH
JAPAN
CHINA
ZAMBIA
ZIMBABWE

USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
VUV
KPW
KRW
JPY
CNY
ZMK
ZWD

United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
United States Dollar
Vatu
Won
Won
Yen
Yuan
Zambian Kwacha
Zimbabwean Dollar

Aramex International | Shipping Information

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Page Count                      : 53
Language                        : en-US
Tagged PDF                      : Yes
Title                           : Your Guide to Embedding Aramex’s Shipping Services API
Author                          : Dana Marzouq
Creator                         : Microsoft® Word 2013
Create Date                     : 2013:05:20 16:00:08+03:00
Modify Date                     : 2013:05:20 16:00:08+03:00
Producer                        : Microsoft® Word 2013

EXIF Metadata provided by EXIF.tools

Your Guide To Embedding Aramex’s Shipping Services API Manual

Navigation menu

Versions of this User Manual:

Views

Navigation