1. Metapack
  2. Shipping
  3. Integrations
  4. Integrating with Shopify

Configuring the Shopify Integration

Configuring the Shopify integration involves the following:

  • Setting up Delivery Manager to work with the integration.

  • Setting up the Shopify Admin app to work with the Delivery Options API.

Setting up Delivery Manager

In Delivery Manager, you will do the following:

  • Make a note of summary information about your warehouses.

  • Make a note of codes for your carrier service groups.

  • Review (and modify) cutoff times for each of your carrier services.

  • Review the shipping charges (presented to shoppers at checkout) for each of your carriers.

To set up Delivery Manager for the integration, complete the following steps:

  1. Log in to Delivery Manager.

    Metapack login screen

  2. Click Setup.

    Metapack DM Navigation bar. The gear icon for Setup is shown selected.

  3. Scroll to the Warehouses section and click Warehouses.

    DM Setup page. The Warehouse button is shown marked.

    The warehouses (shipping locations) associated with your shipper account will display.

    Setup Warehouses page. Shows warehouse code, name, address, & phone headings.

  4. Make a note of the following information for each warehouse:

    • Warehouse code

    • Name

    • Address

    • Phone number

  5. Click Setup in the navigation bar again.

    Metapack DM Navigation bar. The gear icon for Setup is shown selected.

  6. Click Service Groups in the Service Groups section.

    Shows the Service Groups button on the Service groups section.

  7. Make a note of the code for each carrier service group that you want displayed by the Delivery Options API in Shopify.

    dm_service_groups_page.png

  8. Click Setup in the navigation bar again.

    Metapack DM Navigation bar. The gear icon for Setup is shown selected.

  9. Click Configure carriers in the Carriers and Services section.

    Shows the Configure Carriers button in the Carriers & Services section of the DM Setup page.

    Under Services, active (and inactive) carrier services associated with your shipper account are listed.

  10. Click Set cut off times under Active Services,for each carrier service.

    dm_carrrier_active_services.png

  11. Review the Cutoff and Web cutoff times for each carrier service in the Cutoff-Time Details page to ensure that there is sufficient time between ordering and despatch.

    Change the cutoff times as required.

    dm_carrier_services_cutoff_times.png

    In the example shown, the web cutoff time is two hours before the cutoff. This means that there is confidence that your fulfilment team can accept and despatch an order within 2 hours to meet the delivery date presented to a shopper.

  12. Go back to the Configure Carriers page, and click Select a carrier > Set charges.

    dm_carrier_setup_set_charges.png

  13. Select a charge type and add rules for carrier services, applicable areas (countries or zones), and applicable warehouses under the Add Charge Rule(s) section.

    dm_carrier_setup_add_charge_rules.png

You have now completed setting up Delivery Manager for the integration.

Shipping Charges

Shipping charges are not required for parcel allocation. They are not usually defined by Metapack Professional Services implementation consultants when setting up shipper accounts for new Metapack shipping customers. However, if you want to use the Delivery Options API or the Shopify integration, you must set up shipping charges in Delivery Manager.

For more information about configuring shipping charges, see Setting up the Carrier Charges.

Setting up the Shopify Admin app

In the Shopify Admin app, you will do the following:

  • Configure Metapack as an available delivery method.

  • Configure API request parameters that are passed to the Delivery Options API.

  • Configure the delivery options presented to shoppers on the product pages and checkout pages of your eCommerce website.

Note

If you want to use the Delivery Options API to return retail store locations for the integration, you must first use Metapack Location Services to set up your own stores for the API. For more information about this, see Setting up your Own Stores.

