VPCart 9.0 DHL readme

DHL

Created : 28 June 2024
Last Modified : 27 September 2024

***********************************************************************************
Contents:

A. SUMMARY
B. FILE STRUCTURE
C. INSTALLATION INSTRUCTION
D. HOW IT WORKS
E. CONFIGURATION SETTINGS
F. DATABASE TABLES MODIFIED
G. LANGUAGE SETTINGS CHANGED
H. CHANGE LOGS
I. TROUBLESHOOTING
J. FAQ
K. COPYRIGHT NOTICE
L. TERMS AND CONDITIONS

***********************************************************************************

A. SUMMARY
==========
This interface is for providing shipping options by DHL.

***********************************************************************************

B. FILE STRUCTURE
===================

Files included in the zip are:
- $READ_ME_FIRST_dhl900.HTML
- dhl_base64.asp
- dhl_config.asp
- dhl_realtime.asp
- dhl_subs.asp
- json/aspJSON1.17.dhl.asp
- admin/shopa_dhl_config.asp
- admin/shopa_dhl_subs.asp
- admin/dhl_setup.asp
- admin/dhl_setup_config.asp
- admin/dhl_setup_process.asp
- admin/help/shoph_dhl.asp
- admin/js/dhl/dhl.css
- admin/js/dhl/dhl.js
- admin/sqlscripts/dhl/*

***********************************************************************************

C. INSTALLATION INSTRUCTION
============================

1. Modify below file:

1a. Open shopshipping_subs.asp

1b. Locate this code:

After this code, please insert:

1c. Locate this code: (Estimate line 182, within routine sub Add_Custom_shipping_options)

'800 - 2015.05.17 - Enhancement: Insert FedEx Shipping code placeholder
if check_fedex_shipping_exist then
dyninclude "fedexinterface.asp"
GetShippingPricesFedex
end if

After this code, please insert:

'ADD DHL
if check_dhl_shipping_exist then
GetRealtime_dhl
end if

1d. Save file shopshipping_subs.asp

2. Upload the below files to your ADMIN folder. If you have renamed your ADMIN folder, then this must be placed in the renamed folder.
- admin/shopa_dhl_config.asp
- admin/shopa_dhl_subs.asp
- admin/dhl_setup.asp
- admin/dhl_setup_config.asp
- admin/dhl_setup_process.asp
- admin/help/shoph_dhl.asp
- admin/js/dhl/dhl.css
- admin/js/dhl/dhl.js
- admin/sqlscripts/dhl/*

3. Upload below files to your Cart folder.
- dhl_base64.asp
- dhl_config.asp
- dhl_realtime.asp
- dhl_subs.asp
- json/aspJSON1.17.dhl.asp

4. Log into super admin and execute page below:
http://www.yourdomain.com/<your admin folder>/dhl_setup.asp

Note: Replace the below with your VPCart site
{ www.yourdomain.com } : your site domain
{ your admin folder } : your admin folder

Click Install Now button.

5. After installation completed, click Next button:

6. You will be redirected to DHL configuration page.

DHL settings:

- How to create App?
Before setting up with DHL, you are required to register with DHL developer account from https://developer.dhl.com/.

After register with DHL, you are required to create an App with your DHL account.

- Do you want to enable DHL module?
Set to Yes to enable DHL module.

- Do you want to run in trace mode?
Set to Yes to enable trace mode for developer purpose.

- Do you want to run in test mode?
Set to Yes to enable test mode.

- What is your DHL account number?
Fill in your DHL account number.

- How to get API key and API secret?

Please follow below guide to create DHL API key and API secret.

1. Browse and open DHL developer portal, then click Log in button at top.

2. Fill in your DHL username and password, then click Login button.
Notes: Register an account if you do not have the developer account.

3. After log into the account, you can now request a API key and API secret for the DHL Express MyDHL API by going here- https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section

4. Click Get Access in the right hand corner, to request your API keys

5a. Enter all required information.

5b. In the section that asks How would you like to use the API? Select the I require credentials to DHL Express-MyDHL API for an existing plugin. Under Requestor Platform Name, type in the name of the software you will be using the credentials in.

5c. Choose the requested services you will be using. And type in about how many requests you anticipate a month.
Please check Rating as the service.
*These numbers are not tied to your credentials and will not impact the credentials if more requests are made than noted on the registration.

6. After your request for an API Key has been submitted, you will be directed to a DHL site confirming the request. You will also receive an email confirming that your request was received.
DHL would take few days to validate and approve your API access.

7. You can also view your credentials in the developer portal in the user dashboard.
Click on the Person Icon to access the User Dashboard.
Then click on Apps
You also can check the App status from this page.

8. If App status is approved, click on the App itself and you will be redirected to the App detail page.
Click Show Key to see API Key and Secret- this is the API key and API secret to use in VPCart.

- Setup source profile
1. Please fill in your company and address information where your shipping source from.

2. You may set to Yes to field "Do you want to use supplier address as source address?", if you would like to send your items from your suppliers.

- Setup dimension profile - global

- Please specify the unit measurement code of package dimensions and weight.
The unit measurement of the dimension and weight.

- Please fill in your parcel width, lenght and height under this section.

- Setup dimension profile - individual product
- You may setup the dynamic parcel width, length and height according to each product, by select the products fields that carry the information of width, length and height.

- Miscellaneous

- Do you want to allow all products to be shipped separately?
Set to Yes to ship all products sparately.

- Do you want to allow certain product to be shipped separately?
Set to Yes to ship certain product sparately.

- What is the field specified in products table to identify to ship product separately?
A field in products table to identify the product to be shipped separately.

- Do you want to split packages automatically if over certain weight?
Set to Yes to split packages automatically.

- What is your weight (lbs) to split packages automatically?
The weight to split packages automatically.

- Is your shipment is dutiable (Yes) or non dutiable (No)?
Yes if you need to declare custom to your shipment.

***********************************************************************************

D. HOW IT WORKS
===============

Provide shipping options from DHL.

***********************************************************************************

E. CONFIGURATION SETTINGS
=================

Refer to DHL configuraiton page

F. DATABASE TABLES MODIFIED
===========================

NONE

G. LANGUAGE SETTINGS CHANGED
============================

New languages for DHL

H. CHANGE LOGS
============================

2024.09.27 - DHL: Weight only allow 3 digit in decimal
2024.09.27 - DHL: shipaddress only allow 45 chars

***********************************************************************************

I. TROUBLESHOOTING
============================

Please submit a ticket to our helpdesk at https://helpdesk.vpcart.com and our support team will assist you.

***********************************************************************************

J. FAQ
============================

NONE

***********************************************************************************
K. COPYRIGHT NOTICE
============================

Copyright (c) 1999-2024 Rocksalt International Pty. Ltd.
All rights reserved.

This software and documentation constitute a published work and
contains valuable trade secrets and proprietary information
belonging to Rocksalt International Pty. Ltd. .
None of the foregoing material may be copied,
duplicated or disclosed without the express written permission
of Rocksalt International Pty. Ltd. .

LICENSEE ACCEPTS VP-ASP Shopping Cart "AS IS" "WITH ALL FAULTS",
Rocksalt International Pty. Ltd. accepts no responsibility for the
operation or performance of the VP-ASP Shopping Cart.
The entire risk of use and consequences of use of the
VP-ASP Shopping Cart falls completely on the Licensee
and Rocksalt International Pty. Ltd. shall not be liable in any respect
for any claims, loss or injury alleged to have resulted
from use of or in reliance on VP-ASP Shopping Cart.

Licensee acknowledges that it has read the foregoing
disclaimers of warranty and limitation of liability
and understands that Licensee assumes
the entire risk of using VP-ASP Shopping Cart.

***********************************************************************************

L. TERMS AND CONDITIONS
============================
ROCKSALT INTERNATIONAL GRANTS TO THE LICENSEE A NON-EXCLUSIVE,
NON-SUB LICENSABLE, NONTRANSFERABLE LICENSE
TO INSTALL AND USE THIS APPLICATION ON A SINGLE DOMAIN FOR
A SINGLE SHOP.

THE CODE IN THE APPLICATION MAY BE MODIFIED FOR USE IN
SETTING UP A SINGLE SHOPPING SITE ON THE WORLD WIDE WEB.

LICENSEE MAY MAKE A COPY OF THE APPLICATION FOR
BACK-UP AND ARCHIVAL PURPOSES, PROVIDED THAT ANY COPY
MUST CONTAIN ALL PROPRIETARY NOTICES INCLUDED
WITH THE APPLICATION.

LICENSEE IS PROHIBITED FROM SELLING OR DISTRIBUTING
THE APPLICATION IN ANY MANNER.

LIMITATION OF LIABILITY.

ROCKSALT INTERNATIONAL AND ITS LICENSORS SHALL
NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY
THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING THIS
APPLICATION.

IN NO EVENT WILL ROCKSALT INTERNATIONAL OR ITS LICENSORS
BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA,
OR FOR DIRECT, INDIRECT, SPECIAL,
CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES,
HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LI
ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE,
EVEN IF ROCKSALT INTERNATIONAL HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.