wezone
/
selling-partner-api-models
mirror of https://github.com/amzn/selling-partner-api-models.git
10
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update Vendor report schemas

This commit is contained in:
Jack Evoniuk 2024-04-24 11:53:03 -07:00
parent 62ecbcfe7c
commit eb3b6d3fc6
5 changed files with 65 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
schemas/reports/vendorForecastingReport.json
View File

@ -9,6 +9,7 @@
"reportOptions": {
"sellingProgram": "RETAIL"
},
"lastUpdatedDate": "2021-06-20",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
@ -268,13 +269,14 @@
"properties": {
"reportSpecification": {
"type": "object",
"description": "Report input summary which includes the marketplace and selling program.",
"description": "The report input summary which includes the marketplace, selling program, and last updated date.",
"examples": [
{
"reportType": "GET_VENDOR_FORECASTING_REPORT",
"reportOptions": {
"sellingProgram": "RETAIL"
},
"lastUpdatedDate": "2021-06-20",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
@ -283,6 +285,7 @@
"required": [
"reportType",
"reportOptions",
"lastUpdatedDate",
"marketplaceIds"
],
"properties": {
@ -315,6 +318,14 @@
}
}
},
"lastUpdatedDate": {
"type": "string",
"format": "date",
"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.",
"examples": [
"2021-06-20"
]
},
"marketplaceIds": {
"type": "array",
"description": "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.",

18
schemas/reports/vendorInventoryReport.json
View File

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"description": "This report shares inventory data of a 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: WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods. For example, if the customer specified reportPeriod=WEEK and a dataStartTime and dataEndTime that are 3 weeks apart, the report would contain data for each of those 3 contiguous weeks.",
"description": "This report shares inventory data of a 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. For example, if the customer specified reportPeriod=WEEK and a dataStartTime and dataEndTime that are 3 weeks apart, the report would contain data for each of those 3 contiguous weeks.",
"examples": [
{
"reportSpecification": {
@ -11,6 +11,7 @@
"sellingProgram": "RETAIL",
"distributorView": "MANUFACTURING"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -257,7 +258,7 @@
"properties": {
"reportSpecification": {
"type": "object",
"description": "Report summary including a reporting date range, distributor view, and selling program in the input.",
"description": "The report summary including a reporting date range, distributor view, selling program, and last updated date in the input.",
"examples": [
{
"reportType": "GET_VENDOR_INVENTORY_REPORT",
@ -266,6 +267,7 @@
"reportPeriod": "WEEK",
"sellingProgram": "RETAIL"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -276,6 +278,7 @@
"required": [
"reportType",
"reportOptions",
"lastUpdatedDate",
"dataStartTime",
"dataEndTime",
"marketplaceIds"
@ -314,8 +317,9 @@
},
"reportPeriod": {
"type": "string",
"description": "Determines what granularity of data is expected in the report. Valid values are: WEEK, MONTH, QUARTER, YEAR.",
"description": "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR.",
"enum": [
"DAY",
"WEEK",
"MONTH",
"QUARTER",
@ -332,6 +336,14 @@
}
}
},
"lastUpdatedDate": {
"type": "string",
"format": "date",
"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.",
"examples": [
"2021-06-20"
]
},
"dataStartTime": {
"type": "string",
"format": "date",

13
schemas/reports/vendorNetPureProductMarginReport.json
View File

@ -9,6 +9,7 @@
"reportOptions": {
"reportPeriod": "WEEK"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -63,13 +64,14 @@
"properties": {
"reportSpecification": {
"type": "object",
"description": "Summarizes the original report request.",
"description": "The report summary including the specified reporting date range and the last updated date in the input.",
"examples": [
{
"reportType": "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT",
"reportOptions": {
"reportPeriod": "WEEK"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -80,6 +82,7 @@
"required": [
"reportType",
"reportOptions",
"lastUpdatedDate",
"dataStartTime",
"dataEndTime",
"marketplaceIds"
@ -112,6 +115,14 @@
}
}
},
"lastUpdatedDate": {
"type": "string",
"format": "date",
"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.",
"examples": [
"2021-06-20"
]
},
"dataStartTime": {
"type": "string",
"format": "date",

15
schemas/reports/vendorSalesReport.json
View File

@ -11,6 +11,7 @@
"reportPeriod": "WEEK",
"sellingProgram": "RETAIL"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -148,6 +149,7 @@
"reportPeriod": "WEEK",
"sellingProgram": "FRESH"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -204,6 +206,7 @@
"reportPeriod": "WEEK",
"sellingProgram": "RETAIL"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-12",
"marketplaceIds": [
@ -268,7 +271,7 @@
"properties": {
"reportSpecification": {
"type": "object",
"description": "Report summary including reporting date range, distributor view, and selling program in the input.",
"description": "The report summary including reporting date range, distributor view, selling program, and last updated date in the input.",
"examples": [
{
"reportType": "GET_VENDOR_SALES_REPORT",
@ -277,6 +280,7 @@
"reportPeriod": "WEEK",
"sellingProgram": "RETAIL"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -287,6 +291,7 @@
"required": [
"reportType",
"reportOptions",
"lastUpdatedDate",
"dataStartTime",
"dataEndTime",
"marketplaceIds"
@ -345,6 +350,14 @@
}
}
},
"lastUpdatedDate": {
"type": "string",
"format": "date",
"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.",
"examples": [
"2021-06-20"
]
},
"dataStartTime": {
"type": "string",
"format": "date",

13
schemas/reports/vendorTrafficReport.json
View File

@ -9,6 +9,7 @@
"reportOptions": {
"reportPeriod": "WEEK"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -51,13 +52,14 @@
"properties": {
"reportSpecification": {
"type": "object",
"description": "Report summary including the specified reporting date range in the input.",
"description": "The report summary including the specified reporting date range and the last updated date in the input.",
"examples": [
{
"reportType": "GET_VENDOR_TRAFFIC_REPORT",
"reportOptions": {
"reportPeriod": "WEEK"
},
"lastUpdatedDate": "2021-06-20",
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
@ -68,6 +70,7 @@
"required": [
"reportType",
"reportOptions",
"lastUpdatedDate",
"dataStartTime",
"dataEndTime",
"marketplaceIds"
@ -105,6 +108,14 @@
}
}
},
"lastUpdatedDate": {
"type": "string",
"format": "date",
"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.",
"examples": [
"2021-06-20"
]
},
"dataStartTime": {
"type": "string",
"format": "date",