"description":"This report shares data on the sales performance of vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods.",
"description":"The date when the report was last updated. Follows the <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> Date format of YYYY-MM-DD.",
"description":"Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.",
"examples":[
"2021-06-06"
]
},
"dataEndTime":{
"type":"string",
"format":"date",
"description":"Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.",
"examples":[
"2021-06-19"
]
},
"marketplaceIds":{
"type":"array",
"description":"This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.",
"examples":[
[
"ATVPDKIKX0DER"
]
],
"items":{
"type":"string"
}
}
}
},
"salesAggregate":{
"type":"array",
"items":{
"$ref":"#/definitions/SalesAggregate"
}
},
"salesByAsin":{
"type":"array",
"items":{
"$ref":"#/definitions/SalesByAsin"
}
}
},
"definitions":{
"SalesAggregate":{
"type":"object",
"description":"Describes aggregated sales metrics for ASINs in the vendor's account.",
"examples":[
{
"startDate":"2021-06-06",
"endDate":"2021-06-12",
"customerReturns":0,
"orderedRevenue":{
"amount":1500,
"currencyCode":"USD"
},
"orderedUnits":75,
"shippedCogs":{
"amount":90.00,
"currencyCode":"USD"
},
"shippedRevenue":{
"amount":200.00,
"currencyCode":"USD"
},
"shippedUnits":10
}
],
"required":[
"startDate",
"endDate",
"shippedCogs",
"shippedRevenue",
"shippedUnits"
],
"properties":{
"startDate":{
"type":"string",
"format":"date",
"description":"The start date of the aggregated data.",
"examples":[
"2021-06-06"
]
},
"endDate":{
"type":"string",
"format":"date",
"description":"The end date of the aggregated data.",
"examples":[
"2021-06-12"
]
},
"customerReturns":{
"type":"integer",
"minimum":0,
"description":"The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.",
"examples":[
0
]
},
"orderedRevenue":{
"$ref":"#/definitions/Amount",
"description":"Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING."
},
"orderedUnits":{
"type":"integer",
"description":"Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING.",
"minimum":0,
"examples":[
75
]
},
"shippedCogs":{
"$ref":"#/definitions/Amount",
"description":"Revenue based on the cost of goods sold. Adjustments are made for returns."
},
"shippedRevenue":{
"$ref":"#/definitions/Amount",
"description":"Revenue based on units shipped in the selected time frame. Adjustments are made for returns."
},
"shippedUnits":{
"type":"integer",
"description":"Number of units shipped to Amazon customers.",
"minimum":0,
"examples":[
10
]
}
}
},
"SalesByAsin":{
"type":"object",
"description":"Describes aggregated ASIN-level sales metrics for ASINs in the vendor's account.",
"examples":[
{
"startDate":"2021-06-06",
"endDate":"2021-06-12",
"asin":"B123456789",
"customerReturns":0,
"orderedRevenue":{
"amount":1000.00,
"currencyCode":"USD"
},
"orderedUnits":25,
"shippedCogs":{
"amount":50.00,
"currencyCode":"USD"
},
"shippedRevenue":{
"amount":150.00,
"currencyCode":"USD"
},
"shippedUnits":5
}
],
"required":[
"startDate",
"endDate",
"asin",
"shippedCogs",
"shippedRevenue",
"shippedUnits"
],
"properties":{
"startDate":{
"type":"string",
"format":"date",
"description":"The start date of the aggregated ASIN-level data.",
"examples":[
"2021-06-06"
]
},
"endDate":{
"type":"string",
"format":"date",
"description":"The end date of the aggregated ASIN-level data.",
"examples":[
"2021-06-12"
]
},
"asin":{
"description":"The Amazon Standard Identification Number.",
"type":"string",
"examples":[
"B123456789"
]
},
"customerReturns":{
"type":"integer",
"description":"The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.",
"minimum":0,
"examples":[
0
]
},
"orderedRevenue":{
"$ref":"#/definitions/Amount",
"description":"Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING"
},
"orderedUnits":{
"type":"integer",
"description":"Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING",
"minimum":0,
"examples":[
25
]
},
"shippedCogs":{
"$ref":"#/definitions/Amount",
"description":"Revenue based on the cost of goods sold. Adjustments are made for returns."
},
"shippedRevenue":{
"$ref":"#/definitions/Amount",
"description":"Revenue based on units shipped in the selected time frame. Adjustments are made for returns."
},
"shippedUnits":{
"type":"integer",
"description":"Number of units shipped to Amazon customers.",
"minimum":0,
"examples":[
5
]
}
}
},
"Amount":{
"type":"object",
"examples":[
{
"amount":0.00,
"currencyCode":"USD"
},
{
"amount":20.00,
"currencyCode":"EUR"
}
],
"required":[
"amount",
"currencyCode"
],
"properties":{
"amount":{
"type":"number",
"description":"The amount.",
"examples":[
20.00
]
},
"currencyCode":{
"type":"string",
"description":"Currency code of the amount. In ISO 4217 format.",