Docs
Sign in

Shopify connector setup

Updated May 26, 20265 min read

This guide walks you through connecting your Shopify store to Carriyo using the connector. For an overview of what the integration does, see the Shopify connector overview.

The setup proceeds through:

  • Setting up the connector in Carriyo
  • Creating a Shopify custom app
  • Creating Shopify webhooks
  • Other settings
  • Configuration options

Setting up the connector

1. On the Carriyo Dashboard, navigate to Settings → Integration / Connectors and click the Shopify icon in the connector apps list.

2. The setup wizard takes you through every step. Select the merchant from the dropdown and give the store a name. Click Next.

3. Enter your Shopify store domain name and continue. Use Go back at the bottom-left to change any details.

Once you reach this screen, Carriyo is ready for you to create the Shopify custom app.

Creating a Shopify custom app

1. Go to your Shopify store and open the Shopify Settings.

2. Select Apps and sales channels from the left menu and click Develop apps.

3. Click Allow custom app development.

4. Click Create an app to proceed.

5. Provide an app name such as Carriyo Integration.

6. Click Configure Admin API scopes. This is where you manage permissions.

7. Enable the following permissions. Use the search box to locate each scope:

8. Repeat for the following scopes and then click Save:

  • write_orders, read_orders
  • read_locations
  • read_fulfillments, write_fulfillments
  • read_merchant_managed_fulfillment_orders, write_merchant_managed_fulfillment_orders
  • read_returns, write_returns
  • read_products
  • read_customers
  • read_shipping

Click Install App. Shopify takes you to the API credentials screen.

9. Click Reveal token once and store the value somewhere safe. It will not be shown again. If you miss it, reinstall the app to generate a new token.

10. Back in the Carriyo Dashboard, paste the token in the Shopify API access token field and click Next.

11. Choose the integration mode for your store orders. See the Shopify connector overview for the difference between Fulfillment Flow and Order Flow.

Creating Shopify webhooks

Webhooks let Shopify send order, fulfillment, product, and inventory events into Carriyo.

1. Go to your Shopify store admin settings, open the Notifications panel, and scroll to Webhooks.

2. Copy your Shopify webhook shared secret and paste it into Carriyo.

3. The setup wizard lists the webhook events Carriyo needs along with the delivery URLs. Note each event name and copy the URL.

4. In Shopify, go back to Store Settings and click Notifications → Webhook → Create webhook. Select the event and paste the URL from Carriyo. Start with Fulfillment creation and click Save.

5. Repeat for seven more webhooks: fulfillment update, product creation, product update, product deletion, inventory item creation, inventory item update, and inventory item deletion.

6. Once complete, the eight webhooks should appear in your Shopify webhook list.

Other settings

Location mapping

In the next step of the wizard, map each Shopify location to a unique Carriyo location. You can return to this any time from Settings → Integration / Connectors → Shopify → Location Mapping.

Auto-book

The last step in the wizard controls the shipment booking process. Enable auto-book to book all incoming shipments automatically.

Configuration options

The connector offers further options to refine the integration:

  • Display shipping rates on the checkout page
  • Delivery types mapping
  • Display the carrier's tracking page

Display shipping rates on the checkout page

1. Under Settings and Options, enable the Checkout page shipping rates integration to Shopify toggle. With this on, Carriyo shows carrier shipping rates on the Shopify checkout page.

2. With the toggle on, enable two additional scopes in your Shopify custom app under Admin API access scopes: read_shipping and write_shipping.

3. After enabling the scopes, click Verify Access in the wizard.

4. Copy the API secret key from Shopify and paste it into the Shopify API Password field on the Carriyo connector setup page.

5. If the toggle is on, configure your carrier accounts to use Carrier Shipping Rates (the carrier's live rate API). If the toggle is off, configure Service Information in Settings instead.

6. Future shipments will show shipping rates on the checkout page under Shipping method.

For a deeper walkthrough of the rates feature, see Display carrier shipping rates on the Shopify checkout page.

Delivery types mapping

Define delivery types under Settings → Shipments Attributes → Delivery Types.

Once defined, map them to Shopify shipping codes from Integrations → Connectors → Shopify → Delivery Types Mapping.

Display the carrier's tracking page

You can display the carrier's tracking page instead of the Carriyo tracking page. Enable the feature on the Shopify connector under Integration → Connectors.

Once enabled, shipments created via Shopify show the carrier's tracking page instead of Carriyo's.

Your Shopify store is now connected to Carriyo. Test the integration by creating a new order in Shopify and confirming it appears in Carriyo. You can update settings any time under Integrations → Connectors.