Add sellingPartnerAlternatePurchaseReport.json report schema to GitHub.
This commit is contained in:
Gibran Waldron
parent
8a1f599ecb
commit
93e7bcc32d
|
|
@ -0,0 +1,273 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"type": "object",
|
||||
"description": "The Alternate Purchase report shares data on the items most commonly purchased after viewing but not purchasing the selling partner's item. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER. Requests can span multiple reporting periods. In this report, \"asin\" is an ASIN in the selling partner's catalog and \"purchasedAsin\" may or may not be an ASIN in the selling partner's catalog.",
|
||||
"examples": [
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_BRAND_ANALYTICS_ALTERNATE_PURCHASE_REPORT",
|
||||
"reportOptions": {
|
||||
"reportPeriod": "WEEK"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"dataByAsin": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1A345B78C",
|
||||
"purchasedRank": 1,
|
||||
"purchasedPct": 0.0280
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1D345E78F",
|
||||
"purchasedRank": 2,
|
||||
"purchasedPct": 0.0229
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1G345H78I",
|
||||
"purchasedRank": 3,
|
||||
"purchasedPct": 0.0212
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1J345K78L",
|
||||
"purchasedRank": 4,
|
||||
"purchasedPct": 0.0206
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1M345N78O",
|
||||
"purchasedRank": 5,
|
||||
"purchasedPct": 0.0197
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"purchasedAsin": "B12A45B78O",
|
||||
"purchasedRank": 1,
|
||||
"purchasedPct": 0.0345
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"purchasedAsin": "B12B45C78O",
|
||||
"purchasedRank": 2,
|
||||
"purchasedPct": 0.0333
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"purchasedAsin": "B12D45E78O",
|
||||
"purchasedRank": 3,
|
||||
"purchasedPct": 0.0321
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"purchasedAsin": "B12F45G78O",
|
||||
"purchasedRank": 4,
|
||||
"purchasedPct": 0.0287
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"purchasedAsin": "B12H45I78O",
|
||||
"purchasedRank": 5,
|
||||
"purchasedPct": 0.0200
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportSpecification",
|
||||
"dataByAsin"
|
||||
],
|
||||
"properties": {
|
||||
"reportSpecification": {
|
||||
"type": "object",
|
||||
"description": "Summarizes the original report request.",
|
||||
"examples": [
|
||||
{
|
||||
"reportType": "GET_BRAND_ANALYTICS_ALTERNATE_PURCHASE_REPORT",
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportType",
|
||||
"reportOptions",
|
||||
"dataStartTime",
|
||||
"dataEndTime",
|
||||
"marketplaceIds"
|
||||
],
|
||||
"properties": {
|
||||
"reportType": {
|
||||
"type": "string",
|
||||
"description": "The report type.",
|
||||
"enum": [
|
||||
"GET_BRAND_ANALYTICS_ALTERNATE_PURCHASE_REPORT"
|
||||
]
|
||||
},
|
||||
"reportOptions": {
|
||||
"type": "object",
|
||||
"description": "Report options specifying parameters such as reportPeriod.",
|
||||
"required": [
|
||||
"reportPeriod"
|
||||
],
|
||||
"properties": {
|
||||
"reportPeriod": {
|
||||
"type": "string",
|
||||
"description": "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER.",
|
||||
"enum": [
|
||||
"DAY",
|
||||
"WEEK",
|
||||
"MONTH",
|
||||
"QUARTER"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"dataStartTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the start date of the report - the time component is ignored. For WEEK, MONTH and QUARTER 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 and QUARTER 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. This report type supports only one marketplaceId per report. Specifying multiple marketplaces will result in failure to generate the report.",
|
||||
"examples": [
|
||||
["ATVPDKIKX0DER"]
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"dataByAsin": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/DataByAsin"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"DataByAsin": {
|
||||
"type": "object",
|
||||
"description": "Contains alternate purchase analytics data for each ASIN in the selling partner's catalog",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1A345B78C",
|
||||
"purchasedRank": 1,
|
||||
"purchasedPct": 0.0280
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"purchasedAsin": "B1D345E78F",
|
||||
"purchasedRank": 2,
|
||||
"purchasedPct": 0.0229
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"asin",
|
||||
"purchasedAsin",
|
||||
"purchasedRank",
|
||||
"purchasedPct"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The start date of the data contained within the object. If the request spans multiple reportPeriods, byAsin data will be shared for each of these reportPeriods.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The end date of the data contained within the object.",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"asin": {
|
||||
"type": "string",
|
||||
"description": "Amazon Standard Identification Number.",
|
||||
"examples": [
|
||||
"B123456789",
|
||||
"B987654321"
|
||||
]
|
||||
},
|
||||
"purchasedAsin": {
|
||||
"type": "string",
|
||||
"description": "The Amazon Standard Identifier Number of a product frequently purchased by the customers who viewed the selling partner's product but purchased another product.",
|
||||
"examples": [
|
||||
"B1A345B78C",
|
||||
"B1D345E78F"
|
||||
]
|
||||
},
|
||||
"purchasedRank": {
|
||||
"type": "integer",
|
||||
"description": "Relative frequency of purchasedAsin in customer orders in comparison to the total number of alternative product orders. Rank=1 means after viewing the selling partner's product, customers most commonly purchased purchasedAsin instead of the selling partner's product.",
|
||||
"examples": [
|
||||
1,
|
||||
5
|
||||
]
|
||||
},
|
||||
"purchasedPct": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"maximum": 1,
|
||||
"description": "The fraction of orders that contained purchasedAsin in comparison to the total number of alternative product orders",
|
||||
"examples": [
|
||||
0.0280,
|
||||
0.0229
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue