ShipEngine Integration

v1.3.1 Rev 04 Oct 2021

Overview

ShipEngine Integration is a multi-carrier solution – providing one integration for AbanteCart that can connect to multiple carriers around the globe.
Features:
• Deeply discounted rates from most carriers – or if you have negotiated rates that are better, you can use those.
• Address validation
• Process labels directly from within AbanteCart orders
• Track shipments – Get real-time tracking and delivery notifications so you and your customer know exactly where your package is and when it will arrive.

AbanteCart v1.3.1 use ShipEngine Integration v1.3.1. Tested up to PHP 8.0.
AbanteCart v1.3.0 use ShipEngine Integration v1.3.0. Tested up to PHP 8.0.
AbanteCart v1.2.16 use ShipEngine Integration v1.2.16. Tested up to PHP 7.4.
AbanteCart v1.2.15 use ShipEngine Integration v1.2.15.

Important Notes:
1. Starting with extension v1.2.15 we have adopted a license key for all our extensions. Your extension will only work if you have a validated license key entered for the location where your extension is installed. Refer to here for more details on how license keys work.
2. AbanteCart v1.2.14 is extremely problematic. Install Patch files or better to update to 1.2.15.
Important Note:

  • Weight and length class must be set correctly within the System > Settings > Details page.
  • In Metric locations use: Kilogram in Weight Class fields and Centimeter in Length Class.
  • In US or other non-metric locations use: Pound in Weight Class and Inch in Length Class.
  • Check Changelog for upgrading notes.

Setup

1. Turn ON to use the extension.

Important Notes: If you already have an account in our support system and you are using multiple WHY2 extensions, you do NOT need to create another account in the support system.

2. Enter your WHY2 license code. Refer to How to obtain license code section for more information.
3. Select your desired ShipEngine icon that will be displayed to customer during checkout.
4. Turn ON if you want to set this extension as the default shipping one.
5. Select payment methods that will be only available for this extension.
6. You can leave it blank if you don’t want to set the extension run order.

Obtain ShipEngine API Key

1. Go to the Signup page https://www.shipengine.com/signup.

2. Fill all the fields and click Create Account.


3. You will get an email from ShipEngine to verify your email address. Click Verify Your Account.

4. Login into your ShipEngine account and you will see Sandbox Dashboard along with Sandbox API key (If you are US based user).

5. Click API Management.

6. Click Create New Key.

7. Enter Billing Information.

8. You will get the Live API once you have entered the billing information.

Notes for number 9: ShipEngine carriers paying for postage is handled thru your ShipEngine account added in Step 7.

9. Setup ShipEngine Carriers: Please refer here for how to Setup.

Notes for number 10: Other Carriers paying for postage is handled thru payment arrangements with each carrier.

10. Connect Other Carriers: Please refer here for how to connect.

Additional Setup

Notes: For admins that use our shipper extension, You can use ShipEngine to create shipping label creation and order tracking only, you don’t have to use the lookup.


1. Quick How-to.

2. Extension Manual URL Link Button.

Notes for number 3:
1. You do not 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.

You will need to get an API key from ShipEngine. Refer here for how to obtain ShipEngine API key.

Notes for number 4:
You can use Sandbox API key (available for US user only at the moment) for testing purpose. But all the API work is done for you with this integration. You need to use ShipEngine production API Key for customers charges, acquiring labels and adding tracking.

4. Sandbox/Production API Key: Enter the Sandbox API key you have obtained via Step 4 (US user only) or Production API Key via Step 8 from Obtain ShipEngine API Key section.

Notes for number 5 – 11:
This information will be used as sender upon rate lookup, shipping label creation.

5. Shipper name: Enter your name.

6. Shipper address: Enter your address.

7. Shipper phone number: Enter your phone number.

8. Shipper City: Enter your city name.

9. Shipper Zip/Postal Code: Enter your origin zip/postal code.

10. Shipper State/Province: Enter your (two/three letters) State/Province code.

11. Shipper Country: Enter your (two letters) Country code.

