Magento Integration (Cario Plugin) 

The Cario Magento Plugin integrates your Magento store with Cario to provide live shipping rates at checkout and automatically create consignments once orders are placed. 

This integration supports the full fulfilment workflow, from shipping rate calculation through to consignment creation and label printing. 

What the Magento Plugin Does 

With the Cario Magento Plugin, you can: 

• Display live shipping rates from Cario during Magento checkout 

• Calculate accurate rates using product weight and dimensions 

• Automatically create consignments in Cario from Magento orders 

• Print shipping labels directly from the Magento admin 
  
  

Important 

The Cario Magento Plugin is installed as a Magento module and must be deployed directly to your Magento environment. 

Installation Overview 

The plugin is installed by deploying the Cario module into your Magento codebase and running the required Magento setup commands. 

Installation Steps (High-Level) 

1. Download the Cario Magento module provided by Cario 
2. Extract the module into the <magento_root>/app/code/ directory 
3. Open a terminal and navigate to your Magento root directory 
4. Clear generated files and caches 
5. Run Magento setup and compilation commands 
6. Log in to the Magento Admin panel 
7. Verify that Cario is available as a shipping method 

Once installed, the Cario shipping method must be enabled and configured with a valid Cario access token. 

Enabling the Cario Shipping Method 

After installation, confirm that Cario is enabled. 

1. Go to Stores 
2. Click Configuration 
3. Under Sales, select Shipping Methods 
4. Locate Cario in the list 
5. Set Enabled to Yes 
6. Save the configuration

Configuring the Cario Access Token 

To allow Magento to communicate with Cario, you must register your store and access token. 

1. Open the Cario Magento registration page 
2. Enter your Store URL 
3. Enter your Cario Access Token 
4. Submit the form 

This step links your Magento store to your Cario account. 

Store Address Configuration 

A valid store address is required to calculate shipping rates and create consignments. 

Cario supports two address sources, prioritised in the following order. 

Shipping Origin (Preferred) 

If configured, Shipping Origin is used first. 

1. Go to Stores 
2. Click Configuration 
3. Under Sales, select Shipping Settings 
4. Enter the origin Country, Postcode, City, and Street Address 

Store Information (Fallback) 

If Shipping Origin is not set, Store Information will be used. 

1. Go to Stores 
2. Click Configuration 
3. Under General, select General 
4. Enter the store Name, Country, Postcode, City, and Street Address 

Product Attribute Requirements 

For shipping rates to calculate correctly, products must include container and dimension data. 

This is achieved by creating custom product attributes in Magento. 

Required Product Attributes 

Attribute	Type	Required
Container	Dropdown	Yes
Length	Text Field	Yes
Width	Text Field	Yes
Height	Text Field	Yes
Weight	Text Field	Yes

The Container attribute must include the following options: 

• Carton 

• Satchel 

Important 
Weight must be marked as a required attribute. If weight is missing, shipping rates will not be returned. 

Attribute Set Configuration 

To simplify product setup, a dedicated attribute set should be created. 

1. Go to Stores 
2. Click Attribute Set 
3. Create a new attribute set named Cario 
4. Base it on the Default attribute set 
5. Add the following attributes to the Product Details group: 
   1. Container 
   2. Length 
   3. Width 
   4. Height 

These attributes should appear before Weight in the attribute order. 

Adding Products 

When adding products to Magento, ensure the Cario attribute set is used. 

Required Product Fields 

• Attribute Set: Cario 

• Container: Carton or Satchel 

• Length 

• Width 

• Height 

• Weight 

All values must be populated for shipping rates to calculate successfully. 

Testing Shipping Rates 

Once products are configured, you can test shipping rates through the Magento storefront. 

Test Flow 

1. Open your Magento store 
2. Add products to the cart 
3. Proceed to checkout 
4. Enter delivery address details
5. Shipping methods will display once Country, City, and Postcode are provided 
6. Select a shipping method 
7. Place the order 

If configured correctly, shipping rates will be returned from Cario. 

Creating Consignments 

After an order is placed, consignments can be created directly from the Magento Admin. 

Creating a Consignment 

1. Log in to Magento Admin 
2. Go to Sales → Orders 
3. Open the order 
4. Click Create Consignment from the top menu 

The consignment will be created automatically in Cario. 

Label Printing 

Once a consignment is created: 

• A confirmation message will be displayed 
• The Connote number will appear under Payment & Shipping 
• Clicking the Connote number will prompt the shipping label for printing