ShipHawk’s Magento 2.0 integration provides organizations with ShipHawk’s order fulfillment functionality directly in the Magento interface. Once installed and setup, ShipHawk allows you to do the following:

• Retrieve carrier rates for sales orders.

• Book shipments.

• Create corresponding shipment orders in ShipHawk.

This functionality is available whether or not your organization is using an additional ERP with your Magento 2.0 storefront. Currently, ShipHawk’s Magento 2.0 extension supports only one store integration at a time.

This guide covers the following topics:

Installation

To use ShipHawk functionality in your Magento 2.0 instance, you must first install the ShipHawk extension. The following sections provide detailed instructions for downloading and installing the ShipHawk plug-in for your organization.

These instructions are intended for your system administrator.

Downloading the ShipHawk extension for Magento 2.0

This section explains the steps to locate and download the ShipHawk extension, which is available for download from ShipHawk’s Gitlab repository. The extension is available as a .zip file.

Downloading the plug-in file

1. Open your internet browser and navigate to ShipHawk’s Github repository: open the following URL to the most recent branch of shiphawk-magento-2.
   https://github.com/ShipHawk/shiphawk-magento-2
   
   IMPORTANT: The Magento 2 plugin has several different versions:
   
   

   Open

   

   
   
   Each version corresponds to a Magento 2 version, and is located in a separate branch. For example:
       Magento 2.4.1 → branch 2.4.1 https://github.com/ShipHawk/shiphawk-magento-2/tree/2.4.1
       Magento 2.4.5 → branch 2.4.5 https://github.com/ShipHawk/shiphawk-magento-2/tree/2.4.5
       Magento 2.4.6 → branch 2.4.6 https://github.com/ShipHawk/shiphawk-magento-2/tree/2.4.6
   Be sure to use the branch that corresponds to your Magento 2 version.
   
   

2. Click the Clone or Download drop-down button and select the Download Zip option.

   Open

   

3. If you are not already signed into Github, a message appears asking you to sign in and opt into updates to this plug-in. This is optional. The file continues to download regardless of what you choose to do.

4. Once the shiphawk-magento-2-master.zip file successfully downloads to your computer, unzip this file using your preferred file archiving software.
   
   You are now ready for installation. Proceed to the next section for installation instructions.

Manually installing the ShipHawk plug-in

ShipHawk does not provide an installation file (.exe or .dmg) that automatically uploads everything into the correct folder in your Magento instance. To install the ShipHawk extension, you must manually transfer the unzipped files from the previous section into your Magento root folder via SSH protocol (also known as Secure Shell). 

The following procedure provides general instructions for performing this installation. Each organization has their preferred software for performing file transfers via SSH, so installation steps are written to address common actions across all programs.

To install the ShipHawk extension

1. Open your preferred SSH client. 

2. Connect to the web server that hosts your Magento instance using the SSH protocol to keep your connection secure. Provide your password when prompted.

3. Navigate to the root folder of your magento-website directory.

4. Copy the app/code/Shiphawk folder in the shiphawk-magento-2 zip file to the /$MAGENTO_ROOT/code/ folder. The result should look like this:
   
   

Congratulations! You have now successfully installed the ShipHawk extension in your Magento instance. Contact your ShipHawk Implementation Representative if you have questions.

Proceed to the next section to refresh your cache and see the new ShipHawk screens in your Magento dashboard.

To refresh your Magento cache

1. Open your browser and log into your Magento Admin panel. Your Magento dashboard appears.
   
   

    

2. Click System > Cache Management in the left-side menu.
   
   

   
   The Cache Management screen appears.
   
   

    

3. Click the Select drop-down button and choose Select All from the available Mass Actions.
   
   

    

4. Click the Actions drop-down button and choose the Refresh option.
   
   

    

5. Click the Submit button. A message appears confirming the successful refreshing of all selected cache elements.
   
   

    

6. Log out of Magento and then log back into Magento.

All ShipHawk functionality is now available. Contact your ShipHawk Implementation Representative if you have questions.

Proceed to the next section to continue with setup items and setting configuration.

Setup & Configuration

This section provides detailed procedures for configuring ShipHawk for your Magento 2.0 instance. Instructions are included for setting up secure communication between your Magento account and ShipHawk’s platform, configuring shipping methods through ShipHawk, and preparing your product catalog for ShipHawk’s carrier rating and fulfillment automation.

Enabling communication between ShipHawk and Magento

Before using ShipHawk functionality, you must first set up reliable and secure communication between ShipHawk and Magento. Magento needs to pull carrier rate information from ShipHawk and ShipHawk has to write shipment details to Magento. This process requires four steps:

• Provide ShipHawk API key credentials to Magento in order to write data securely from  Magento to ShipHawk.

• Create an API user role for ShipHawk in Magento.

• Create an API user and unique API key for ShipHawk in Magento.

• Provide Magento API key credentials to ShipHawk in order to write data securely from ShipHawk to Magento.

The following section provides instructions for configuring settings in both Magento and ShipHawk to enable bilateral communication. 

Get Access Token for ShipHawk Integration

1. In Magento, go to System > Integrations, and locate the entry for ShipHawk. (If you do not have an entry for ShipHawk defined yet, click the red Add New Integration button in the upper right corner, and complete the form.)

2. For the ShipHawk entry, click Edit (the pencil icon).

3. In BASIC SETTINGS: Integration Info, under Integration Details, copy the Access Token value. (You will need to enter this value in ShipHawk.)

4. Now, in ShipHawk, select (settings icon) > Integrations, click on the Magento panel, and in Manage Your Accounts, enter your Store URL, API Key (enter the Access Token value you copied previuosly), and User Name. When done, click Update.