12. Order Status: Select the order status.

Important Notes for number 13: Complete tracking history varies by shipper, usually 90 or 120 days. We store the delivery status in order history if admins use ShipEngine tracking feature, but we only store the 1st and delivered notification.

13. Track order: Select Yes if you want to use ShipEngine Tracking API and automatically track order and your customer will be notified each time there is a change on the order status.

Notes for number 13A – 13B: These fields are only shown if you enable Track order. We only send the first notification with tracking number and the delivered notification to your customer.

A. Send tracking number notification to customer: Turn ON if you want to let customer know their order tracking number. This is only used if you Turn ON Track order but did not use the Shipping label creation.

B. Enter the delivery status update comment: Enter the desired delivery status update comment that will be shown to customer. Please do not remove the [carrier_name], [description] and [tracking_number] from the message as it is used by the extension to change these into the correct information.


a. This is the [carrier_name].
b. This is the [description].
c. This is the [tracking_number].

Notes for number 14: We validate the address upon checkout, your customer will be notified if they are using wrong address.

14. Validate address: Select Yes if you want to use ShipEngine Validate Address API.

15. Shipping label creation: Select Yes if you want to create shipping labels by using ShipEngine shipping label API.

Notes for number 15A – 15G: These fields are only shown if you enable track order. We only send the first notification with tracking number and the delivered notification to your customer.


A. Use USPS paperless label: Turn ON if you want to use USPS paperless label. Click here for more information.

B. Select shipping label format: Select the desired shipping label format.

Notes for 14C: This selection is available for PDF format only.

C. Select shipping label layout: Select the desired shipping label layout.

D. Enter the label image id: Enter the label image id (starts with img) that will be used in the shipping label.

E. Send notification to customer: Turn On if you want to let customer know their order is ready to ship.

F. Enter the order comment: Enter the desired order comment that will be shown to customer after shipping label creation. Please do not remove the [ship_date], [shipper] and [tracking_number] from the message as it is used by the extension to change these 3 into the correct information.

16. Rate lookup: Select Yes if you want to use ShipEngine rate lookup API.

Notes for number 16A – 16Z: These fields are only shown if you enable rate lookup.

A. International shipping: Select Yes if you are doing international shipping.

Important Notes: You need to add SKU to each product as it is used for Customs Form.
Notes for number 16A.1 – 16A.7: These fields are only shown if you enable International shipping.


1. Calculate international duties/tax rate: Turn On if you want to use ShipEngine calculate duties/tax API.
2. Select package content type: Select the package content type that will be used if you are shipping internationally.
3. Select the action if the package is undelivered.
4. Select who is responsible for the tax: Select who is responsible to pay for the tax.
5. Select the tax identifier type.
6. Enter the tax identifier number.
7. Enter (two chars) ISO 3166 Alpha 2 country code that issued the tax identifier.

B. Test Your Connection: You can test if API credentials that you have entered are correct after you saved the credentials.

C. Select shippers: Select the shippers that are connected to your ShipEngine account.

D. Select shipper(s) service: Turn ON the shipper(s) service that you want to use.

Notes: By default we use package if you select NONE as the package type.

E. Select package type.

F. If using a Free Shipping option within your cart select which service you are using for the Free Shipping: Please select what method when cart contains only items with free shipping.

G. If using a Free Shipping option within your cart select which service you are using for the Free International Shipping: Please select what method when cart contains only items with free international shipping.

Notes: Not all shippers support Multi Package. Please refer here for the list of shippers that supports Multi Package.

H. Use multi package rates lookup: Turn ON if you want to use multi package rates lookup.

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 16I – 16L: 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 ShipEngine Integration Local Delivery as it will show double Local Delivery services. You can choose to use ShipEngine Integration Local Delivery but do not use Default Local Delivery. Use only ONE Local Delivery service.

I. 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 – e.g. 351*,350*.

J. Local delivery fee: Enter the local delivery fee if you want to charge customer or leave blank if it is a free delivery.

