1. Quick How-to.
2. Extension Manual URL Link Button.
Notes for number 3:
1. You don’t have to set Show Debug Info in System > Settings > System in order to get the API response.
2. The API response is shown in System > Logs > Error Logs.
3. Please send us the API response via our support system so we can look into it to trace the issue. You will need to turn OFF the Debug API Response once the issue is fixed, otherwise the error log will grow large.
|
3. Debug API response: Turn ON if you want to get the API response for debugging purpose.
| Notes for number 4: You should use Production mode for your live site by turning OFF the Test Mode. |
4. Test Mode: Use this module in Test (YES) or Production mode (NO).
You will need to get an API key from UPS. Go to the Developer Kit https://www.ups.com/upsdeveloperkit?loc=en_US/
| Notes for number 5: There is only one access issued. |
5. Access Key: Enter the XML rates access key assigned to you by UPS that you have obtained via Step 4 in above image.
6. Username: Insert your UPS Username here.
7. Password: Insert your UPS Password here.
8. Account Number: Insert your UPS Account Number here. This is mandatory if you are using negotiated rates.
9. Pickup Method: Select your pickup method.
How do you give packages to UPS (only used when origin is US)
10. Packaging Type: Select your packaging type.
11. Customer Classification Code:
00 – If you have negotiated/incentivised shipping rates.
01 – If you are an existing customer account prior to January 3, 2011 that provides for Daily Rates, or UPS Scheduled Pickup service implemented prior to January 3, 2011.
04 – If you do not receive UPS Scheduled Pickup service; ship from a UPS retail location, such as The UPS Store® or UPS Customer Center; or ship infrequently with a UPS account number or payment card.
53 – If you have a customized agreement with UPS that provides for Standard List Rates, or a UPS Scheduled Pickup account established on or after January 3, 2011.
12. Use Residential Rate As Default: Turn On if you want to use Residential Rate as the default instead of Commercial Rate on the view cart page.
The checkout page will validate the address whether it’s residential or commercial
13. Negotiated Rates: Turn On if you have the negotiated rates enabled on your UPS Account.
Negotiated rates will be used – your shipper account must have negotiated rates activated AND you must use 00 in the Customer Classification code field.
14. Shipping Origin Code: What origin point should be used (this setting affects only what UPS product names are shown to the user)
15. Origin City: Enter the name of the origin city.
e.g. Montevallo.
16. Origin Zip/Postal Code: Enter your origin zip/postal code.
17. Origin State: Enter your (two/three letters) State code .
18. Origin Country: Enter your (two letters) Country code . For reference click here.
19. Test Your Connection: You can test if API credentials that you’ve entered are correct after you saved the credentials.
20. Services: Select the UPS Services to be offered (The list of services are different based on your origination).
Important Notes:
The Shipper Local Delivery feature doesn’t work with default Fast Checkout extension. You can use our Quick Checkout extension to let customer checkout faster. Refer here to know more about our Quick Checkout extension. |
| Notes for number 21-23: If you are offering Local Delivery Services AND using more than one shipper you must enable Local Delivery Services on only ONE shipper. e.g. you offer FedEx, UPS and USPS, and also Local Delivery – you must enable Local Delivery on only ONE shipper: FedEx, UPS or USPS. |
| Notes for AbanteCart v1.2.16 or higher: If you are using Default Local Delivery extension, then do not use UPS Integration Local Delivery as it will show double Local Delivery services. You can choose to use UPS Integration Local Delivery but do not use Default Local Delivery. Use only ONE Local Delivery service. |
21. Enter Zip/Postal Code(s) eligible to use Local Delivery Service: Use commas(,) without space as the multi Zip/Postal code(s) separator, and no spaces within the Zip/Postal code(s). To define areas use asterisk (*) replacement – eg 351*,350*.
22. Local delivery fee: Enter the local delivery fee if you want to charge customer or leave blank if it is a free delivery.
23. Turn ON to show ONLY Local Delivery Services: Turn OFF if you want to show all shipping options including Local Delivery services.
24. Insert your desired text to be shown on cart page to let customers know about local delivery schedule or services: Insert your desired message.
| Notes for number 25: If you are using more than ONE shipper and are offering any Free Shipping service, you must choose only ONE shipper for the Free Shipping. e.g. if using UPS , USPS and FedEx, Free Shipping can only be offered from one. |
25. If using a Free Shipping option within your cart select which service you are using for the Free United States Shipping (If your location is in USA): Select the UPS Services to be offered for free shipping.
26. If using a Free Shipping option within your cart select which service you are using for the Free International Shipping: Select the UPS Services to be offered for free international shipping.
27. Display Weight: Do you want to display the shipping weight? (e.g. (Weight : 0.17lb) )
Notes for number 28-30: We set a Default of 5 x 5 x 5 which works for most businesses. You can input your normal size if different.
Also, input on a product page will be used for that individual product rate look up. (You need to input individual product size and turn on the Ship Product Individually flag on product page.) |
28. Dimensions Length (Optional): Insert your Box Length here.
29. Dimensions Width (Optional): Insert your Box Width here.
30. Dimensions Height (Optional): Insert your Box Height here.
31. Max Box Weight (Optional): Specifies the maximum box size (just the number). Once the maximum weight is met, the system will calculate shipping for 2(or more) boxes.
32. Tax Class: Choose your Tax Class. The tax is shown in a separate line on invoice.
| Notes for number 33: You may want to restrict the shipping services to be available for certain locations and zones only. To do that you must first create location and set the zones that will be able to use the shipping services. Please refer to our K.B for how to create Location And Location Zones here. |
33. Location: Choose the desired location that the shipping services will be available for.
34. Additional Fee Type: Choose the type that you want to use for the additional Fee. Fixed amount or Rate Percentage based.
35. Additional Fee: Insert your desired Additional Fee value that you want to charge to your customer.
e.g. The rate is $5.00, your fixed additional fee is $3.00, the rate shown to customer is $8. Or if you’re using the percentage instead of fixed rate, and it is 10% from the rate, the rate will be $5.5. To use either fixed or percentage based additional fee, just enter the digits without the % or currency symbol.
36. Additional Weight: Insert your desired additional weight that you want to charge to your customer.
e.g. The weight is 0.26 lb and your additional weight is 0.50 lb, the weight rate will be 0.76 lb. And if showing shipping wt. in cart 0.26 lb is shown to customer.
37. Declared Value: Do you want to Declare Package Value? Yes(On) or No(Off)
The declared value of a package represents UPS’s maximum liability for the package in the case of loss or damage.
For more information, visit UPS Declared Value Q&A.
38. Declared Value Nominal: Enter the minimum nominal that will be used to enable the Declared Value. (If you leave it blank, it will use USD $100 by default)
39. Estimate Message: Insert your desired text to be shown to customers to inform them that rate on cart page was using residential address based rate and not actual, the actual rate will be shown on checkout page based on their address.
Finally Click the Save button and Turn On the extension.
