Skip to main content
POST
/
reports
/
view
/
salesByChannel
View sales by channel report
curl --request POST \
  --url https://mm-api.merchantspring.io/reports/view/salesByChannel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fromDate": 123,
  "toDate": 123,
  "priorFromDate": 123,
  "priorToDate": 123,
  "timezone": "<string>",
  "filter": {
    "marketplaces": [],
    "countries": [],
    "tags": []
  },
  "includeTax": false,
  "vendorRevenueType": "orderedRevenue",
  "sortKey": "sales",
  "sortOrder": "desc",
  "searchText": "",
  "pageSize": 10,
  "pageIndex": 0
}
'
{
  "rows": [
    {
      "store": "<string>",
      "outOfStockPercentage": 123,
      "buyBoxSnapshot": {},
      "forecastTarget": 123,
      "adspendLimit": 123,
      "budgetTarget": 123,
      "currency": "<string>",
      "salesSplit": 123,
      "storeId": "<string>",
      "marketplace": {
        "market": "<string>",
        "countryCode": "<string>"
      },
      "sales": {
        "value": 123,
        "priorPeriodValue": 123
      },
      "orders": {
        "value": "<string>",
        "priorPeriodValue": "<string>"
      },
      "avOrderValue": {
        "value": 123,
        "priorPeriodValue": 123
      },
      "units": {
        "value": "<string>",
        "priorPeriodValue": "<string>"
      },
      "avOrderSize": {
        "value": 123,
        "priorPeriodValue": 123
      },
      "pageViews": {
        "value": "<string>",
        "priorPeriodValue": "<string>"
      },
      "conversions": {
        "value": 123,
        "priorPeriodValue": 123
      },
      "healthStatus": "<string>"
    }
  ],
  "count": 123
}

Authorizations

x-api-key
string
header
required

Body

application/json

Sales by channel report criteria

Request body for viewing sales by channel report

fromDate
number
required

Unix epoch time (seconds) representing the start of the reporting period

toDate
number
required

Unix epoch time (seconds) representing the end of the reporting period

priorFromDate
number
required

Unix epoch time (seconds) representing the start of the comparison period

priorToDate
number
required

Unix epoch time (seconds) representing the end of the comparison period

timezone
string
required

The timezone string you wish to see the report in (e.g. 'America/Los_Angeles') see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

filter
object

Filter criteria for the report

includeTax
boolean
default:false

Whether to include tax in calculations

Example:

false

vendorRevenueType
enum<string>
default:orderedRevenue

Type of vendor revenue to calculate

Available options:
orderedRevenue,
shippedRevenue
Example:

"orderedRevenue"

sortKey
enum<string>
default:sales

Field to sort results by

Available options:
sales,
salesSplit,
forecastTarget,
budgetTarget,
orders,
units,
avOrderSize,
avOrderValue,
outOfStockPercentage,
pageViews,
conversions
Example:

"sales"

sortOrder
enum<string>
default:desc

Sort order direction

Available options:
asc,
desc
Example:

"desc"

searchText
string
default:""

Text to search within results

Example:

""

pageSize
integer

Number of items per page for pagination

Example:

10

pageIndex
integer

Zero-based page index for pagination

Required range: x >= 0
Example:

0

Response

Successful operation

Response for sales by channel endpoint containing marketplace overview data

rows
object[]

Array of store/channel data

count
number

Total number of stores/channels in the result set