K. Turn ON to show ONLY Local Delivery Services: Turn OFF if you want to show all shipping options including Local Delivery services.

L. Insert your desired text to be shown on cart page to let customers know about local delivery schedule or services: Insert your desired message.

M. Display Delivery Weight: Do you want to display the shipping weight? (e.g. Weight: 0.15lb).

Notes for number 16N – 16P: 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.)

N. Dimensions Length (Optional): Insert your Box Length here.

O. Dimensions Width (Optional): Insert your Box Width here.

P. Dimensions Height (Optional): Insert your Box Height here.

Q. 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.

R. Tax Class: Choose your Tax Class. The tax is shown in a separate line on invoice.

Notes for section S: 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.

S. Location: Choose the desired location that the shipping services will be available for.

T. Additional Fee Type: Choose the type that you want to use for the additional Fee. Fixed amount or Rate Percentage based.

U. 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 are 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.

V. 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.

W. Select Insurance Provider: Select the Insurance provider that will be used. Click here for more information about Insurance.

X. Declared Insurance Nominal: Enter the minimum nominal that will be used to enable the Declared Insurance Value. (If you leave it blank, it will use $100 by default).

Y. Select Delivery Confirmation Type: Select the Delivery Confirmation type that will be used.

Z. Estimate message: Insert your desired text to be shown to customers to inform them that rate on cart page was using estimation rate and not actual, the actual rate will be shown on checkout page based on their address.

ShipEngine Admin

ShipEngine Product customs code

Notes: This section is only used and the menu is only shown if you enable international shipping.


1. Click Catalog.

2. Click Products.

3. Click the three dots.

4. Click ShipEngine Customs Product Info.

5. Enter product HS Code.

6. Get HS Code: Click this button to open https://hts.usitc.gov/ to obtain HS Code reference.

7. Click Save once you have enter the HS Code.

Shipping Label Creation

Notes: The menu is only shown if you enable Shipping label creation.

Orders Listing Page


1. Click Sales.

2.Click Orders.

3. Click three dots.

4. Click Create shipping label.

Select Service Shipping Label

Notes: You will see this page if you are not using ShipEngine Rate Lookup, but you are using our shipper or default shipper and ShipEngine Shipping label creation. And the available services are the ones that ShipEngine support.

Create shipping label


1. This is the quick note.

2. Select the shipping date: Enter the actual shipping date.

3. Use multi package shipping label creation: Select Yes if you want to use multi package label creation.

4. Click this button if you want to add more package.

5. Select Shipper service.

6. Enter actual box weight.

7. Enter actual box length.

8. Enter actual box width.

9. Enter actual box height.

Important Notes for number 10: You need to enter the package insurance value if you enabled it in the additional settings page number 16.W above otherwise you will get the following error message:

10. Enter package insurance value.

11. Enter line 1 label reference.

12. Enter line 2 label reference.

Notes for number 13: This button only works if you have more than 1 package and you want to remove particular line of package.

13. Click this button to remove this package.

14. Click Create Shipping Label(s) button to start creating the label(s).

Shipping label(s) created


1. This is the success message.

2. This is the actual charged shipping rate.

3. This message is shown if you enable automatic tracking  in the additional settings field number 12.

4. These are the tracking number for each package and the shipping label for each of them.

5. Click this button if you want to void this order shipping label(s).

Shipping label(s) voided


1. This is the success message if this order shipping label(s) are successfully voided.

Order history

 

Note: If you turn ON Send notification to customer, the message in the order comment will be send to your customer.

1. This is the comment that was added right after the shipping label(s) are created.

2.These are the shipping label(s) ID.

Note for number 3: The tracking number will become clickable if you turn ON the Track order option. Otherwise you will see:

3. The tracking number are clickable and will redirect your customer to built in tracking page, so they don’t have to go to shipper URL and track their order from there.

4. This is the comment that was added right after the shipping label(s) are voided.

Single Package Shipping Label

Create shipping label


1. This is the notes that tell you which shipper is this order using, if it support multi package, and if it support custom label message.

