Retrieve sales performance by product
curl --request POST \
--url https://mm-api.merchantspring.io/reports/view/salesByProduct \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channelId": "<string>",
"merchantId": "<string>",
"fromDate": 123,
"toDate": 123,
"priorFromDate": 123,
"priorToDate": 123,
"timezone": "<string>",
"pageSize": 123,
"pageIndex": 123,
"sortKey": "totalSales",
"sortOrder": "desc",
"searchText": "",
"includeNoSales": false,
"includeNoInventory": false,
"includeTax": false
}
'import requests
url = "https://mm-api.merchantspring.io/reports/view/salesByProduct"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"fromDate": 123,
"toDate": 123,
"priorFromDate": 123,
"priorToDate": 123,
"timezone": "<string>",
"pageSize": 123,
"pageIndex": 123,
"sortKey": "totalSales",
"sortOrder": "desc",
"searchText": "",
"includeNoSales": False,
"includeNoInventory": False,
"includeTax": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: '<string>',
merchantId: '<string>',
fromDate: 123,
toDate: 123,
priorFromDate: 123,
priorToDate: 123,
timezone: '<string>',
pageSize: 123,
pageIndex: 123,
sortKey: 'totalSales',
sortOrder: 'desc',
searchText: '',
includeNoSales: false,
includeNoInventory: false,
includeTax: false
})
};
fetch('https://mm-api.merchantspring.io/reports/view/salesByProduct', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mm-api.merchantspring.io/reports/view/salesByProduct",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channelId' => '<string>',
'merchantId' => '<string>',
'fromDate' => 123,
'toDate' => 123,
'priorFromDate' => 123,
'priorToDate' => 123,
'timezone' => '<string>',
'pageSize' => 123,
'pageIndex' => 123,
'sortKey' => 'totalSales',
'sortOrder' => 'desc',
'searchText' => '',
'includeNoSales' => false,
'includeNoInventory' => false,
'includeTax' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mm-api.merchantspring.io/reports/view/salesByProduct"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 123,\n \"toDate\": 123,\n \"priorFromDate\": 123,\n \"priorToDate\": 123,\n \"timezone\": \"<string>\",\n \"pageSize\": 123,\n \"pageIndex\": 123,\n \"sortKey\": \"totalSales\",\n \"sortOrder\": \"desc\",\n \"searchText\": \"\",\n \"includeNoSales\": false,\n \"includeNoInventory\": false,\n \"includeTax\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mm-api.merchantspring.io/reports/view/salesByProduct")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 123,\n \"toDate\": 123,\n \"priorFromDate\": 123,\n \"priorToDate\": 123,\n \"timezone\": \"<string>\",\n \"pageSize\": 123,\n \"pageIndex\": 123,\n \"sortKey\": \"totalSales\",\n \"sortOrder\": \"desc\",\n \"searchText\": \"\",\n \"includeNoSales\": false,\n \"includeNoInventory\": false,\n \"includeTax\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/reports/view/salesByProduct")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 123,\n \"toDate\": 123,\n \"priorFromDate\": 123,\n \"priorToDate\": 123,\n \"timezone\": \"<string>\",\n \"pageSize\": 123,\n \"pageIndex\": 123,\n \"sortKey\": \"totalSales\",\n \"sortOrder\": \"desc\",\n \"searchText\": \"\",\n \"includeNoSales\": false,\n \"includeNoInventory\": false,\n \"includeTax\": false\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{
"current": {
"productId": "<string>",
"totalSales": 123,
"unitsSold": 123,
"title": "<string>",
"sku": "<string>",
"productSku": "<string>",
"linkUrl": "<string>",
"imageUrl": "<string>",
"price": 123,
"avPrice": 123,
"lastSold": "<string>",
"noQuantitySinceTime": "<string>",
"acos": 123,
"tacos": 123,
"directFulfillmentPOValue": 123,
"directFulfillmentUnits": 123,
"directFulfillmentPOValuePercent": 123,
"directFulfillmentUnitsPercent": 123
},
"prior": {
"productId": "<string>",
"totalSales": 123,
"unitsSold": 123,
"title": "<string>",
"sku": "<string>",
"productSku": "<string>",
"linkUrl": "<string>",
"imageUrl": "<string>",
"price": 123,
"avPrice": 123,
"lastSold": "<string>",
"noQuantitySinceTime": "<string>",
"acos": 123,
"tacos": 123,
"directFulfillmentPOValue": 123,
"directFulfillmentUnits": 123,
"directFulfillmentPOValuePercent": 123,
"directFulfillmentUnitsPercent": 123
}
}
],
"count": 123
}This response has no body data.Report
Retrieve sales performance by product
Retrieve sales performance broken down by product for the selected channel and date range, with prior-period comparison.
POST
/
reports
/
view
/
salesByProduct
Retrieve sales performance by product
curl --request POST \
--url https://mm-api.merchantspring.io/reports/view/salesByProduct \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channelId": "<string>",
"merchantId": "<string>",
"fromDate": 123,
"toDate": 123,
"priorFromDate": 123,
"priorToDate": 123,
"timezone": "<string>",
"pageSize": 123,
"pageIndex": 123,
"sortKey": "totalSales",
"sortOrder": "desc",
"searchText": "",
"includeNoSales": false,
"includeNoInventory": false,
"includeTax": false
}
'import requests
url = "https://mm-api.merchantspring.io/reports/view/salesByProduct"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"fromDate": 123,
"toDate": 123,
"priorFromDate": 123,
"priorToDate": 123,
"timezone": "<string>",
"pageSize": 123,
"pageIndex": 123,
"sortKey": "totalSales",
"sortOrder": "desc",
"searchText": "",
"includeNoSales": False,
"includeNoInventory": False,
"includeTax": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: '<string>',
merchantId: '<string>',
fromDate: 123,
toDate: 123,
priorFromDate: 123,
priorToDate: 123,
timezone: '<string>',
pageSize: 123,
pageIndex: 123,
sortKey: 'totalSales',
sortOrder: 'desc',
searchText: '',
includeNoSales: false,
includeNoInventory: false,
includeTax: false
})
};
fetch('https://mm-api.merchantspring.io/reports/view/salesByProduct', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mm-api.merchantspring.io/reports/view/salesByProduct",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channelId' => '<string>',
'merchantId' => '<string>',
'fromDate' => 123,
'toDate' => 123,
'priorFromDate' => 123,
'priorToDate' => 123,
'timezone' => '<string>',
'pageSize' => 123,
'pageIndex' => 123,
'sortKey' => 'totalSales',
'sortOrder' => 'desc',
'searchText' => '',
'includeNoSales' => false,
'includeNoInventory' => false,
'includeTax' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mm-api.merchantspring.io/reports/view/salesByProduct"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 123,\n \"toDate\": 123,\n \"priorFromDate\": 123,\n \"priorToDate\": 123,\n \"timezone\": \"<string>\",\n \"pageSize\": 123,\n \"pageIndex\": 123,\n \"sortKey\": \"totalSales\",\n \"sortOrder\": \"desc\",\n \"searchText\": \"\",\n \"includeNoSales\": false,\n \"includeNoInventory\": false,\n \"includeTax\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mm-api.merchantspring.io/reports/view/salesByProduct")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 123,\n \"toDate\": 123,\n \"priorFromDate\": 123,\n \"priorToDate\": 123,\n \"timezone\": \"<string>\",\n \"pageSize\": 123,\n \"pageIndex\": 123,\n \"sortKey\": \"totalSales\",\n \"sortOrder\": \"desc\",\n \"searchText\": \"\",\n \"includeNoSales\": false,\n \"includeNoInventory\": false,\n \"includeTax\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/reports/view/salesByProduct")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 123,\n \"toDate\": 123,\n \"priorFromDate\": 123,\n \"priorToDate\": 123,\n \"timezone\": \"<string>\",\n \"pageSize\": 123,\n \"pageIndex\": 123,\n \"sortKey\": \"totalSales\",\n \"sortOrder\": \"desc\",\n \"searchText\": \"\",\n \"includeNoSales\": false,\n \"includeNoInventory\": false,\n \"includeTax\": false\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{
"current": {
"productId": "<string>",
"totalSales": 123,
"unitsSold": 123,
"title": "<string>",
"sku": "<string>",
"productSku": "<string>",
"linkUrl": "<string>",
"imageUrl": "<string>",
"price": 123,
"avPrice": 123,
"lastSold": "<string>",
"noQuantitySinceTime": "<string>",
"acos": 123,
"tacos": 123,
"directFulfillmentPOValue": 123,
"directFulfillmentUnits": 123,
"directFulfillmentPOValuePercent": 123,
"directFulfillmentUnitsPercent": 123
},
"prior": {
"productId": "<string>",
"totalSales": 123,
"unitsSold": 123,
"title": "<string>",
"sku": "<string>",
"productSku": "<string>",
"linkUrl": "<string>",
"imageUrl": "<string>",
"price": 123,
"avPrice": 123,
"lastSold": "<string>",
"noQuantitySinceTime": "<string>",
"acos": 123,
"tacos": 123,
"directFulfillmentPOValue": 123,
"directFulfillmentUnits": 123,
"directFulfillmentPOValuePercent": 123,
"directFulfillmentUnitsPercent": 123
}
}
],
"count": 123
}This response has no body data.Authorizations
Body
application/json
Sales by product report criteria
Unix epoch time (seconds) representing the start of the reporting period
Unix epoch time (seconds) representing the end of the reporting period
Unix epoch time (seconds) representing the start of the prior comparison period
Unix epoch time (seconds) representing the end of the prior comparison period
Available options:
asc, desc Whether products with no sales should be included
Whether products with zero inventory should be included
Whether tax should be included in sales figures
Was this page helpful?
⌘I