Shippit works seamlessly with Adobe Commerce to synchronise orders. This article explains how to set up your Adobe Commerce integration, configure it for your unique workflow, and get the most out of Adobe Commerce and Shippit.
💡NOTE: Adobe Commerce is the same product that used to be called Magento 2. In most cases, these instructions also work for Magento Open Source. For instructions covering Magento 1, or OpenMage, see the Magento 1 article.
Set up your Adobe Commerce integration
There are two different ways to get started with Adobe Commerce: you can use the Shippit extension, or install Adobe Commerce using GitHub.
Setting up your Adobe Commerce Shippit extension
Log in to your Shippit account.
Open the drop down menu in the top right of your screen, and click Settings.
Click Integrations to go the integrations settings.
In the Select an Integration section, click Magento2.
In the Sync orders and fulfilments + live quoting section, click Download module to download the Adobe Commerce module.
Follow the prompts to install the module, and take a note of your access key.
Alternatively, if you are working in a Magento Application Structure environment, you can install the Adobe Commerce extension from our GitHub repository instead.
Adding your API key to your Adobe Commerce account
Log in to your Shippit account and navigate to Settings → Integrations.
In the API Secrets sections, copy the API key.
Log in to your Adobe Commerce account, navigate to Stores → Configuration → Sales → Shippit, and unfurl the General settings section.
In the API key field, paste the API key you copied from your Shippit account.
Click Save config to save your settings.
💡NOTE: You can check that your integration has been set up successfully by logging in to your account, navigating to Settings → Integrations, and checking that the Webhook URL field is populated.
Configure your Adobe Commerce integration
When you have your Adobe Commerce integration set up, you can configure it to suit your requirements. All settings must be adjusted in your Adobe Commerce account, you can't configure settings in your Shippit account.
Updating settings in Adobe Commerce
Log in to your Adobe Commerce account.
Navigate to Stores → Configuration → Sales → Shippit
Unfurl each of the sections and adjust settings as required.
Synchronise orders
When you create an order in Adobe Commerce, it appears in the Shippit Order Sync page before it's synchronised to your Shippit account. When you have confirmed the order in your Shippit account and created the shipping label, you can track your orders in the Shippit shipment sync page.
You can configure how you want Adobe Commerce orders to synchronise with your Shippit account.
Configuring order synchronisation
In your Adobe Commerce account, navigate to Stores → Configuration → Sales → Shippit.
Unfurl the Order Sync section, and use these settings:
In the Enabled field, select Yes.
In the Mode field, select Realtime to synchronise orders to Shippit as soon as they are created, select Scheduled to synchronise orders to Shippit every five minutes. Select Custom if you use a custom integration and need an alternative setting.
In the Send all orders to Shippit section, select Yes - All orders to send all orders through to Shippit, select Yes - All Australian orders to send only domestic orders to Shippit, or select No to stop sending orders to Shippit.
Click Save Config to save your settings.
Synchronising orders in Adobe Commerce
In your Adobe Commerce account, navigate to Sales → Shippit order sync.
Orders in this list are synchronised to Shippit depending on your synchronisation settings.
In the Action column, select Sync now to send an order to Shippit immediately, select Schedule sync to send the order with the next scheduled synchronisation, or select Delete to remove the order from the synchronisation queue.
Labelling orders in Shippit
Log in to your Shippit account and navigate to the New Orders page.
Locate the order you are ready to pack, and click Label to print the shipping label.
The order moves to the Ready to Ship page, and tracking information is sent back to your Adobe Commerce account.
For more information about the Shippit New Orders page, see the new orders article.
For more information about labelling, see the shipping labels article.
Synchronising shipments in Adobe Commerce
In your Adobe Commerce account, navigate to Sales → Shippit shipment sync.
Orders in this list are labelled and booked with a carrier. Click the tracking number in the Shippit reference column to open the Shippit tracking page.
To refresh the status, use the controls in the Action column.
Shipping method mapping
You can configure shipping options in Adobe Commerce so that they more accurately match your Shippit settings. These settings allow you to select which shipping method matches a specific service or class in Shippit.
If you offer free shipping, you can manage your shipping costs by identifying the specific service or service class that you would like the order to be transacted through.
⚠️ IMPORTANT: Before you map a service level, make sure you have enabled carriers for that level. You can change which carriers you have enabled in Settings → Carrier settings in your Shippit account.
Changing shipping options
In your Adobe Commerce account, navigate to Stores → Configuration → Sales → Shippit.
Unfurl the Order Sync section, and locate the Shipping method mapping section.
Click Add mapping to add a new mapping. For each shipping method in the left column, select the matching Shippit service type.
To delete a mapped shipping method, click the trash icon.
Click Save Config to save your settings.
💡NOTE: If you select the Click & Collect Shippit service type, a label is generated for the order. As soon as you download the label, the order is moved from the Shippit New Orders page to the Track page.
Synchronise product information
You can configure which product information is synchronised through to Shippit from your Adobe Commerce account.
If you are using the packaged dimensions in Adobe Commerce, you can choose to send product dimensions to Shippit. This prevents Shippit from performing package allocation. If you choose this option, you can turn off the preset and custom package types in your Shippit account. For more information about changing your packaging settings in your Shippit account, see the package allocation settings article.
Synchronising product information
In your Adobe Commerce account, navigate to Stores → Configuration → Sales → Shippit.
Unfurl the Items Sync section, and use these settings:
In the Send product dimensions field, select Yes to send length, width, and height to Shippit, in addition to the product weight.
In the Send product location to Shippit field, select Yes to send product location information to Shippit.
In the Send product tariff codes to Shippit field, select Yes to send the tariff or HS code information to Shippit.
In the Send product country of origin to Shippit field, select Yes to send country of origin information to Shippit.
In the Send dangerous goods codes to Shippit field, select Yes to send dangerous goods information to Shippit.
Click Save Config to save your settings.
Synchronise tracking information
You can synchronise tracking status information from your Shippit account back to your Adobe Commerce account. This updates tracking information for the order in the shopping cart.
Synchronising tracking information
In your Adobe Commerce account, navigate to Stores → Configuration → Sales → Shippit.
Unfurl the Shipping Sync section.
In the Enabled field, select Yes to send tracking information from Shippit to Adobe Commerce.
Click Save Config to save your settings.
Configure live quotes
With live quotes enabled, your customers get real-time shipping rates and options during checkout, based on the total order weight and their delivery address.
You can use live quoting for any service type you currently have enabled in your Shippit account, including international shipping.
⚠️ IMPORTANT: Before you turn live quoting on for a service type, make sure you have enabled carriers for that service type. You can change which carriers you have enabled in Settings → Carrier settings in your Shippit account.
Enabling live quotes in Adobe Commerce
In your Adobe Commerce account, navigate to Stores → Configuration → Sales → Delivery Methods
Unfurl the Shippit - Live Quotes section, and use these settings:
In the Enabled field, select Yes.
In the Title field, type a name for this shipping method. This is shown to your customers at checkout.
In the Allowed methods field, select which service levels to show live quotes for.
Optional: In the Margin enabled field, select Yes - Percentage to apply an additional percentage charge to the live quote, or select Yes - Fixed Amount to apply a fixed additional amount to the live quote. In the Margin amount type the percentage or fixed value to use.
Optional: In the Maximum timeslots field, choose the maximum number of available time slots to show your customers for selection.
Optional: In the Filter by enabled products field, select Yes to only allow live quoting for certain products.
Optional: In the Filter by product attribute field, select Yes to only allow live quoting for products with certain attributes.
Optional: In the Ship to applicable countries field, select Specific countries to only allow live quoting for shipping to some countries. In the Ship tot specific countries field, select the countries you want to enable live quoting for.
In the Sort order field, type a number to indicate where in the list of shipping methods the live quote should appear.
Click Save Config to save your settings.
Checkout options
You can select the various shipping options your customers see at checkout.
Configure checkout options
In your Adobe Commerce account, navigate to Stores → Configuration → Sales → Shippit
Unfurl the Checkout options section, and use these settings:
In the Display authority to leave field, select Yes to display the option for your customers to grant authority to leave. This information is sent to Shippit and the allocated carrier.
In the Display delivery instructions field, select Yes to display the option for your customers to provide delivery instructions. This information is sent to Shippit and the allocated carrier.
In the Hide checkout options for shipping methods, select any carriers you want to hide checkout options for.
Click Save Config to save your settings.
Troubleshooting
This section contains information about some common issues you might encounter with your Adobe Commerce integration. If you can't find an answer to your question here, get in touch with us using the chat in your Shippit account, or reach out to Shippit support.
My orders aren't syncing to Shippit
This can happen for a few different reasons. Check these things first:
Double check that your integration is working by logging in to your account, navigating to Settings → Integrations, and checking that the Webhook URL field is populated.
Make sure the API key shown in both Adobe Commerce and Shippit match.
Make sure the content and format of the customer and delivery information are correct.
Ensure that you have the appropriate carrier services activated in Carrier settings in Shippit.
Check that the order isn't showing a status of Pending or Failed in Adobe Commerce.
I changed or deleted an order in Shippit, but it hasn't changed in Adobe Commerce
Shippit only sends tracking information back to Adobe Commerce. If you need to change details of an order, do so in Adobe Commerce, then synchronise the details to Shippit.
I need to re-sync an order to Shippit
There are a few different ways you can do this from your Adobe Commerce account:
Navigate to Sales → Orders, and select the order or orders to synchronise. In the Actions menu, select Sync with Shippit.
Alternatively, navigate to Sales → Shippit order sync, and locate the order to synchronise. In the Action menu, select Sync now.
I'm not getting Shippit tracking updates in Adobe Commerce
Double check that your integration is working by logging in to your account, navigating to Settings → Integrations, and checking that the Webhook URL field is populated. If the integration is running as expected, make sure that you have the Shippit shipping sync settings turned on. For more information, see the Synchronise tracking information section in this article.