VPCart 9.0 EasyPost readme

UPS (OAuth)

Created : 04 April 2024
Last Modified : 04 April 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 UPS.

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

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

Files included in the zip are:
- $READ_ME_FIRST_upsoauth900.HTML
- ups_oauth_base64.asp
- ups_oauth_config.asp
- ups_oauth_realtime.asp
- ups_oauth_subs.asp
- json/aspJSON1.17.ups_oauth.asp
- admin/shopa_upsoauth_config.asp
- admin/shopa_upsoauth_subs.asp
- admin/upsoauth_setup.asp
- admin/upsoauth_setup_config.asp
- admin/upsoauth_setup_process.asp
- admin/help/shoph_upsoauth.asp
- admin/js/ups/upsoauth.css
- admin/js/ups/upsoauth.js
- admin/images/ups/*
- admin/sqlscripts/upsoauth/*

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

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

1. Modify below file:
1a. Open shopshipping_subs.asp

1b. Locate this code:


After this code, please insert:

1c. Save file shopshipping_subs.asp

1d. Open shopUPSshippingajax.asp

1e. Locate this code:
sub GetUPSRealtime (sweight)

After this code, please insert:
'ups oauth 2.0
if upsoauth_enable then
dim totalweight_upsoauth
GetShippingPrices_upsoauth totalweight_upsoauth
exit sub
end if

1f. Locate this code: (If you are unable to locate below code, you can skip this step)
function check_ups_shipping_exist
check_ups_shipping_exist = false
end function

Change above code to
function check_ups_shipping_exist
check_ups_shipping_exist = true
end function

1g. Save file shopUPSshippingajax.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_upsoauth_config.asp
- admin/shopa_upsoauth_subs.asp
- admin/upsoauth_setup.asp
- admin/upsoauth_setup_config.asp
- admin/upsoauth_setup_process.asp
- admin/help/shoph_upsoauth.asp
- admin/js/ups/upsoauth.css
- admin/js/ups/upsoauth.js
- admin/images/ups/*
- admin/sqlscripts/upsoauth/*

3. Upload below files to your Cart folder.
- ups_oauth_base64.asp
- ups_oauth_config.asp
- ups_oauth_realtime.asp
- ups_oauth_subs.asp
- json/aspJSON1.17.ups_oauth.asp

4. Log into super admin and execute page below:
http://www.yourdomain.com/<your admin folder>/upsoauth_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 UPS configuration page.

UPS settings:

- How to register with UPS?
Before setting up with UPS, you are required to register with UPS from https://www.ups.com.

After register with UPS, you are required to open a UPS account.

- Do you want to enable UPS (OAuth) module?
Set to Yes to enable UPS 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 UPS account number?
Fill in your UPS account number.

- How to get API Keys?

Please follow below guide to create UPS Client ID and Client secret.

1. Browse and open UPS Developer portal, then click Log in button at top.

2. Fill in your UPS username, then click Continue button.

3. Fill in password, then click Log in button.

4. After loggen in, click Create Application button.

5. Click Add Apps link if you have not created the Application yet.

6. Fill up neccesary information as below:
I need API credentails because: I want to integrate UPS technology into my business
Choose an account to associate with these credentials: Select the UPS account or Create a new UPS account
Check the checkbox I agree...
After that, click Next button.

7. Fill up Primary Contact information and Check to specify separate API Integration Owner.
After that, click Next button.

8. Fill up neccesary information as below:
App Name: VPCart
Callback URL: https://www.vpcart.com
Billing Account Number: your UPS account number
Click + icon button for Rating item.
After that, click Save button

9. On App page, copy Client ID and paste to Client ID field.
Copy Client Secret to Client secret field.

- 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
1. Please fill in your parcel width, lenght and height under this section.

- Setup dimension profile - individual product
1. 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.

- Please specify the unit measurement code of the weight
The unit measurement of the weight.

- Do you want to display the negotiated rate?
To show negotiated shipping rate provided by UPS.

- What is your package type?
Your Package type.

- How do you transfer the package to the carrier?
How carrier collect items from you.

- Do you want to include Tax to the shipping charges?
To include Tax to the shipping rates.

- Is your delivery address residential?
Is delivery address residential or commercial area?

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

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

Provide shipping options from UPS.

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

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

Refer to UPS configuraiton page

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

NONE

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

New languages for UPS

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

NONE

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

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.