Shopify Integration (Cario Plugin) 

The Cario Shopify Plugin allows you to integrate your Shopify store with Cario to retrieve live shipping quotes at checkout and automatically create consignments once orders are placed. 

This integration supports end-to-end shipping workflows, from checkout quoting through to consignment creation and label printing. 

What the Shopify Plugin Does 

With the Cario Shopify Plugin, you can: 

• Display live shipping quotes from Cario at checkout 

• Use product weight and dimensions to calculate accurate rates 

• Automatically create Cario consignments from Shopify orders 

• Print shipping labels directly after consignment creation 

Important 
The Cario Shopify Plugin is currently a custom app and is not publicly listed on the Shopify App Store. 

Installation Overview 

The plugin must be installed using a store-specific installation link provided by Cario. 

Note 
Because this is a custom app, it can only be installed on a specific Shopify store and cannot be reused across multiple stores. 

Installation Steps (High-Level) 

1. Open the installation link provided by Cario 
2. Log in to your Shopify store (if prompted) 
3. Enter your Cario Access Token (UAT token during testing) 
4. Authorise and install the app 
5. Once installed, return to your Shopify admin 

Product Setup Requirements 

For shipping quotes to work correctly, products must be configured with the required shipping data. 

Required Product Fields 

Field	Requirement
Weight	Mandatory
Weight unit	Must be kg
Product type	Physical product

Important 
Shipping quotes will not be returned if product weight is missing or incorrectly formatted. 

Container Type & Dimensions 

In addition to weight, the Cario plugin requires container and dimension data to calculate accurate quotes. 

This information is stored using Shopify metafields. 

Required Metafields 

You must create four metafields for each product. 

Metafield Key	Description	Value Type
containerType	Packaging type	String (Satchel or Carton)
length	Length of item	Decimal (string)
width	Width of item	Decimal (string)
height	Height of item	Decimal (string)

Metafield Configuration 

Setting	Value
Namespace	cario
Type	String
Case sensitivity	Keys are case sensitive

Tip 
A metafield management app (e.g. Metafields Custom Field Master) is recommended to manage these fields easily in Shopify. 

Testing Shipping Quotes 

Once products are configured, you can test shipping quotes directly from your Shopify storefront. 

Test Flow 

1. Open your Shopify store 
2. Add a product to the cart 
3. Proceed to checkout
4. Enter delivery address details 
5. Continue to shipping 

If configured correctly, shipping quotes will be returned from Cario at the shipping step. 

Expected Outcome 
Shipping methods and prices displayed are pulled directly from Cario. 

Completing Checkout 

After selecting a shipping method: 

• Proceed to payment 

• Complete checkout (test payments can be used in non-production stores) 

• Order will be created in Shopify 

Creating Consignments in Cario 

Once an order is placed, consignments can be created directly from Shopify. 

Creating a Consignment 

1. Go to Orders in Shopify Admin 
2. Select one or more orders 
3. Click More actions 
4. Select Create Consignment 

Cario will generate consignments automatically. 

Label Printing Behaviour 

Scenario	Behaviour
Single consignment	Label prompt appears automatically
Multiple consignments	Click the Connote number to print labels individually

Important Notes & Limitations 

Important 
Do not create consignments for archived orders. 
Archived orders may cause errors because associated products may no longer exist in the store. 

Tip 
Always ensure product data (weight, container type, dimensions) is complete before testing checkout quotes.