Articles in this section

See more

Implementing Convert on a Shopify Site

Convert's Shopify integration makes it simple to implement Convert rankings on your website. Below are step-by-step directions for how to set up a Shopify integration on your site.

 

Table of Contents

 

Configuring Shopify

  1. In your Shopify admin portal, click on the Apps button.
  2. At the bottom of the Apps page, click the link labeled Manage private apps.
  3. In the upper right corner of the Private apps page, click the Create a new private app button.
  4. In the App details section, enter "Convert" as the Private app name, and "convert.support@avatria.com" as the Emergency developer email.
  5. In the Admin API section, for simplicity, you can set all permissions to Read and write (including disabled permissions). Alternatively, we recommend the following settings:
    1. Read and write access:
      1. Store content like articles, blogs, comments, pages, and redirects
      2. Products, variants, and collections
      3. Script tags in your store's theme template files
      4. Reports
      5. Product information
      6. Online store pages graphql api GraphQL for articles, blogs, comments, pages, and redirects from Admin's Online Store Web
    2. Read access:
      1. Customer details and customer groups
      2. Orders, transactions and fulfillments
      3. Theme templates and theme assets
      4. Shipping rates, countries and provinces
      5. Discounts
      6. Merchant managed fulfillment orders
      7. Marketing events and related marketing engagement data
      8. Locations
      9. Inventory
      10. Gift cards
      11. Fulfillment services
      12. Draft orders
      13. Assigned fulfillment orders
      14. Analytics
      15. All fulfillment orders
    3. No Access:
      1. Shopify payments balance & payouts
      2. Shopify payments disputes
      3. Shopify payments bank accounts
      4. Shopify payments account, settings, and banking details
      5. Resource feedback
      6. Gdpr data requests
  6. Make sure that Webhook API version is set to Latest, and that Storefront API access is disabled, then Save.
  7. On the confirmation modal that appears, click I understand, create the app.
  8. New fields should appear for API key, Password, and Shared Secret. Record these values, as you'll need them to finish configuring the Shopify integration in Convert.

 

 

Setting up a Shopify Integration in Convert

Creating the Integration

  1. Navigate to the Integrations page.
  2. Click the Add Integration button.
  3. Enter a unique, identifiable Name, select Shopify as the Type, and click Continue.
  4. Enter your Store Domain, API Key, API Password, and Shared Secret, and click Create Integration.

 

Testing the Integration

  1. Navigate to the Connection Settings tab.
  2. Click Test Connection. 

 

Configuring Import Settings

Importing data from Shopify may simplify the process for creating custom model features. To automatically import data from Shopify, follow these steps:

  1. Navigate to the Import Settings tab.
  2. Enable the data types you want to import. 
  3. Select your desired Import Frequency.
    1. Start Time and Duration define the window in which Convert is permitted to import data. These settings can be used to avoid potential performance issues caused by a Convert import. We recommend that you set Duration to at least 4 hours, to ensure that Convert has enough time to download all relevant data.
  4. Save your changes.
  5. To kick off an import on demand, click Import Data.
    1. Note: Clicking Update Now will override import schedule settings, and may cause performance issues on your Shopify site.

 

Configuring Update Settings

To control product positions on Shopify sites, Convert applies its rankings to the Manual sort order option found within a collection.

  1. Select a Rank Campaign.
    1. For more information on setting up your campaign, view our support article here.
  2. Select your desired Update Frequency.
    1. Start Time and Duration define the window in which Convert is permitted to update product positions on your site. These settings can be used to avoid potential performance issues caused by a Convert update. We recommend that you set Duration to at least 8 hours, to ensure that Convert has enough time to update all collections.
  3. Fill in the Collection Map by supplying the Convert List Name that matches a given Shopify Collection ID.
    1. The collection map defines which Shopify collections can be controlled by the integration.
    2. Mapping a collection ID to a list name ensures that collection-specific data can be considered in the rankings applied to your site. 
    3. Note: To find the Collection ID for a collection in Shopify, navigate to a collection page in the Shopify admin portal, and copy the eleven-digit number at the end of the URL.
  4. Click Save.
  5. To kick off a ranking update on demand, click Update Now.
    1. Note: Clicking Update Now will override update schedule settings, and may cause performance issues on your Shopify site.

 

Displaying Convert's Rankings on Your Site

After integrating Convert with your site, Shopify needs to be properly configured to ensure that Convert's rankings are visible to customers.

To apply Convert's rankings to a collection in Shopify, Convert uses the Manual sort option found on the Products section of a Collections page.

Shopify's Manual sort populates the "Featured" option on the front end of your site.

Note: It is possible to change the label of the "Featured" sort option via theme configuration files, and this option may appear under a different label for your site.

To set Convert's rankings as the default sort order customers will see, make sure to set each collection's Sort option to "Manually".

Related articles