API Reference

Fetch Order Report Sandbox

post
https://api.shopmy.us/v1/sandbox/Partners/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).

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.

Headers
int32

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

Responses

Updated about 1 year ago

What’s Next

Once you are set up with the sandbox API for this route, check out the production documentation for fetching your live order report!

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

Updated about 1 year ago

What’s Next

Once you are set up with the sandbox API for this route, check out the production documentation for fetching your live order report!