> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sourcemedium.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ShopMy - Integration Instructions

> Connect ShopMy to SourceMedium for creator-affiliate order, commission, and ROAS analysis alongside your paid media channels.

## Follow this integration guide to connect your ShopMy data to SourceMedium.

ShopMy is a creator-affiliate platform for consumer brands. SourceMedium syncs your ShopMy order and commission data so creator performance can be analyzed alongside paid media and customer acquisition reporting.

### What you need

* A ShopMy Brand Partners account with access to **Brand Account Settings → Tokens**
* A ShopMy **Developer Key**
* Your brand's **registered ShopMy domain** (for example `examplebrand.com`)

<Note>
  Plan ahead for both. ShopMy issues the Developer Key per brand rather than self-serve, so request one from your ShopMy contact or `brandsupport@shopmy.us` before you start. And ShopMy's API has no endpoint that lists a brand's registered domains, so that value cannot be looked up or verified automatically. You have to tell us.
</Note>

### How to connect

<Snippet file="connect-managed-note.mdx" />

<Steps>
  <Step title="Get your ShopMy Developer Key">
    In ShopMy, open **Brand Account Settings → Tokens** and copy the **Developer Key**. If you do not have one yet, ask your ShopMy contact or email `brandsupport@shopmy.us`.
  </Step>

  <Step title="Send SourceMedium the key and your domain">
    Send both to your account manager or [integrations@sourcemedium.com](mailto:integrations@sourcemedium.com), not in a public channel:

    * Your **Developer Key**
    * Your **registered ShopMy domain**, usually your storefront host without `www.` (for example `examplebrand.com`)

    Our team stores the key in SourceMedium's connection manager, the same secure store used for every API-key integration.
  </Step>

  <Step title="SourceMedium backfills and starts syncing">
    We set the domain, run your available ShopMy order history as a backfill, and put the connection on its regular sync.
  </Step>
</Steps>

<Snippet file="api-key-security-note.mdx" />

### Data available

| Data        | Description                                                                                    |
| ----------- | ---------------------------------------------------------------------------------------------- |
| Orders      | Creator-attributed orders with order revenue and commission                                    |
| Creators    | The creator credited for each order, including their ShopMy profile and linked social accounts |
| Attribution | Promo code, creator link, click timestamp, and the time between click and order                |
| Status      | Order state and currency, used to keep commission reporting consistent                         |

Commission and order revenue arrive in USD, pre-converted by ShopMy.

### Questions you can answer

* What is our ShopMy creator ROAS compared with Meta Ads last quarter?
* Which creators drive the most attributed revenue, and at what effective commission rate?
* How much of our creator-attributed revenue comes from promo codes versus creator links?
* How long does it take between a creator click and a completed order?
* How is creator-channel revenue trending month over month?

### Notes

* ShopMy restates orders after the fact — commission and status can change on an order placed months earlier. SourceMedium tracks those updates, so historical figures may revise as ShopMy revises them.
* Not every order carries a promo code or a click. Orders attributed by creator link without a recorded click will have no click timestamp, and click-to-order timing is only reported where a click exists.
* Historical backfill coverage is confirmed during setup.

<Warning>
  If your ShopMy commission is currently entered by hand as a custom marketing cost, remove those manual entries when this integration goes live. Leaving them in place double-counts ShopMy spend, because the connector brings in the same commission automatically. Your Customer Solutions Engineer can confirm the cutover date.
</Warning>

### Using another affiliate platform?

If there is another affiliate platform you want to analyze in SourceMedium, reach out to your Customer Solutions Engineer.