v1

latestOpenAPI 3.1.02026-07-247620.1 KB

Fetch Order Report Sandbox

This sandbox API request allows brand partners to test API access and responses for fetching a report on orders to your brand. This route is for use in a development environment and returns synthetic data and simulated responses to test API access. A daily sandbox rate limit is enforced of 1000 requests per day (including paginated requests).

post/OrderReport

Headers

x-shopmy-test-responseinteger

(optional) Header to simulate a response code for testing. Available options for this sandbox API route are: 400, 401

Request body

domainstring

The domain to fetch the order report for. This domain must be registered in ShopMy as your brand's domain or alternate domain.

limitinteger

Number of orders to return per request page. Defaults to 500, maximum 500.

pageinteger

Page offset, zero-indexed. Defaults to 0.

Response

200

Order IDstring

Transaction Datestring

Record Updated Datestring

Click Datestring

Order Amount USDstring

Commission Amount USDstring

Creator Namestring

Creator ShopMystring

Domainstring

Codestring

Currencystring

Click-Order Delta (Hours)string

SKUstring

Customer Statusstring

Ship-to Countrystring

Gross Salesstring

Number of Itemsstring

Example response

[
  {
    "Order ID": "SMS1234",
    "Transaction Date": "YYYY-MM-DDTHH:mm:ssZ",
    "Record Updated Date": "YYYY-MM-DDTHH:mm:ssZ",
    "Click Date": "YYYY-MM-DDTHH:mm:ssZ",
    "Order Amount USD": "Order amount in USD",
    "Commission Amount USD": "Commission amount in USD",
    "Creator Name": "ShopMy",
    "Creator ShopMy": "https://shopmy.us/home",
    "Domain": "Domain specified in request",
    "Code": "SHOPMY",
    "Currency": "USD",
    "Click-Order Delta (Hours)": "Delta in hours between click date and transaction date",
    "SKU": "(program-specific) Comma-separated string of SKUs if available",
    "Customer Status": "(program-specific) New/Existing customer status if available",
    "Ship-to Country": "(program-specific) Destination country code if available",
    "Gross Sales": "(program-specific) Gross order sales if available, in the currency returned by the Currency field above",
    "Number of Items": "(program-specific) Number of items in the order if available"
  }
]

All 7 operations