2. Select the shipping date: Enter the actual shipping date.

3. Click this button if you want to add more package.

4. Enter actual box weight.

5. Enter actual box length.

6. Enter actual box width.

7. Enter actual box height.

Important Notes for number 8: You need to enter the package insurance value if you enabled it in the additional settings page number 16.W above otherwise you will get the following error message:

8. Enter package insurance value.

9. Enter line 1 label reference.

10. Enter line 2 label reference.

Notes for number 11: This button only works if you have more than 1 package and you want to remove particular line of package.

11. Click this button to remove this package.

12. Click Create Shipping Label(s) button to start creating the label(s).

Shipping label(s) created


1. This is the success message.

2. This is the actual charged shipping rate.

3. This message is shown if you enable automatic tracking  in the additional settings field number 12.

4. These are the tracking number for each package and the shipping label for each of them.

5. Click this button if you want to void this order shipping label(s).

Shipping label(s) voided


1. This is the success message if this order shipping label(s) are successfully voided.

Order history

 

Note: If you turn ON Send notification to customer, the message in the order comment will be send to your customer.
Note for number 1: The tracking number will become clickable if you turn ON the Track order option. Otherwise you will see:

1. This is the comment that was added right after the shipping label(s) are created. The tracking number are clickable and will redirect your customer to built in tracking page, so they don’t have to go to shipper URL and track their order from there.

2. This is the comment that was added right after the shipping label(s) are voided.

Multi Package Shipping Label

Create shipping label


1. This is the quick note.

2. Select the shipping date: Enter the actual shipping date.

3. Use multi package shipping label creation: Select Yes if you want to use multi package label creation.

4. Click this button if you want to add more package.

5. Enter actual box weight.

6. Enter actual box length.

7. Enter actual box width.

8. Enter actual box height.

Important Notes for number 9: You need to enter the package insurance value if you enabled it in the additional settings page number 16.W above otherwise you will get the following error message:

9. Enter package insurance value.

10. Enter line 1 label reference.

11. Enter line 2 label reference.

Notes for number 12: This button only works if you have more than 1 package and you want to remove particular line of package.

12. Click this button to remove this package.

13. Click Create Shipping Label(s) button to start creating the label(s).

Shipping label(s) created


1. This is the success message.

2. This is the actual charged shipping rate.

3. This message is shown if you enable automatic tracking  in the additional settings field number 12.

5. This is the shipping label.

5. These are the tracking number for each package.

6. Click this button if you want to void this order shipping label(s).

Shipping label(s) voided


1. This is the success message if this order shipping label(s) are successfully voided.

Order history

 

Note: If you turn ON Send notification to customer, the message in the order comment will be send to your customer.

1. This is the comment that was added right after the shipping label(s) are created.

2. This is the shipping date.

3.This is the shipping label ID.

Note for number 4: The tracking number will become clickable if you turn ON the Track order option. Otherwise you will see:

4. The tracking number are clickable and will redirect your customer to built in tracking page, so they don’t have to go to shipper URL and track their order from there.

5. This is the comment that was added right after the shipping label(s) are voided.

International Shipping Label

Create shipping label


1. This is the quick note.

2. Select the shipping date: Enter the actual shipping date.

3. Use multi package shipping label creation: Select Yes if you want to use multi package label creation.

4. Click this button if you want to add more package.

5. Enter actual box weight.

6. Enter actual box length.

7. Enter actual box width.

8. Enter actual box height.

Important Notes for number 9: You need to enter the package insurance value if you enabled it in the additional settings page number 16.W above otherwise you will get the following error message:

9. Enter package insurance value.

10. Enter line 1 label reference.

11. Enter line 2 label reference.

Notes for number 12: This button only works if you have more than 1 package and you want to remove particular line of package.

12. Click this button to remove this package.

13. Click Create Shipping Label(s) button to start creating the label(s).

Shipping label(s) created


1. This is the actual charged shipping rate.

2. This message is shown if you enable automatic tracking  in the additional settings field number 12.

3. This is the shipping label.

