Skip to main content
POST
/
reports
/
view
/
vendorSalesByPeriod
Retrieve vendor sales-by-period performance
curl --request POST \
  --url https://mm-api.merchantspring.io/reports/view/vendorSalesByPeriod \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "merchantId": "<string>",
  "channelId": "<string>",
  "reportOptions": {
    "fromDate": 123,
    "toDate": 123,
    "priorFromDate": 123,
    "priorToDate": 123,
    "timezone": "<string>"
  },
  "asins": [
    "<string>"
  ]
}
'
{
  "status": "success",
  "currency": "<string>",
  "formattedChartData": [
    {
      "startTime": "<string>",
      "endTime": "<string>",
      "glanceViews": 123,
      "priorGlanceViews": 123,
      "orderedRevenue": "<string>",
      "priorOrderedRevenue": "<string>",
      "orderedUnits": 123,
      "priorOrderedUnits": 123,
      "conversionRate": "<string>",
      "priorConversionRate": "<string>",
      "retailPrice": "<string>",
      "priorRetailPrice": "<string>",
      "shippedRevenue": "<string>",
      "priorShippedRevenue": "<string>",
      "shippedRevenueManufacturing": "<string>",
      "priorShippedRevenueManufacturing": "<string>",
      "shippedCogs": "<string>",
      "priorShippedCogs": "<string>",
      "shippedCogsManufacturing": "<string>",
      "priorShippedCogsManufacturing": "<string>",
      "shippedUnits": 123,
      "priorShippedUnits": 123,
      "shippedUnitsManufacturing": 123,
      "priorShippedUnitsManufacturing": 123,
      "adSales": "<string>",
      "priorAdSales": "<string>",
      "adSpend": "<string>",
      "priorAdSpend": "<string>",
      "acos": "<string>",
      "priorAcos": "<string>",
      "tacosOrderedRevenue": "<string>",
      "priorTacosOrderedRevenue": "<string>",
      "tacosShippedRevenue": "<string>",
      "priorTacosShippedRevenue": "<string>",
      "tacosManufacturing": "<string>",
      "priorTacosManufacturing": "<string>",
      "impressions": 123,
      "priorImpressions": 123,
      "clicks": 123,
      "priorClicks": 123,
      "clickThroughRate": "<string>",
      "priorClickThroughRate": "<string>",
      "currency": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Report filters that identify the merchant, time range, and marketplace scope to evaluate.

Payload used to request the vendor sales-by-period view report.

​
merchantId
string
required

MerchantSpring merchant identifier for the account whose performance should be returned.

​
channelId
string
required

MerchantSpring channel identifier for the account whose performance should be returned.

​
reportOptions
object
required

Defines the reporting window and comparison period that should be analysed.

​
asins
string[]

Optional list of ASINs to restrict the dataset to specific products.

Response

Aggregated performance data grouped to match the requested interval.

Successful response returned by the sales-by-period report endpoint.

​
status
enum<string>
required

Indicates that the request completed successfully.

Available options:
success
​
currency
string
required

Currency code associated with the returned metrics.

​
formattedChartData
object[]
required

Display-ready metrics including formatted strings and comparison values for each interval.