To set up the Shopify Admin app for the integration, complete the following steps:

  1. Log in to the Shopify Admin app.

  2. Click Apps > Metapack.

  3. Enter in the Host Name field the name of the Metapack Options host server provided by Metapack Professional Services.

  4. Enter your Delivery Options API key in the API key field. (Provided by Metapack Professional Services or your Metapack account manager, whichever is applicable).

    Shows Metapack integration interface in Shopify Admin app, showing Step 1 / 4. The form displays text fields for Hostname set to https://dmo.metapack.com and an API key masked with characters, with a green Save button below the fields.

  5. Click Save.

  6. Configure Delivery (Home/Business) as follows:

    • Select the Enable check box to display Delivery (Home/Business) to users in checkout.

      Otherwise, this option will not be displayed to shoppers.

    • Enter in the Delivery Service Groups field the Metapack Delivery Manager service groups that relate to Delivery (Home/Business) services.

    • Click Enable Nominated Day Delivery if you want to allow users to choose a specific day for delivery.

    • Enter in the Nominated Day Delivery Service Groups field the Metapack Delivery Manager service group that relates to Nominated Day Delivery.

      Shows Step 2 of 4 for a Delivery Home or Business configuration form. The left side contains instructional text for setting up delivery options. The right side displays interactive fields with Enable and Enable Nominated Day Delivery checked, Delivery Ser

  7. Click Save.

  8. Configure Store Collection as follows:

    • Select the Enable check box to display retail Store Collection to users in checkout.

      Otherwise, this option will not be displayed to shoppers.

    • Enter in the Service Groups field the Metapack Delivery Manager service groups that relate to Store Collection services.

    • Set a Minimum number of retail stores you want to display to users at checkout.

      Metapack recommends setting this to 2 or 3.

    • Set a Maximum number of retail stores you want to display to users at checkout.

      Metapack recommends setting this to 5.

    • Set a Radius for the search area to 1000, 2000, 5000, or 10000 metres.

      Store Collection configuration form. The left side lists instructional text, while the right side displays interactive fields with Enable checked, Service Groups set to STANDARD, Minimum at 1, Maximum at 5, and Radius set to 2000.

  9. Click Save.

  10. Configure Local Collection Point as follows:

    • Select the Enable check box to display local collection points to users in checkout.

      Otherwise, this option will not be displayed to shoppers.

    • Enter in the Service Groups field the Metapack Delivery Manager service groups that relate to Local Collection Point services.

    • Set a Minimum number of collection points you want to display to users at checkout.

      Metapack recommends setting this to 2 or 3.

    • Set a Maximum number of collection points you wish to display to users at checkout.

      Metapack recommends setting this to 5.

    • Set a Radius for the search area to 1000, 2000, 5000, or 10000 metres.

      Shows Local Collection Point configuration form. The left side lists instructional text, while the right side displays fields with "Enable" checked, "Service Groups" as "STANDARD", "Minimum" at 1, "Maximum" at 5, and "Radius" at 2000 above a green "Save d

  11. Click Save.

  12. Configure Default Warehouse as follows:

    • Enter in the Default Warehouse Code field the code of any warehouse defined in your Metapack shipper account.

      Shows a New warehouse configuration form. The left side includes text explaining how to add shipping origins for Metapack. The right side displays filled-in text fields including Label and Warehouse code set to DEFAULT, Address line 1 set to 2000 Gray Inn

    • Optional: Fill in all the address data of the default warehouse.

    • Select the Warehouse country.

    • Paste the Warehouse postcode.

    • Click Create Warehouse.

    • Optional: Add multiple warehouses, if needed.

  13. Click Save.

  14. Configure Default Package Dimensions as follows:

    (These are required for Store Collection and Local Collection Point.)

    • Set the Default Parcel Height, Width, Depth, and Weight that will be used for requests to Metapack.

      Shows Default Package Dimensions configuration form. Left side text tells that these values are sent to Metapack for Click & Collect & local collection point rates. Right side shows fields for Default Parcel Height, Width, Depth, and Weight, all set to 1,

    • Click Save.

  15. Configure Shipping Zones as follows:

    Click Edit and enter the code of the warehouse defined in your Metapack shipper account that relates to the Shopify shipping zone.

    Shows Step 4-of-4 for a Shipping Zones configuration form. The left side includes text explaining that Shipping Zones allow you to configure which destination countries are serviced by your shipping origins. The right side displays a table listing countri

  16. Click Save.

    After you complete setup and configuration, you need to add Metapack App to your Shopify checkout.

  17. Add Metapack App to your Shopify checkout as follows

    • Click Open checkout settings in the success page or go to Settings > Checkout, then click Customize on your active checkout.

    • Open the Shipping page in the editor's sidebar.

    • Click Add app block, and choose Metapack Delivery Options.

    • Paste the App URL into the block's settings panel on the side: https://metapack-app.eu-west-1.prd.aws.metapack.io.

  18. Click Save.

  19. Recommended:

    Once installed, the Metapack app delivers shipping rates dynamically through our carrier service, based on the delivery option your customer selects in the checkout app block. We recommend you do the following:

    • Go to Shopify Admin > Settings > Shipping and delivery.

    • Open each shipping profile that applies to the zones Metapack will serve.

    • Remove within each zone (or move to an unused profile) any manual rates, flat rates, or third-party carrier rates that are not provided by Metapack.

    • Leave only the Metapack carrier service active for those zones.

    • Save your changes and run a quick test checkout to confirm only Metapack-provided rates appear alongside the checkout app block selection.

  20. Optional: Follow these steps to allow shoppers to check delivery options on product details pages, enable the Product Display Page Widget:

    • Click Online Store > Themes.

    • Select your desired theme and click Customize.

    • Go to the Product page of your theme.

    • Click Add Block under Product Information.

    • Click Metapack Shipping Options in the list provided.

    • Move the Check Shipping Options block to the desired location on the page.

You have now completed setting up the Shopify Admin app for the integration.