API Reference

Fetch Order Report

post
https://api.shopmy.us/v1/Partners/OrderReport

This API request allows brand partners to fetch a report on orders to your brand. This route supports all affiliate program sources and provides detailed info for all ShopMy order records. Orders are returned by transaction date descending (most recent first). A daily rate limit is enforced of 200 requests per day (including paginated requests). At the maximum limit of 500 orders returned per API call, this yields 100,000 orders available for a report per day. Orders are returned sorted by transaction date descending.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

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

int32
Defaults to 500

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

int32
Defaults to 0

Page offset, zero-indexed. Defaults to 0.

string

Query for orders with transaction dates after this time. Accepts a date string in the format 'YYYY-MM-DD HH:mm:ss' in UTC time.

string

Query for orders with transaction dates before this time. Accepts a date string in the format 'YYYY-MM-DD HH:mm:ss' in UTC time.

boolean
Defaults to false

When true, orders in the response will be broken down by SKU. Note: this only applies to certain affiliate program sources. Defaults to false.

string

Query for orders with record updated dates after this time. Accepts a date string in the format 'YYYY-MM-DD HH:mm:ss' in UTC time.

string

Query for orders with record updated dates before this time. Accepts a date string in the format 'YYYY-MM-DD HH:mm:ss' in UTC time.

Responses

Updated 12 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 12 months ago