This is the 2.3 Beta release version of Magento documentation. Content in this version is subject to change. For additional versions, see Magento Documentation and Resources.
Setting Up Magento Shipping
When enabled, Magento Shipping add 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.
To access the Magento Shipping Portal, you must have both a Magento account and a Magento Shipping account. Your access the Magento Shipping portal is based on your Magento account ID.
|1.||On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.|
|2.||In the panel on the left under Sales, choose Shipping Methods.|
|3.||Expand the Magento Shipping section. Then, click Access the Magento Shipping Portal here.|
|4.||When prompted, enter the Email and Password that you use to log in to your Magento account.|
|5.||Follow the onscreen instructions to request a shipping account. When you receive email confirmation, follow the instructions to complete the process.|
|1.||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.
|2.||Take a moment to read the Getting Started steps.|
|3.||In the header, click the question mark (?) to hide the Welcome message and Getting Started steps.|
|4.||The Account Details section shows your API Endpoint and Account ID. This information will later be copied and pasted into your Magento configuration.|
|5.||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.
Return to the browser tab with the Magento Shipping configuration, and do the following:
|1.||Set Enabled to “Yes.”|
|2.||Enter the Title that you want to use for Magento Shipping.|
|3.||By default, only API errors are logged. If you prefer to log all API communication, set Enable API Logging to “Yes.”|
|4.||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.|
- APIApplication Program Interface: A software interface that lets third-party applications read and write to a system using programming language constructs or statements. 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.
|5.||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.)|
|6.||Complete the following settings as needed.|
|a.||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.
Select each country in the list where Magento Shipping can be used.
|b.||Set Show Method if Not Applicable to one of the following:|
Always shows the Magento Shipping method, even when not applicable.
Shows the Magento Shipping method only when applicable.
|c.||In the Displayed Error Message box, type the message to appear if Magento Shipping becomes unavailable.|
|d.||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.)|
|7.||When complete, tap Save Config.|
|1.||The following configuration settings can be completed now, or at a later time.|
The Checkout View Settings determine the options that appear as add-on delivery options during checkout.
|1.||To complete the Checkout View Settings, tap Configure.|
|2.||Mark the checkbox of each option that you want to appear during checkout. Then, complete the information in each section as needed.|
|3.||In the Address Type section, do the following:|
|a.||Enter the text that you want to use as the Dropdown Label for the Address Type options during checkout.|
|b.||In the Dropdown Options list, select each option that you want to include as an address type.|
|c.||Select the option that you want to be used as the Default Value.|
|4.||In the Authority to Leave section, enter the Checkbox Label for the option.|
|5.||In the Signature Required section, enter the Checkbox Label for the option.|
|6.||When complete, tap Save.|
|1.||To configure the Advanced Settings, tap Configure. Then, do the following:|
|2.||To synchronize Magento with other systems in your stack, set Enable sync to “Yes.”|
|3.||To synchronize shipment entities, mark the Shipment checkbox.|
|2.||When complete, tap Save Config.|
A quick rating takes only 3 clicks. Add a comment to help us improve Magento even more.