To set up communication in Magento

1. From your Magento dashboard, click Stores > Configuration > ShipHawk Order Options in the left-side menu.
   
   

   
   The Configuration screen appears. The ShipHawk Order Options tab automatically appears with the ShipHawk Order section expanded.
   
   

    

2. Select the Send orders to ShipHawk option from the Order Sync drop-down field.
   
   

    

3. Locate your ShipHawk API key in the ShipHawk platform.

   1. Open a new browser window and log into your ShipHawk account. The ShipHawk dashboard appears.
      
      

       

   2. Click on the Settings  icon > Settings > Developer API. The API Keys screen appears.

       

   3. To connect ShipHawk to your Magento store, you require an API key.

   4. If you are ready to go live with ShipHawk, use the Product Key. Click the Copy button to copy the API key to your system clipboard.

   5. Navigate back to the Magento Configuration screen.

4. Enter the provided ShipHawk API key into the API Key field.
   
   

    

5. Select the correct option from the Gateway Url drop-down field.

   1. If you are ready to go live with the ShipHawk extension, select the Production option.

   2. If you are still going through user testing, select the UAT option.

   3. If you are not ready to go live, select the Sandbox option.

6. Click the Save Config button to save your changes.

Continue to the next section to create a Magento API role.

To create a Magento API Role

1. From your Magento dashboard, click System > User Roles. The Roles screen appears.
   
   

2. Click the Add New Role button. The New Role screen appears.
   
   

3. Enter a unique and descriptive name into the Role Name field under the Role Information section. An example is “ShipHawk API.”
   
   

4. Enter your password into the Your Password field under the Current User Identity Verification.
   
   

5. Click on the Role Resources tab. The Role Resources screen appears.
   
   

6. Click on the Resource Access drop-down button and select the All option.
   
   

7. Click the Save Role button.
   
   

   
   The new role is created. Proceed to the next section to create a new Magento user using the new API role.
   
   

To create a Magento API user

1. From the Magento dashboard, click System > Users. The Users screen appears.
   
   

2. Click the Add New User button. The New User screen appears. The User Info automatically opens.
   
   

3. Complete the fields to create a new user.

   1. Enter a unique and descriptive name into the User Name field under the Account Information section. An example is “ShipHawk API Key.”
      
      

   2. Enter unique and descriptive names into the First Name and Last Name fields. An example is “API Key.”
      
      

       

   3. Enter an email address into the Email field. Select one to which you have access.
      
      

   4. Create a unique password. This password serves as your new API key, which you will provide to ShipHawk to allow bilateral communication.
      
      

   5. Select the correct location for your Interface Locale.
      
      

   6. Set the account to Active.
      
      

4. Click on the User Role tab. The User Role screen appears.

5. Select the ShipHawk API role from the grid below to assign this new user to this role.

6. Click the Save User button to finish.

The ShipHawk API user is now created with a custom API key to allow ShipHawk to successfully communicate with Magento. The Magento side of secure communication setup is now complete. 

The Magento 2.0 integration is a one-sided integration. Users can rate carriers and ship orders from the Magento interface, but they cannot fulfill orders, send information to Magento, or retrieve products from ShipHawk.

Setting up shipping methods

Before you can fulfill orders with ShipHawk, you must set up your shipping methods. The following section provides detailed procedures for configuring the shipping methods and services available for your organization.

To configure ShipHawk shipping methods

1. From your Magento dashboard, click Stores > Configuration > Sales > Shipping Methods > ShipHawk Shipping in the left-side menu.

   
   The ShipHawk Shipping section appears.
   
   

2. If the section is not already expanded, click the Expand icon to view the available configuration items. New fields appear.
   
   

3. Select the Yes option from the Enabled for Checkout drop-down field to display rates from ShipHawk during online checkout.
   
   

    

4. Enter a title for your shipping methods in the Title field.
   
   

    

5. Enter a message for your customers in the Displayed Error Message field to alert them that a shipping method is not currently available.
   
   

    

6. Select the Yes/No option from the Show Method if Not Applicable drop-down field.
   
   

    

7. Enter your preferred shipment sort order into the Sort Order field.
   
   

    

8. Enter the ShipHawk API key into the API Key field.
   
   

   (Note that the API Key can be obtained from the ShipHawk platform’s Settings > Developer API page.)

9. In Gateway Host, enter the URL for environment you are currently working in:
   
   

   
   Configuration of your ShipHawk shipping methods is now complete. Proceed to the next section for instructions on setting up your product catalog for carrier rating.

Setting up products for shipping

Before you can get accurate carrier rates through ShipHawk, you must first provide the dimensions for each product in your product catalog.

Configuring products for ShipHawk rating

1. From your Magento dashboard, click Products > Catalog in the left-side menu.
   
   

   
   The Catalog screen appears.
   
   

    

2. Click the Edit link in the row corresponding to the product that you wish to configure.
   
   

   
   The [Product Name] screen appears.
   
   

    

3. Scroll down and locate the ShipHawk Attributes section.
   
   

    

4. Click on the Expand icon to view the available configuration items in the ShipHawk Attributes section. New fields appear.
   
   

5. Complete the fields and click the Save button. Product dimensions are necessary for ShipHawk to return accurate carrier rates. The units of measurement match the default units of measurement in your system. The value “0” is not an accepted value.

Repeat this procedure for all products in your catalog that you want to be rated by ShipHawk.

Integration in the ShipHawk UI

1. Log into the ShipHawk Dashboard and navigate Settings->Integration.
   
   

    

2. Select Magento 2, enter all necessary information and press Connect.