---
title: "Fetch Order Report Sandbox"
method: POST
path: "/OrderReport"
---

# Fetch Order Report Sandbox

`POST /OrderReport`

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).

## Headers

- `x-shopmy-test-response` integer

## Request body

- object
  - `domain` string — The domain to fetch the order report for. This domain must be registered in ShopMy as your brand's domain or alternate domain.
  - `limit` integer — Number of orders to return per request page. Defaults to 500, maximum 500.
  - `page` integer — Page offset, zero-indexed. Defaults to 0.

## Response `200`

200

- object[]
  - `Order ID` string
  - `Transaction Date` string
  - `Record Updated Date` string
  - `Click Date` string
  - `Order Amount USD` string
  - `Commission Amount USD` string
  - `Creator Name` string
  - `Creator ShopMy` string
  - `Domain` string
  - `Code` string
  - `Currency` string
  - `Click-Order Delta (Hours)` string
  - `SKU` string
  - `Customer Status` string
  - `Ship-to Country` string
  - `Gross Sales` string
  - `Number of Items` string

## Other responses

- `400` — 400
- `401` — 401
- `429` — 429

---

[API](https://skmtc.net/shopmy/apis/brand-partners-api.md) · [All operations](https://skmtc.net/shopmy/apis/brand-partners-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopmy/brand-partners-api/versions/d5bd6f65327c/schema)