4. These are the tracking number for each package.

5. Click this button if you want to void this order shipping label(s).

Shipping label(s) voided


1. This is the success message if this order shipping label(s) are successfully voided.

Order history

 

Note: If you turn ON Send notification to customer, the message in the order comment will be send to your customer.

1. This is the comment that was added right after the shipping label(s) are created.

2. This is the shipping label ID.

Note for number 3: The tracking number will become clickable if you turn ON the Track order option. Otherwise you will see:

3. The tracking number are clickable and will redirect your customer to built in tracking page, so they don’t have to go to shipper URL and track their order from there.

4. This is the comment that was added right after the shipping label(s) are voided.

Order Tracking

Notes: The menu is only shown if you enable Automatically track order and Shipping label creation is disabled.

Orders Listing Page


1. Click Sales.

2. Click Orders.

3. Click the three dots.

4. Click Subscribe tracking number

Subscribe tracking number


1. Shipper name: Select the shipper name.
2. Tracking number: Enter the tracking number.
3. Click the save button.

Tracking number subscribed


1. This is the success message if this order tracking number is successfully subscribed.
2. This message is shown to let you know the shipper name and the tracking number for this order.
3. This is the shipper name.
4. This is the tracking number.

Order history


1. This is the comment that was added right after the tracking number is subscribed.

2. The tracking number is clickable and will redirect your customer to built in tracking page, so they don’t have to go to shipper URL and track their order from there.

Create Shipping Manifest

Menu


1. Click Reports.
2. Click Shipping Manifest.
3. Click Create Shipping Manifest to create shipping manifest.
4. Click Shipping Manifest History to see the created shipping manifest.

Create Shipping Manifest

Important Notes:
1. This page only shows the shipping label that was created on current day.
2. Not all shippers require manifest. Please refer here for list of shippers that requires manifest.
3. We save a backup of the manifest file into your server. They are saved in the extensions/shipengine_integration/files folder.


1. Select the shipper name.
2. Click the filter button to filter the orders based by the shipper name.
3. Click this button to reset the filter
4. Click this button to start create the manifest file.
5. This is the link to know the list of shippers that requires manifest.
6. These are the order id.
7. These are the shipping label ID that was created.
8. These are the shippers.
9. These are the shipping label creation date.

Shipping Manifest Created


1. This message is shown if you have successfully create the manifest file.
2. Click this link to download the manifest file.
3. Click this link to go to Shipping Manifest History.

Shipping Manifest History



1. Select the From date: Select the starting date of the manifest file creation date that you want to filter.
2. Select the To: Select the end of the manifest file creation date that you want to filter.
3. Click the Filter button to filter the list.
4. Click here to reset the filter dates.
5. Click here to select the manifest file that you want to delete.
6. This is the manifest id.
7. This is the download link of the manifest file that was saved in your server. If you delete the history then the file will also removed.
8. This is the manifest creation date time.
9. Click this button to delete the selected history.
10. This is the available bulk action option.
11. Click this button to bulk delete the selected manifest history(ies).

ShipEngine Storefront

Address validation

Note: This is only used if you enable Validate address in Additional settings page.

Success

Failed

Email notification

First delivery notification

Delivered notification

Tracking page

Order Details


1. The tracking number is clickable and will redirect your customer to built in tracking page, so they don’t have to go to shipper URL and track their order from there.
2. This is the first delivery status update.
3. This is the delivered status update.

Extension Updater

To assist you in always having the most current and correct version of your extension we have added a feature to notify you in the message section of your admin panel. And directly allow you to update this extension.

After you have installed ShipEngine Integration version 1.2.16 or 1.2.15 or higher the feature will be available.

For details on how the Extension Updater works click here.

Changelog

v1.3.1

2021 – 10 – 04

Support AbanteCart v1.3.1.

v1.3.0

2021 – 06 – 19

Support AbanteCart v1.3.0.

v1.2.16

2021 – 06 – 19

Support AbanteCart v1.2.16.

v1.2.15

2021 – 06 – 19

Initial Release.