Submit a Ticket

ShopMy

Overview

Datasource for ShopMy Brand Partners API that fetches order data for a brand

Vendor/Partner	ShopMy
Version	v1.0
API Documentation	https://docs.shopmy.us/reference/fetch-order-report
Sunset Date
Channel(s)	Affiliate
Refresh Time (CST)	7am
Default backfill	14 days
Alli Data Library

Getting Started

Required Authorization

Users will need to have the following:
- An API Key - How to find your ShopMy API Key

Define your Data

Data brought in through the Orders report type.

Dimensions

Name	Table Field Name	Description
`Order ID`	`order_id`	Order ID
`Transaction Date`	`transaction_date`	Transaction Date
`Record Updated Date`	`record_updated_date`	Date the order was updated within ShopMy
`Click Date`	`click_date`	Date the product was first clicked on by the user
`Creator Name`	`creator_name`	Name of the ShopMy creator
`Creator ShopMy`	`creator_shopmy`	URL of the creator’s ShopMy page
`Domain`	`domain`	The Brand Domain
`Code`	`code`	Discount code used
`Currency`	`currency`	Currency transaction was completed in
`SKU`	`sku`	Comma-separated string of SKUs
`Customer Status`	`customer_status`	New/Existing customer status
`Ship-to Country`	`ship_to_country`	Destination country code

Metrics

Name	Table Field Name	Description
`Order Amount USD`	`order_amount_usd`	Order Amount in USD
`Commission Amount USD`	`commission_amount_usd`	Commission Amount in USD
`Click-Order Delta (Hours)`	`click_order_delta`	Difference between click and transaction date
`Gross Sales`	`gross_sales`	Gross order sales
`Number of Items`	`number_of_items`	Number of items in the order