SHshopmy

Fetch Order Report

Changed on

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. This endpoint expects all parameters in the JSON request body; query parameters are ignored.

post/OrderReport

Request

  • Base URL
    https://api.shopmy.us/v1/Partners
  • URL
    https://api.shopmy.us/v1/Partners/OrderReport
  • Auth
    API key in header Authorization

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.

transactionStartDatestring

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.

transactionEndDatestring

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.

reportBySKUboolean

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

recordUpdatedStartDatestring

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.

recordUpdatedEndDatestring

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.

sourcestring

Query for orders that originated on a different network. For example, pass 'shopmyshelf' to get orders that came from ShopMy. Will return a 401 if requesting a source you have no history with.

Response

200

Changes

  • 1fc692204b73Revision changes
    • warning

      deleted the header request parameter x-shopmy-test-response

    • info

      api operation id fetch-order-report-sandbox removed and replaced with fetch-order-report

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property