newsupernova/vendor/temando/module-shipping-m2

Magento Shipping Extension

A multi-carrier shipping extension for Magento 2.

Description

The Magento Shipping extension integrates a growing number of shipping carriers into Magento 2.

Getting Started

The following steps are required to configure the Magento Shipping extension.

Activate Magento Shipping

A Magento Shipping account must be created at the Magento Shipping Portal in order to use the extension. To access the portal, you must first log in to your Magento account.

Configure Magento Shipping

Registration provides you with an API endpoint and API credentials to configure the extension. Enter these into the Magento Shipping section of the the Shipping Methods configuration page, which is located at:

Stores → Configuration → Sales → Shipping Methods

Once the API connection is established successfully, complete the following configuration below the main Magento Shipping configuration section:

1. Locations: Shipping origin addresses.
2. Carriers: Connections to carriers.
3. Packaging: Pre-configured containers.
4. Shipping Experiences: Shipping methods and rates. This redirects to the Magento Shipping Portal.

Once this configuration is complete, enable Magento Shipping for checkout using the following drop-down setting in the main Magento Shipping configuration section:

Stores → Configuration → Sales → Shipping Methods → Magento Shipping → Enabled: Yes

Technical Information

The Magento Shipping extension introduces a custom REST API endpoint and public API interfaces.

REST Endpoints

In order to include additional attributes (e.g. value-added services) in the shipping estimation process, the Magento Shipping extension replaces the default estimation endpoint.

/V1/carts/mine/estimate-shipping-methods-by-address-id

Public API

The aforementioned estimation endpoint accepts an additional argument to the Magento_Quote module's implementation: address extension attributes.

\Temando\Shipping\Api\Quote\ShippingMethodManagementInterface::estimateByAddressId

To preserve the selected values during checkout, the additional attributes are persisted in the temando_checkout_address database table. The entities are represented by a public API data model.

\Temando\Shipping\Api\Data\Checkout\AddressInterface

In order to fulfill shipments with Magento Shipping, order and shipment details are sent to the Temando Shipping platform. To establish a link between local and remote entities, the database tables temando_order and temando_shipment are created. The entities are represented by public API data models.

\Temando\Shipping\Api\Data\Order\OrderReferenceInterface
\Temando\Shipping\Api\Data\Shipment\ShipmentReferenceInterface

Support

For Magento Shipping extension support, go to the Magento Shipping Help Centre.

Credits

Magento Shipping is a collaborative work of Temando Pty Ltd. and Netresearch GmbH & Co. KG, leveraging Temando API capabilities within the Magento® e-commerce platform's order processing workflow.

License

For license information, see LICENSE.txt.