Magento Open Source 2.2.x

Setting Up Magento Shipping

When enabled, Magento Shipping adds Dispatch and Batches options to the Magento Sales menu, a Shipping section to the Stores menu, and new sections of detailed information in each shipment. In the storefront, the selection of available Magento Shipping options appears during checkout.

Step 1: Sign Up for Magento Shipping

On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.

In the panel on the left under Sales, choose Shipping Methods.

Expand the Magento Shipping section. Then, click Access the Magento Shipping Portal here.

When prompted, enter the Email and Password that you use to log in to your Magento account.

Follow the onscreen instructions to request a shipping account. When you receive email confirmation, follow the instructions to complete the process.

Step 2: Generate Your API Tokens

When you receive the confirmation email, open a tab to a separate browser window, and log in to your Magento Shipping account.

You should now have an open tab to your Magento configuration, and another to your Magento Shipping account. Information from your Magento Shipping account will later be pasted into the Magento Shipping configuration in the Admin.

Take a moment to read the Getting Started steps.

In the header, click the question mark (?) to hide the Welcome message and Getting Started steps.

The Account Details section shows your API Endpoint and Account ID.  This information will later be copied and pasted into your Magento configuration.


Account Details

A unique API token is used to identify the connection between your Magento website and your Magento Shipping account.

In the API Tokens section, tap Generate Token for the type of token that you need.

  • Production API Token

    Generates the API token that is needed to use Magento Shipping in production mode.

    Test API Token

    Generates an API token that is needed to use Magento Shipping in test mode.

For a first-time setup, choose Test API Token. When you are ready to “go live” with Magento Shipping, you can use the Production API Token. In the next step you will paste the token into the Magento configuration.


API Tokens
Step 3: Activate Magento Shipping

Set Enabled to “Yes.”

Enter the Title that you want to use for Magento Shipping.

By default, only API errors are logged. If you prefer to log all API communication, set Enable API Logging to “Yes.”

Paste the following credentials from your Magento Shipping account. You will need to return to the browser tab that is open to Magento Shipping, and copy and paste each into the Magento configuration.

  • API Endpoint
  • Account ID
  • API Token

To run Magento Shipping in a testing environment, make sure to generate and copy the test token, rather than the production token.

To give customers the option to have the shipment delivered to a designated drop point other than the standard “ship to” address, set Enable Collection Points at Checkout to “Yes.” Then, choose each country where such alternate collection points are to be available. (Hold down the Ctrl key and click each country.)


Enable Collection Points at Checkout

To allow customers to purchase online, but pick up the order at a designated location, set Enable Click and Collect at Checkout to “Yes.”

Complete the following settings as needed.

Set Ship to Applicable Countries to one of the following:

  • All Allowed Countries

    Customers from all countries specified in your store configuration can use Magento Shipping.

    Specific Countries

    Select each country in the list where Magento Shipping can be used.

Set Show Method if Not Applicable to one of the following:

  • Yes

    Always shows the Magento Shipping method, even when not applicable.

    No

    Shows the Magento Shipping method only when applicable.

In the Displayed Error Message box, type the message to appear if Magento Shipping becomes unavailable.

Enter a Sort Order number to determine the position of Magento Shipping in the list of shipping methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config.

Step 4: Complete the Remaining Settings

The following configuration settings can be completed now, or at a later time.

Checkout View Settings

Magento Shipping Options During Checkout

To complete the Checkout View Settings, tap Configure.


Configure Checkout View Settings

Mark the checkbox of each option that you want to appear during checkout. Then, complete the information in each section as needed.


Checkout View Settings

In the Address Type section, do the following:

Enter the text that you want to use as the Dropdown Label for the Address Type options during checkout.

In the Dropdown Options list, select each option that you want to include as an address type.

Select the option that you want to be used as the Default Value.


Address Type

In the Authority to Leave section, enter the Checkbox Label for the option.


Authority to Leave

In the Signature Required section, enter the Checkbox Label for the option.


Signature Required

When complete, tap Save.

Advanced Settings

To configure the Advanced Settings, tap Configure. Then, do the following:


Configure Advanced Settings

To synchronize Magento with other systems in your stack, set Enable sync to “Yes.”

To synchronize shipment entities, mark the Shipment checkbox.

Tap Save to return to the Magento Shipping section.

When complete, tap Save Config.

Step 5: Complete the Shipping Profiles

The final step of the setup is to complete the Location, Carrier, and Package shipping profiles. After these profiles are complete, you can create Shipping Experience Rules to add logic and automate parts of the shipping workflow.

When the initial configuration is complete, you can access the Magento Shipping Portal directly from the Magento Admin. You can use either of the following methods to access and complete the shipping profile information from the Magento Admin.

The Magento Shipping portal session times out after thirty minutes of inactivity.

Method 1: Menu Options

On the Admin sidebarThe right or left column of a two-column page layout., choose Stores. Then under Shipping, choose the following:

Method 2: Configuration

On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.

In the panel on the left under Sales, choose Shipping Methods. Then, scroll down to the Magento Shipping section. The shipping profile settings are at the end of the section.

Tap Configure to complete each profile. Then, follow the instructions to complete the Location, Carrier, and Package information.

When the profiles are complete, create Shipping Experience Rules to add logic and automate parts of your shipping workflow.


Shipping Profiles