API Reference

Site Direct with App Tracking

This documentation outlines ShopMy integration setup for sites that use Shopify sites and checkout pages.

Step One: Integrate Click Tracking

Log in to your Shopify Admin store and complete the following steps to add click tracking:

  1. Navigate to Online Store, then Themes
  2. Click the "Customize" button
  3. Click "Theme Actions" in the bottom left, then "Edit Code"
  4. Click "theme.liquid" in the left panel
  5. Add the one-line script below to the end of this HTML file just before the closing </body> tag 
    1. <script defer src="https://static.shopmy.us/Affiliates/sms_aff_clicktrack.js"></script>
  6. Click Save

Step Two: Integrate Order Tracking

Log in to your Shopify Admin store and complete the following steps to create a full Shopify integration with ShopMy.

Navigate to Apps Panel

  1. Click the "Apps" button on the left side panel
  2. Click the "App and sales channel settings" option in the dropdown
shopify_dashboard

Develop New App

  1. Click the "Develop Apps" button in the top right corner
  2. Create a new app
  3. Grant access for custom apps to be developed
  4. Enter "Shopmy Integration" for your app name and click "Create App"

Configure App's Scopes

  1. Click "Configure Admin API scopes" under the "Overview" tab
  2. Allow the following required scopes (8 total):
    1. write_discounts :: read_discounts
    2. write_price_rules :: read_price_rules
    3. write_orders :: read_orders
    4. read_products
    5. read_inventory
  3. Allow optional scopes (if needed):
    1. read_customers - Add this scope if you are looking to do new vs returning cutsomer commission rates. Please note we do not recommend this setting new vs returning rates as a strategy.
    2. write_draft_orders :: read_draft_orders :: write_customers - Add these scopes to enable us to create and complete Shopify draft orders for gifting to be compatible with Shopify Flow workflows you may have in place.
  4. Save the changes
shopify_dashboard

Get Your Tokens

  1. Click the "API credentials" tab header
  2. Locate your shop name. This will be in the form of (shopname).myshopify.com. Only the shopname is needed.
  3. Locate the API secret key.
  4. Click "Install App", then "Reveal token once"
  5. Locate the new Admin API access token that you just revealed
  6. Store these values and send them securely to the ShopMy team
develop_app_button

Next Steps

  1. The onboarding team will set up the app and save it to your account, as well as test the integration.
  2. You will receive an email from the onboarding team in case of any issues.

Full Setup Overview

The following video provides a full overview of the previous steps for your review if needed:

Step Three: Request Testing

Contact your Brand Success Manager to place a test order and test the integration end-to-end. We will communicate with you any test order IDs we place so they can be cancelled after the integration is verified.

📘

By adding our integration code to your site, you are agreeing to the terms of the ShopMy affiliate network. Please review these terms here.