Your Guide to Embedding Aramex`s Rate Calculator

Transcription

Your Guide to Embedding
Aramex’s Rate Calculator
v
Shipping Rates Calculator
Table of Contents
Version History ......................................................................................................................................................
4
Getting Started: The Rate Calculator .................................................................................................................... 4
Using Rate Service Calculator: How Does it Work? .............................................................................................. 5
1. Xml Structure Diagrams: .................................................................................................................................. 6
2. Data Type Element Description...................................................................................................................... 14
2.1 Client Info .............................................................................................................................................. 14
2.2 Transaction ............................................................................................................................................ 15
2.3 Address ................................................................................................................................................... 15
2.4 Shipment Details ................................................................................................................................... 16
2.5 Date Time............................................................................................................................................... 18
2.6 Shipment Items ..................................................................................................................................... 18
2.7 Attachment ............................................................................................................................................ 19
2.8 Label Info ............................................................................................................................................... 19
2.9 Dimensions ............................................................................................................................................. 19
2.10 Weight ................................................................................................................................................... 20
2.11 Money..................................................................................................................................................... 20
2.12 Volume .................................................................................................................................................. 21
3. RESPONSE....................................................................................................................................................... 21
3.1 Transaction ............................................................................................................................................ 21
3.2 Has Errors ............................................................................................................................................... 21
3.3 List of Notifications .............................................................................................................................. 22
3.4 Total amount ......................................................................................................................................... 22
4. Rate Calculator conditions: ............................................................................................................................ 22
5. Images of the Back-end User Interface .......................................................................................................... 23
Aramex International | Rate Calculator Service 1
4.1 A Valid Request with Account Information ...................................................................................... 23
4.2 A Valid Request without Account Information ................................................................................. 24
APPENDIX: Aramex and General References ...................................................................................................... 25
Appendix A – Product Types ........................................................................................................................... 26
Appendix B – Shipment Payment Methods ................................................................................................... 26
Appendix C – Service Codes ............................................................................................................................ 27
Appendix D – ISO Country Codes .................................................................................................................... 27
Appendix E – Currency Codes ......................................................................................................................... 31
Appendix F – Error Codes and Messages ....................................................................................................... 39
List of Tables
Table 1: Rate Calculator Request Diagram and Description ................................................................................. 7
Table 2: Client Info Child Element Diagram .......................................................................................................... 8
Table 3: Transaction, Origin and Destination Address Child Element Diagram ....................................................
9
Table 4: Shipment Details Child Element Diagram.............................................................................................. 11
Table 4.1: Elaboration on Complex Elements ..................................................................................................... 12
Table 5: Shows the list of Elements present in the Client Info Structure ........................................................... 13
Table 6: Shows the list of Elements present in the Transaction Structure ......................................................... 14
Table 17: List of Elements present in the Address Structure .............................................................................. 14
Table 19: list of Elements present in the Shipment Details Structure ................................................................ 15
Table 20: list of Elements present in the Date Time Structure ........................................................................... 17
Table 21: list of Elements present in the Shipment Item Structure .................................................................... 17
Table 22: list of Elements present in the Attachment Structure ........................................................................ 17
Table 23: list of Elements present in the Label Info Structure ............................................................................ 18
Table 24: list of Elements present in the Dimensions Structure ......................................................................... 18
Table 25: list of Elements present in the Weight Structure ................................................................................ 19
Table 26: list of Elements present in the Money Structure ................................................................................ 19
Table 27: list of Elements present in the Volume Structure ............................................................................... 19
Table 10: Transaction Response Description ...................................................................................................... 20
Table 11: Reply - List of Notifications .................................................................................................................. 20
Table 12: Reply-Total Amount (Calculated Rate) ................................................................................................ 21
Version History
Version
Change
1
Document Creation
2
New Sections
- Rate Calculator
conditions (page 20)
Effective Date
June 2011
1st of January 2013
Getting Started: The Rate Calculator
The Aramex Shipping APIs (Application Programing Interface) allows your system to communicate
directly with our shipping and tracking system over the internet. Our API provides you with wide
varieties of functionalities which enable customers to integrate with Aramex’s system from their
own systems in an automated way. The API provides a secure channel and can be called through
encrypted HTTPS channel. This Document contains a complete guide on how to use the Rate
Calculator API, which is one of the main functionalities required by customers to start shipping.
The Rate Calculator determines how much the customer will get charged for the delivery from the
source of the product to the final destination. The Rate Calculator API also provides these
features:
•
The validation of User name and Password given by the client for a more secure access,
while ensuring that your customer’s privacy is not violated.
•
A wider range of options for customers to provide full details about their shipments,
enabling Aramex to calculate rates more accurately.
•
Validation of address allows the service to prompt the customer for more information in
case of inaccuracy or empty fields with our Address Validation Service.
•
Provides asynchronous transmission, in case the customer would like to send and receive
data asynchronously. In this case, customers need to provide a transaction ID of his own
choice in the request which will be passed back in the reply.
•
Simple processes in which a customer can fill basic information related to shipments and
system will provide the rate.
Using Rate Service Calculator: How does it work?
•
The Rates Calculator uses a Web Service Definition Language (WSDL) will is provided by
Aramex, enabling developers to add reference to the web service in their code. A WSDL
file will be available on aramex.com or can be provided by the Aramex Electronic Data
Interchange (EDI) team. Please contact us for the WDSL files.
•
Once the developer adds the reference to the web service he will be able to build the
request message, through the Rate Request XML, and invoke the service and get a reply
message with the rates.
•
The user must be registered at Aramex with a valid user name and password.
•
Sample Codes will be available in both VB and C# and PHP on aramex.com.
1. Xml Structure Diagrams:
XML request or reply messages have to be constructed as explained below. The Tables below show
the structure, element, child element, semantics as well as the validation conditions in a Rate
Request XML.
Table 1: Rate Calculator Request Diagram and Description
Diagram
Description
Element: Client Info
Purpose: - For client
Validation purposes.
Element: Transaction
Purpose: For the customer
to send any type of data such
as identification data which
will be sent back in the
Reply, easier to track
requests and transactions.
Element: Origin Address
Purpose: To identify the
desired physical shipment
origin location details and
validates them to be a factor
in rate calculation.
Fig.1. Rate Calculator Structure Request
Element: Destination
Address
Purpose: To identify the
desired shipment
Destination location details
and validates them to be a
factor in rate calculation.
Element: Shipment Details
Purpose: Several aspects
about the shipment some
required to be filled, other
aspects are optional if the
customer wished to include
extra features.
Table 2: Client Info Child Element Diagram
Diagram
Description
The user name and
password are
validated to allow
access to the
service.
Version of the API the
customer is using
needs to be specified
in the request
An account number
is an optional field to
identify the
customer. If not
provided system will
provide cash rate.
If an account number
is filled then the
AccountPin, country
code and account
entity are required to
be filled.
Fig.2. Client Info Structure Diagram
Table 3: Transaction, Origin and Destination Address Child Element Diagram
Diagram
Description
The Transaction
element is not validated,
any type of data
(Identification data) can
be included by the
customer in five given
child elements.
Fig.3. Transaction Structure Diagram
The Address Elements
represent the same
diagram for the Origin
and Destination
addresses.
Both are validated
according to the Product
group.
Domestic Product group
(DOM) only accepts the
same Country Code for
Origin and Destination,
as well as a valid city for
this country.
International Product
group (EXP) only accepts
a different Country Code
with valid
Cities.
Fig.4. Transaction Structure Diagram
The Post Code, State or
Province Code fields are
required for countries
that support them.
0
Table 4: Shipment Details Child Element Diagram
Diagram
Description
1
The child elements
containing a “+”
square indicate
Complex Elements.
The complex
elements contain
complex data types
that are further
elaborated on in
table 4.1.
Further Details on
Shipment Details
elements are shown
in table 9.
Fig.5. Shipment Structure Diagram
Table 4.1: Elaboration on Complex Elements
2
Diagram
Description
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“.
Fig.6. Weight 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“.
Fig.7. Money Structure Diagram
ShipmentItem is a
complex element
consisting of four child
elements. Every Shipment
can consist of several
items and each item has
the following:
PackageType, Quantity,
Weight, Comments
Fig.8. Shipment Item Structure Diagram
3
2. Data Type Element Description
Further details on child elements of the Rate Service Calculator 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.
2.1
Client Info
Table 5: Shows the list of Elements present in the Client Info Structure
Element
User Name
Password
Version
Account
Entity
Account
Number
Data Type
Alphanumeric
Alphanumeric
Alphanumeric
Character
Alphanumeric
Required Length Allowed
Values
Description
M
50
A unique user name sent to the customer
upon registration with
http://www.aramex.com
M
50
A unique password to verify the user
name, sent to the client upon registration
with http://www.aramex.com
M
4
V1.0
Based on the WSDL the customer is using
to invoke the web service
C
3
Identification Code/Number for
Transmitting Party. This code should be
provided to you by Aramex.
O
50
The Customer’s Account number
provided by Aramex when the contract is
signed.
4
Account PIN
Account
Country Code
2.2
Alphanumeric
Character
C
50
A key that is given to account customers
associated with the account number, so
as to validate customer identity.
C
2
Two Letter Code Identifying the Country.
Refer to Appendix D
Transaction
Table 6: Shows the list of Elements present in the Transaction Structure
Element
Data Type
Reference 1
Alphanumeric
O
50
Reference 2
Alphanumeric
O
50
Reference 3
Alphanumeric
O
50
Reference 4
Alphanumeric
O
50
Reference 5
Alphanumeric
O
50
2.3
Values
Description
Any Details the Customer would like to
add to be able to identify the transaction
in the future.
in the future.
in the future.
in the future.
in the future.
Address
Table 17: List of Elements present in the Address Structure
Element
Line1
Data
Type
String
Line2
Line3
String
String
Values
M
50
More than 3
characters
O
O
50
50
Description
Additional Address information, such
as the building number, block, street
name.
Additional Address information.
Additional Address information.
5
City
String
C
50
State Or
Province
Code
Post Code
String
C
100
String
C
30
Country Code
String
M
2
2.4
Address City.
Conditional: Required if the post code
is not given.
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.
2-Letter Standard ISO Country Code.
Refer to Appendix D for a complete
list of Country codes.
Shipment Details
Table 19: list of Elements present in the Shipment Details Structure
Element
Data Type
Required
Length
Allowed
Values
Description
Dimensions
Dimensions
O
NumberOfPieces
Integer
M
3
ActualWeight
Weight
M
6
Product Group
String
M
3
EXP, DOM
EXP = Express
DOM = Domestic
Product Type
String
M
3
Product
Type:
“OND”
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
Measurements required in
calculating the Chargeable Weight, If
any of the dimensional values are
filled then the rest must be filled.
Pieces > 0
MAX =
100
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.
For
Product
Group:
“DOM”
6
Payment Type
String
M
1
P,
C,
3
Method of payment for shipment.
Refer to Appendix B for more
details.
Payment Options
String
C
4
Payment
Type = C
ASCC
ARCC
Conditional - Based on the Payment
Type "C"
ASCC = Needs Shipper Account
Number to be filled.
ARCC = Needs Consignee Account
Number to be filled.
Payment
Type = P
CASH
ACCT
PPST
CRDT
Optional - Based on the Payment
Type "P" then it is optional to fill.
CASH = Cash
ACCT = Account
PPST = Prepaid Stock
CRDT = Credit
Services
String
O
25
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
M
100
Goods Origin
Country
String
M
2
Customs Value
amount
Money
C
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"
Cash on Delivery
Money
C
Amount of Cash that is paid by the
receiver of the package.
Conditional - Based on the Services
"COD" being filled.
7
Insurance
Amount
Cash Additional
Amount
Money
O
Insurance amount charged on
shipment.
Money
O
Additional Cash that can be required
for miscellaneous purposes.
Cash Additional
Description
String
C
PaymentType "3" AND
Cash Additional Amount is filled
Collect Amount
Money
C
Transportation Charges to be
collected from consignee.
PaymentType "C" +
PaymentOptions "ARCC"
Items
List(Of
ShipmentItem)
O
Details of the Items within a
shipment. Several items can be
added for a single shipment.
2.5
Date Time
Table 20: list of Elements present in the Date Time Structure
Element
Data
Type
Shipping
Date
Date
M
The date Aramex receives the shipment to
be shipped out.
Due Date
Date
M
The date specified for shipment to be
delivered to the consignee.
2.6
Values
Description
Shipment Items
Table 21: list of Elements present in the Shipment Item Structure
Element
Data
Type
Values
Package
Type
String
C
Weight
Weight
C
Quantity
Integer
C
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.
50
Total Weight of the Items
4
MAX = 100
Number of items
8
Comments String
2.7
C
1000
Additional Comments or Information about
the items
Attachment
Table 22: list of Elements present in the Attachment Structure
Element
File Name
Data
Type
String
Required Length
C
Description
The file name without its extension.
File
Extension
String
C
6
File
Contents
Byte()
C
4 MB
2.8
Allowed
Values
The extension of the file. Our system
accepts any extension
Contents of the file.
Label Info
Table 23: list of Elements present in the Label Info Structure
Element
Data
Type
Report ID
Integer
M
9201
The Template of the report to be
generated.
Report
Type
String
M
“URL” or
“RPT”
Either by URL or a streamed file (RPT).
URL by Default
2.9
Values
Description
Dimensions
Table 24: list of Elements present in the Dimensions Structure
Element Data
Type
Length
Double
Width
Double
Values
C
5
Format:
000.000
MAX = 100
C
5
Format:
000.000
MAX = 100
Description
Measurements required in calculating the
Chargeable Weight, If any of the Dimensional
9
Height
Double
C
5
Format:
000.000
MAX = 100
values are filled then the rest must be filled
Unit
String
C
2
CM, M
Measurement Unit, If any of the Dimensional
CM = Centimeter
M = Meter
2.10 Weight
Table 25: list of Elements present in the Weight Structure
Element Data
Type
Value
Unit
Double
String
Values
M
6
O
2
Description
Format:
000.000
Weight > 0
MAX = 100
Shipment weight.
KG , LB
Unit of the weight
If the Data Entity ‘Dimensions’ are filled,
charging weight is compared to actual and the
highest value is filled here.
2.11 Money
Table 26: list of Elements present in the Money Structure
Element
Data
Type
Currency
Code
String
Values
C
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
C
5
Format:
000.000
MAX = 100
The Monetary value.
For Cash on delivery, the currency must
be in USD.
0
2.12 Volume
Table 27: list of Elements present in the Volume Structure
Element
Required
Length
Value
Data
Type
Double
M
6
Unit
String
O
2
Allowed
Values
Format:
000.000
Volume > 0
MAX = 100
Cm3, Inch3
Description
Shipment Volume.
Unit of the volume
3. RESPONSE
3.1
Transaction
Table 10: Transaction Response Description
Element
Description
Reference 1
The Data entered by the customer in the
Request process.
Reference 2
Request process.
Reference 3
Request process.
Reference 4
Request process.
Reference 5
Request process.
3.2
Has Errors
If there is an error while processing the data entered in a certain field, this element will notify you
immediately and further details can be read in the Notification element.
1
Values Returned
True: An error is identified with your request data; in this case you should fix the request data which is
identified for you in the Notification Message. False: Error Free, your request was successful.
3.3
List of Notifications
Table 11: Reply - List of Notifications
Element
Description
Code
To Identify the notification category.
Message
Deeper description of the Notification.
3.4
Total amount
Table 12: Reply-Total Amount (Calculated Rate)
Element
Description
Currency Code
If Payment Type is specified then the Currency is
as follows:
Prepaid = Origin Currency
Collect = Destination Currency
Third Party = Currency of the Customer Account
Amount
The Monetary Value
4. Rate Calculator conditions:
The result retrieved from the rate calculator will depend on the following conditions:
2
-
If the account details are filled, rate is calculated according to that specified in the
customer’s account.
If the account details are not filled, rate is calculated according to the public rate of the
origin, given that the payment type is P.
If the account details are not filled, rate is calculated according to the public rate of the
destination, given that the payment type is C.
5. Images of the Back-end User Interface
5.1
A Valid Request with Account Information
3
5.2
A Valid Request without Account Information
4
APPENDIX: Aramex and General References
5
Appendix A – Product Types
Product
Type
PDX
Name
Priority
Document
Express
No
Urgent, time sensitive consignments
containing printed matter or document
material
International
Express
PPX
Priority Parcel
Express
Yes
containing non-printed matter or nondocument material
International
Express
PLX
Priority Letter
Express
No
containing printed matter of weight less
than 0.5 kg
International
Express
DDX
Deferred
Document
Express
No
2nd Day Delivery consignments containing International
printed matter or document material
Express
DPX
Deferred Parcel
Express
Yes
2nd Day Delivery consignments
containing non-printed matter or nondocument material
International
Express
GDX
Ground
Document
Express
Ground Parcel
Express
No
Ground delivery consignments containing
printed matter or document material
International
Express
Yes
Ground Delivery consignments containing
non-printed matter or non-document
material
International
Express
GPX
Dutiable Full Description
Product Group
Appendix B – Shipment Payment Methods
Payment
Method
Stands
for
Description
6
P
Prepaid
Transportation Charges payable by shipper
C
Collect
Transportation Charges payable by consignee
T
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
COD
Description
Full Description
Receiver pays the cost of the goods
FIRST
Cash on
Delivery
First Delivery
FRDOM
Free Domicile
HFPU
Hold for pick
up
Noon Delivery
Signature
Required
Sender pays part/or all of the customs charges and the receiver
consignee doesn’t pay anything of the shipping or handling charges.
Receiver picks up the consignment from an Aramex/Partner facility
NOON
SIG
Committed delivery time at destination country.
Committed delivery time BEFORE Noon at destination country.
Physical receiver signature required upon delivery
Appendix D – ISO Country Codes
Country Code Country Name
Country Code Country Name
AF
AL
DZ
AS
AD
AO
AI
LY
LI
LT
LU
MO
MK
MG
AFGHANISTAN
ALBANIA
ALGERIA
AMERICAN SAMOA
ANDORRA
ANGOLA
ANGUILLA
LIBYA
LIECHTENSTEIN
LITHUANIA
LUXEMBOURG
MACAU
MACEDONIA
MADAGASCAR
7
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
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
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
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
8
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
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
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
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
9
GM
GE
DE
GH
GI
GR
GL
GD
GP
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
GAMBIA
GEORGIA
GERMANY
GHANA
GIBRALTAR
GREECE
GREENLAND
GRENADA
GUADELOUPE
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
LC
PM
VC
SD
SR
SJ
SZ
SE
CH
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
ST LUCIA
ST PIERRE & MIQUELON
ST VINCENT GRENADINE
SUDAN
SURINAM
SVALBARD & JAN MAYEN
SWAZILAND
SWEDEN
SWITZERLAND
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
0
KP
KR
KW
KG
LA
LV
LB
LS
LR
KOREA NORTH
KOREA SOUTH
KUWAIT
KYRGYZSTAN
LAOS
LATVIA
LEBANON
LESOTHO
LIBERIA
VN
VG
VI
WF
EH
YE
ZM
ZW
VIETNAM
VIRGIN IS - BRITISH
VIRGIN ISLANDS - US
WALLIS & FUTUNA IS
WESTERN SAHARA
YEMEN
ZAMBIA
ZIMBABWE
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
Currency Code Currency Name
AFA
Afghani
DZD
Algerian Dinar
ANG
Antillean Guilder
ARS
Argentine Peso
MGF
Ariary
AWG
Aruban Florin
AUD
Australian Dollar
AUD
Australian Dollar
AUD
Australian Dollar
AUD
Australian Dollar
AUD
Australian Dollar
AUD
Australian Dollar
AUD
Australian Dollar
AUD
Australian Dollar
BHD
Bahraini Dinar
PAB
Balboa
BBD
Barbadian Dollar
BZD
Belizean Dollar
BMD
Bermudian Dollar
ERB
Birr
1
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
ETB
VEB
BOB
BAD
GBP
GBP
GBP
GBP
BND
BIF
XAF
XOF
XOF
XOF
XOF
XOF
XOF
XOF
XPF
XOF
XOF
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
MALI
TOGO
FRENCH POLYNESIA
WALLIS & FUTUNA IS
CHAD
CANADA
CAPE VERDE
CANARY IS
CAYMAN IS
GHANA
CHILE
COLOMBIA
COMOROS
COSTA RICA
MLF
XOF
XPF
XPF
XOF
CAD
CVE
CVE
CID
GHC
CLP
COP
KMF
CRC
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
2
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
FINLAND
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
EUR
Cruzeiro
Cuban Peso
Cypriot Pound
Dalasi
Danish Krone
Danish Krone
Danish Krone
Denar
Dirham
Djibouti Franc
Dobra
Dominican Peso
Dram
East Caribbean Dollar
Egyptian Pound
Euro
Euro
Euro
Euro
Euro
Euro
Euro
Euro
Euro
FRANCE
GREECE
MAYOTTE
NETHERLANDS
EUR
EUR
EUR
EUR
Euro
Euro
Euro
Euro
3
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
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
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
4
LATVIA
LEBANON
ALBANIA
HONDURAS
SIERRA LEONE
LVL
LBP
ALL
HNL
SLL
Lat
Lebanese Pound
Lek
Lempira
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
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
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
5
NIUE
POLAND
BHUTAN
YEMEN
SVALBARD & JAN MAYEN
NORWAY
MEXICO
PERU
OMAN
MAURITANIA
TONGA
PAKISTAN
MACAU
PHILIPPINES
ST HELENA
NZD
PLZ
BTN
YER
NOK
NOK
MXN
PEN
OMR
MRO
TOP
PKR
MOP
PHP
SHP
New Zealand Dollar
New Zloty
Ngultrum
North Yemeni Riyal
Norwegian Krone
Norwegian Krone
Nuevo Peso
Nuevo Sol
Omani Rial
Ouguiya
Pa'anga
Pakistani Rupee
Pataca
Philippine Peso
Pound
BOTSWANA
QATAR
GUATEMALA
SOUTH AFRICA
CAMBODIA
MALAYSIA
BELARUS
RUSSIA
TAJIKISTAN
MALDIVES
RWANDA
EL SALVADOR
SAUDI ARABIA
SEYCHELLES
SINGAPORE
SOLOMON IS
KYRGYZSTAN
UZBEKISTAN
SOMALIA
ANDORRA
BWP
QAR
GTQ
ZAR
KHR
MYR
RUR
RUR
RUR
MVR
RWF
SVC
SAR
SCR
SGD
SBD
KGS
KGS
SOS
SPP
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
6
SRI LANKA
ECUADOR
SUDAN
SURINAM
SWEDEN
SWITZERLAND
LIECHTENSTEIN
GUINEA
SYRIA
SAMOA
TANZANIA
KAZAKHSTAN
SLOVENIA
TRINIDAD & TOBAGO
MONGOLIA
TUNISIA
TURKEY
UGANDA
AMERICAN SAMOA
AZERBAIJAN
BANGLADESH
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
LKR
ECS
SDD
SRG
SEK
CHF
CHF
GNS
SYP
SAT
TZS
KZT
SIT
TTD
MNT
TND
YTL
UGX
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
USD
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
7
VANUATU
KOREA NORTH
KOREA SOUTH
JAPAN
CHINA
ZAMBIA
ZIMBABWE
VUV
KPW
KRW
JPY
CNY
ZMK
ZWD
Vatu
Won
Won
Yen
Yuan
Zambian Kwacha
Zimbabwean Dollar
8
Appendix F – Error Codes and Messages
Error Code
Error Message
Missing Parameter Error
ClientInfo is empty
OriginAddress is empty
DestinationAddress is empty
ShipmentDetails is empty
ClientInfo - UserName Missing Value Error
ClientInfo - Password Missing Value Error
ClientInfo - Version Missing Value Error
ClientInfo - AccountNumber Missing Value Error
ClientInfo - AccountPin Missing Value Error
ClientInfo - AccountEntity Missing Value Error
ClientInfo - AccountCountryCode Missing Value
Error
ClientInfo - Login Error
ClientInfo - Account Error
ClientInfo - Account Error
UserName is empty
Password is empty
Version is empty
AccountNumber is empty
AccountPin is empty
AccountEntity is empty
OriginAddress - City Missing Value Error
OriginAddress - CountryCode Missing Value Error
DestinationAddress - City Missing Value Error
DestinationAddress - CountryCode Missing Value
Error
City is empty
CountryCode is empty
City is empty
ShipmentDetails - NumberOfPieces Missing Value
Error
ShipmentDetails - ActualWeight Missing Value
Error
ActualWeight - Value Missing Value Error
ActualWeight - Unit Missing Value Error
ActualWeight - Unit Invalid Value Error
ChargeableWeight - Unit Missing Value Error
ChargeableWeight - Unit Invalid Value Error
AccountCountryCode is empty
Invalid username or password
Invalid account information
Account is blocked
CountryCode is empty
NumberOfPieces is less or equal zero
ActualWeight is empty
Value is less or equal zero
Unit is empty
Unit is invalid
Unit is empty
Unit is invalid
9
ShipmentDetails - ProductGroup Missing Value
Error
ShipmentDetails - ProductGroup Invalid Value
Error
ShipmentDetails - ProductType Missing Value
Error
ShipmentDetails - ProductType Invalid Value
Error
ShipmentDetails - PaymentType Missing Value
Error
ShipmentDetails - PaymentType Invalid Value
Error
CashOnDeliveryAmount - Value Missing Value
Error
CashOnDeliveryAmount - CurrencyCode Missing
Value Error
CashOnDeliveryAmount - CurrencyCode Invalid
Value Error
CollectAmount - Value Missing Value Error
CollectAmount - CurrencyCode Missing Value
Error
CollectAmount - CurrencyCode Invalid Value Error
InsuranceAmount - Value Missing Value Error
InsuranceAmount - CurrencyCode Missing Value
Error
InsuranceAmount - CurrencyCode Invalid Value
Error
CustomsValueAmount - Value Missing Value Error
CustomsValueAmount - CurrencyCode Missing
Value Error
CustomsValueAmount - CurrencyCode Invalid
Value Error
Origin Address Error
Destination Address Error
ProductGroup is empty
ProductGroup is invalid
ProductType is empty
ProductType is invalid
PaymentType is empty
PaymentType is invalid
Value is less than zero
CurrencyCode is empty
CurrencyCode is invalid
Any error messages returned by the address
resolver service
Any error messages returned by the address
resolver service
0
1

Your Guide to Embedding Aramex`s Rate Calculator

Transcription

Similar documents

Arabnet 2015 Dubai

die wilgers / r 8800

PointsPlus® Calculator: Quick Start Guide

tweedracht / r 1349000

bronkhorstspruit / r 495000

this pdf document

Mathematics Level 1 and Level 2 SAT II Subject Tests