Skip to content
  • There are no suggestions because the search field is empty.

Self-Managed Shopify Integration

Table of Contents

Overview

Self-Managed Integrations allow you to create integrations from within your CartonCloud account. With the Self-Managed Shopify Integration, orders from your Shopify account can create Sale Orders in CartonCloud and once packed, can mark the order in Shopify as fulfilled along with carrier tracking numbers (if configured). 

You can configure the integration yourself or you can have your customer set the integration up from their CartonCloud login. See How to enable Customers to create their own Self-Managed Integrations. 

Prerequisites

  • This is a paid integration, please ensure you read the included costs below. 

  • Your customer must have a Shopify account.

  • You will need your customer’s Shopify store url and Shopify Store login credentials (which have the permission 'Manage and install apps and channels' enabled). Alternatively, you can enable the permission for your Customer to create their own Shopify Integration. See here for more information.  

  • The product SKU in Shopify must match the product codes in CartonCloud.

  • The following Custom Fields are optional, but should you wish to use them, they must be set up before building the integration and only Custom Fields with the "Field Type" Text are accepted:

    • Shopify Order Shipment Method Field: Sale Order Custom Field 
  • The following fields are automatically populated and created by the integration:  
    • Carrier Name Field
    • Carrier Tracking Number Field
    • Carrier Tracking URL Field

  • The Customer in CartonCloud must have access to the Warehouse the orders are being mapped to from Shopify.

  • If you are a Customer user, you must ensure your CartonCloud account owner has given you permission in your account to create your own Self-Managed Integrations. Please reach out to your account owner for this access. 

Limitations 

  • Changes to orders will not be made in CartonCloud. Once CartonCloud has the order from Shopify, the order will not be updated if the order is changed within Shopify. 
  • If an order is originally from a location in Shopify that is not a CartonCloud mapped location, and it then changes to a CartonCloud mapped location, CartonCloud will not be notified of this order.
  • The integration automatically identifies the whether the order is a Pick-up or Delivery. The Shopify store owner will need to ensure they have enabled "Pick-up" for the Shopify location:
    https://help.shopify.com/en/manual/fulfillment/setup/delivery-methods/pickup-in-store

Cost 

$10 per week per integration billed weekly

Available Workflow 

  • A Shopify order creates a Sale Order in CartonCloud.

  • When marked “Packed”, the Sale Order in CartonCloud marks the order as fulfilled in Shopify (with carrier tracking details if setup).

How to create a Self-Managed Shopify Integration 

  • Navigate to the Integrations page by typing in Integrations in the Search for Anything bar or More>Self-Managed Integrations.

  • If an Admin user, select the customer you wish to create the integration for.

  • Select Shopify from the Self-Managed Integrations menu selection.

 

  • Click Configure.

  • The configuration box will now appear, follow the below steps to configure the integration.

(1) Initial Configuration

  • Fill in the Name field. Ensure the name includes the name of the customer. If you are creating a Shopify integration for multiple customers you will need to be able to easily identify the different integrations.
  • Click Next.

(2) Authentication

  • You will now need to connect CartonCloud to the correct Shopify account.Click Connect against the CartonCloud tile. Once the status dot icon next to the CartonCloud logo has turned green the connection has been successful.

  • To connect Shopify, you will need your Customer’s Shopify store domain. This can be found in the url of the Shopify account. You will only need to include the url after store/. Replace YOUR-SHOPIFY-DOMAIN with your Shopify store domain. 

  • Click Connect. 

  • You will be prompted to log into the Customer’s Shopify account. You will require the Customer’s Shopify login credentials. 

  • Once the status dot icon has turned green the connection has been successful.

  • Click Next.

 

(3) Order Creation

  • Here you will need to set up configurations to enable order creation from Shopify to CartonCloud. In addition you will be able to map the Custom Fields set up in your CartonCloud account to the necessary fields in Shopify. This is an important step and if not done correctly the integration will not work. Ensure you have read the pre-requisites and have the required Custom Fields set up. 
    • Require Payment Prior to Sale Order Creation: with this enabled only orders that are paid in Shopify will be created in CartonCloud. 
    • Location to Warehouse Mapping: select the correct Shopify Location against each CartonCloud Warehouse. A Shopify Location is any physical place or app where you either sell products, shop or fulfil orders or stock inventory. By mapping the locations to your Warehouse Locations, Shopify will know what orders to send to which CartonCloud warehouses. 
    • Shopify Order Shipment Method Field: select the correct Sale Order Custom Field that holds the shipment method information. This field is optional. 
    • Shopify Order ID Field: select the correct Sale Order Custom Field from the drop down menu. This is the Sale Order Custom Field in CartonCloud that holds the Shopify Order ID.  This field is mandatory.
  • Click Next. 

(4) Fulfilment 

  • Complete Fulfilment through CartonCloud: enabled this will create Fulfilments in Shopify once the Sale Order is packed in CartonCloud. 
  • Notify Customer of Fulfilment: with this enabled the order recipient will be notified by Shopify when the order has been fulfilled 
  • Carrier Name Field: select the correct Sale Order Custom Field that holds the carrier information. This field is optional. 
  • Carrier Tracking Number Field: select the correct Sale Order Custom Field that holds the carrier tracking number information. This field is optional. 
  • Carrier Tracking URL Field: Outbound Order custom field to retrieve the Carrier Tracking URL. 

Testing 

Once you have created the Self-Managed Shopify Integration it is suggested that you test the integration with a test order.

If you have any questions or issues please contact support via CartonCloud Help. 

Disconnecting a Self-Managed Shopify Integration 

If you need to cancel and disconnect the integration you will need to:

  • Navigate to the Integrations page.

  • Select the relevant Customer. 

  • Click Shopify.

  • Select the three-dot configuration icon and select Delete Integration.

  • This will remove the integration and stop the billing of the integration to your account. 

 

Editing an existing Self-Managed Shopify Integration 

To edit an existing Self-Managed Xero Integration:

  • Navigate to the Integrations page.

  • Select the relevant Customer.

  • Click Shopify Orders.

  • Scroll down to Instances.

  • Select Reconfigure.

 

Managing Self-Managed Integrations

Because Self-Managed Integrations are a paid feature, it is important you are able to manage and keep track of the number of active integrations your customer's have. This is useful if you wish to pass on the cost to your customer and reconcile your invoices. 

If a Customer has a live integration they will have a green dot icon against their name. It will also display the number of active integrations for that customer below their name. 

 

Troubleshooting Steps 

If you are experiencing issues with your Self-Managed Integration and orders are not coming through to CartonCloud then you will need to check the Import Log for why the orders are failing. See Import Log for information on how to read the Import Log and diagnose the issue. 

Other things to check include:

  • Is the Warehouse to Shopify Location Mapping you have set up match the Location set up in Shopify? Is there a new Shopify Location that is not yet configured in your mapping? 

For Shopify specific troubleshooting steps please see Self-Managed Shopify Troubleshooting

If you require further assistance with your Self-Managed Xero Integration please reach out to the team for assistance via CartonCloud Help.