DHL/Airborne Shipping Module Information

DHL/Airborne Shipping Module
Table of Contents

- [1] Overview
- [2] Getting Started
  - Setting up an account with DHL/Airborne
  - Obtain your shipping keys
  - Getting access to the rate request API
- [3] Configurations & Options
  - DHL/Airborne API Access
    - System ID
    - Password
    - Shipping Key
    - Account Number
  - Test/Production Server
  - Shipping Methods
  - Estimated Delivery Time
  - Shipment Type
  - Days to Shipment
  - Override Express Saturday Shipping
  - Dimensional Weight
    - Average Dimensions
    - Dimensional Exclusive Option
  - Additional Protection
    - Additional Protection Type
    - Additional Protection Value
  - Handling Fee

[1.0] Overview
This is a shipping module for the DHL/Airborne ShipIt/RateIt XML API. As of this writing, the API is Domestic (US) only. Currently this module only supports shipping rate quotes and does not currently support sending shipments to DHL/Airborne or printing of labels. This functionality is on the To Do List and will be added in the future.
[2.0] Getting Started
You will find information in this chapter that will help in getting setup with DHL/Airborne if you do not already have an account, information on obtaining shipping keys that will be used to get accurate quotes, and how to gain access to the rate request API.
[2.1] Setting up an account with DHL/Airborne
If you do not already have a DHL/Airborne customer number, you may obtain one through DHL ’s website (www.dhl.com). From the USA home page, select Register or Open Account from the list on the left and follow the directions. Once you have your customer number, you are ready to continue.
[2.2] Obtain your shipping keys
Once you have your DHL/Airborne customer number, you will need to fill out the Zen Cart Customer API Sign-up Form & AIRBORNE EXPRESS AGREEMENT FOR CUSTOMERS PDF documents that came packaged with this module (ZenCartAPISignupForm.doc & ShipIT_Customer_Agreement.pdf) and follow the instructions. Once DHL/Airborne has received your signed agreements, a shipping key(s) will be emailed to you.
[2.3] Getting access to the rate request API
Once you have your DHL/Airborne customer number, you will need to fill out the Zen Cart Customer API Sign-up Form & AIRBORNE EXPRESS AGREEMENT FOR CUSTOMERS PDF documents that came packaged with this module (ZenCartAPISignupForm.doc & ShipIT_Customer_Agreement.pdf) and follow the instructions. Once DHL/Airborne has received your signed agreements, a systemID and password to access the API will be emailed to you.
[3.0] Configurations & Options
This chapter explains in detail each configuration variable & option that can be set for the module through the Zen Cart admin → modules → shipping section.
[3.1] DHL/Airborne API Access
These four fields are used to gain access to the ShipIt API and get rate quotes based on your account.
[3.1.1] System ID
This is the system ID/username that DHL/Airborne emailed back to you after they received your signed agreements.
[3.1.2] Password
This is the password that DHL/Airborne assigned to your system ID/username.
[3.1.3] Shipping Key
This is the shipping key that DHL/Airborne assigned to your account after they received your signed agreements.
[3.1.4] Account Number
This is your DHL/Airborne account/customer number.
[3.2] Test/Production Server
You should use the test server when you 1st setup the module to ensure it is working properly. After you have the module setup how you like and verify that it is working properly, you should switch to the production server before you start taking real orders using this module.
** Please Note: Both the test & production servers require a valid system ID, password, & valid shipping key for access.
[3.3] Shipping Methods
This enables you to choose from the several shipping methods DHL/Airborne offers: Ground, Second Day Service, Next Afternoon, Express, Express 10:30 AM, and Express Saturday.
[3.4] Estimated Delivery Time
This option will show the estimated delivery time in the checkout beside each shipping method enabled.
[3.5] Shipment Type
This sets where you are shipping regular packages or letters.
[3.6] Days to Shipment
This sets the shipment date that is used in the rate request to DHL/Airborne. If this is set to 0 and a customer orders on January 1st, 2004; the shipment date sent to DHL/Airborne will be January 1st, 2004. If it is 1, the shipment date will be January 2nd, 2004; etc . . .
[3.7] Override Express Saturday Shipping
DHL/Airborne's API only allows quotes for Express Saturday shipping when the shipping date is a Friday. Use this option to override that (enable Express Saturday shipping quotes when the shipment day is NOT a friday).
[3.8] Dimensional Weight
DHL/Airborne offers the option of providing dimensions. DHL/Airborne then caclculates the dimensional weight using the standard formula (length x width x height divided by 194). If dimensional weight is used, the greater of the two (dimensional weight or actual shipping weight) is used to calculate the shipping quotes. If Dimensional Weight is used, the two options Average Dimensions & Dimensional Exclusive Option must be set. They are explained below.
[3.8.1] Average Dimensions
Average dimensions in units of inches are entered as a table. The formatting is as follows:
#of products ordered:lengthxwidthxheight
A comma should seperate each entry. Example: 1:12x8x2,3:24x10x3
Under the default settings with dimensional weight enabled, the above table would be interpreted as: One or more products ordered, the average package size is 12" long by 8" wide by 2" high; three or more products ordered, the average package size is 24" long by 10" wide by 3" high.
That can be changed to be interpreted as exclusive to number of products instead of that number or more. That option is explained below.
[3.8.2] Dimensional Exclusive Option
This option allows for the average dimensions table to be exclusive to the number of products.
Example: On the above average dimensions table, with this option enabled, the table would be interpreted as: One product ordered, the average package size is 12" long by 8" wide by 2" high; three products ordered, the average package size is 24" long by 10" wide by 3" high.
With this option enabled, in this example, if two products are ordered or if more than three are ordered, dimensional weight is NOT used in the shipping rate request.
[3.9] Additional Protection
This option enables the cost of additional protection (i.e. shipping insurance) to be included in the shipping quote. Please see the DHL/Airborne Service Guide or contact Customer Service for complete details.
[3.9.1] Additional Protection Type
If additional protection is enabled, you will need to select the protection type you want to use. There is only one type of protection:
Asset Protection or Shipment Value Protection (AP): All Risk Asset Protection is available for shipments beyond the published Limit of Liability.
[3.9.2] Additional Protection Value
If additional protection is enabled, the protection value by default is equal to the subtotal of the cart. This field is used to add additional value onto the cart subtotal. Either dollar amounts or percentages can be put into this field.
Example (cart subtotal is $200):
0 or nothing (blank field) - uses cart subtotal of $200 as protection value.
10 - adds $10 to the subtotal, making the protection value $210.
10% - adds 10% of the subtotal, making the protection value $220.
[3.10] Handling Fee
This will add a flat handling fee onto each quote returned.
Close Window [x]