diff --git a/models/reports-api-model/reports_2020-09-04.json b/models/reports-api-model/reports_2020-09-04.json index 49bf0a7..59f3712 100644 --- a/models/reports-api-model/reports_2020-09-04.json +++ b/models/reports-api-model/reports_2020-09-04.json @@ -14,6 +14,7 @@ } }, "host": "sellingpartnerapi-na.amazon.com", + "basePath": "/", "schemes": [ "https" ], @@ -29,20 +30,20 @@ "tags": [ "reports" ], - "operationId": "getReports", "description": "Returns report details for the reports that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "getReports", "parameters": [ { "name": "reportTypes", "in": "query", + "description": "A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.", "required": false, "type": "array", - "minItems": 1, - "maxItems": 10, - "description": "A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.", "items": { "type": "string" - } + }, + "maxItems": 10, + "minItems": 1 }, { "name": "processingStatuses", @@ -50,7 +51,6 @@ "description": "A list of processing statuses used to filter reports.", "required": false, "type": "array", - "minItems": 1, "items": { "type": "string", "enum": [ @@ -82,19 +82,20 @@ "description": "The report has not yet started processing. It may be waiting for another IN_PROGRESS report." } ] - } + }, + "minItems": 1 }, { "name": "marketplaceIds", - "description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.", "in": "query", + "description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.", "required": false, "type": "array", - "minItems": 1, - "maxItems": 10, "items": { "type": "string" - } + }, + "maxItems": 10, + "minItems": 1 }, { "name": "pageSize", @@ -102,9 +103,9 @@ "description": "The maximum number of reports to return in a single call.", "required": false, "type": "integer", - "minimum": 1, + "default": 10, "maximum": 100, - "default": 10 + "minimum": 1 }, { "name": "createdSince", @@ -137,6 +138,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -184,6 +189,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -225,6 +234,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -249,6 +262,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -261,6 +278,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -273,6 +294,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -285,6 +310,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -297,6 +326,10 @@ "$ref": "#/definitions/GetReportsResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -309,12 +342,12 @@ "tags": [ "reports" ], - "operationId": "createReport", "description": "Creates a report.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "createReport", "parameters": [ { - "name": "body", "in": "body", + "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateReportSpecification" @@ -328,6 +361,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -363,6 +400,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -377,8 +418,8 @@ "reportType": "BAD_FEE_DISCOUNTS_REPORT", "dataStartTime": "2019-12-10T20:11:24.000Z", "marketplaceIds": [ - "A1PA6795UKMFR9", - "ATVPDKIKX0DER" + "A1PA6795UKMFR9", + "ATVPDKIKX0DER" ] } } @@ -402,6 +443,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -426,6 +471,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -438,6 +487,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -450,6 +503,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -462,6 +519,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -474,6 +535,10 @@ "$ref": "#/definitions/CreateReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -481,177 +546,21 @@ } } } - }, - "parameters": [] + } }, "/reports/2020-09-04/reports/{reportId}": { - "delete": { - "tags": [ - "reports" - ], - "operationId": "cancelReport", - "description": "Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "reportId": { - "value": "ID" - } - } - }, - "response": {} - } - ] - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CancelReportResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - }, "get": { "tags": [ "reports" ], - "operationId": "getReport", "description": "Returns report details (including the reportDocumentId, if available) for the report that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2.0 | 15 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "getReport", "parameters": [ { "name": "reportId", "in": "path", - "required": true, "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", + "required": true, "type": "string" } ], @@ -662,6 +571,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -697,6 +610,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -729,6 +646,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -753,6 +674,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -765,6 +690,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -777,6 +706,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -789,6 +722,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -801,6 +738,10 @@ "$ref": "#/definitions/GetReportResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -809,27 +750,212 @@ } } }, - "parameters": [] + "delete": { + "tags": [ + "reports" + ], + "description": "Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "cancelReport", + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "reportId": { + "value": "ID" + } + } + }, + "response": {} + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request's Content-Type header is invalid.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/CancelReportResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + } }, "/reports/2020-09-04/schedules": { "get": { "tags": [ "reports" ], - "operationId": "getReportSchedules", "description": "Returns report schedule details that match the filters that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "getReportSchedules", "parameters": [ { "name": "reportTypes", "in": "query", + "description": "A list of report types used to filter report schedules.", "required": true, "type": "array", - "minItems": 1, - "maxItems": 10, - "description": "A list of report types used to filter report schedules.", "items": { "type": "string" - } + }, + "maxItems": 10, + "minItems": 1 } ], "responses": { @@ -839,6 +965,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -884,6 +1014,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -919,6 +1053,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -943,6 +1081,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -955,6 +1097,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -967,6 +1113,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -979,6 +1129,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -991,6 +1145,10 @@ "$ref": "#/definitions/GetReportSchedulesResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1003,12 +1161,12 @@ "tags": [ "reports" ], - "operationId": "createReportSchedule", "description": "Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "createReportSchedule", "parameters": [ { - "name": "body", "in": "body", + "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateReportScheduleSpecification" @@ -1022,6 +1180,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1058,6 +1220,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1094,6 +1260,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1118,6 +1288,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1130,6 +1304,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1142,6 +1320,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1154,6 +1336,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1166,6 +1352,10 @@ "$ref": "#/definitions/CreateReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1173,177 +1363,21 @@ } } } - }, - "parameters": [] + } }, "/reports/2020-09-04/schedules/{reportScheduleId}": { - "delete": { - "tags": [ - "reports" - ], - "operationId": "cancelReportSchedule", - "description": "Cancels the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", - "parameters": [ - { - "name": "reportScheduleId", - "in": "path", - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - "reportScheduleId": { - "value": "ID" - } - } - }, - "response": {} - } - ] - }, - "400": { - "description": "Request has missing or invalid parameters and cannot be parsed.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - }, - "x-amazon-spds-sandbox-behaviors": [ - { - "request": { - "parameters": { - } - }, - "response": { - "errors": [ - { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" - } - ] - } - } - ] - }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "403": { - "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "404": { - "description": "The specified resource does not exist.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "415": { - "description": "The request's Content-Type header is invalid.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "429": { - "description": "The frequency of requests was greater than allowed.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "500": { - "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, - "503": { - "description": "Temporary overloading or maintenance of the server.", - "schema": { - "$ref": "#/definitions/CancelReportScheduleResponse" - }, - "headers": { - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - } - } - }, "get": { "tags": [ "reports" ], - "operationId": "getReportSchedule", "description": "Returns report schedule details for the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "getReportSchedule", "parameters": [ { "name": "reportScheduleId", "in": "path", - "required": true, "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", + "required": true, "type": "string" } ], @@ -1354,6 +1388,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1385,6 +1423,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1417,6 +1459,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1441,6 +1487,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1453,6 +1503,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1465,6 +1519,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1477,6 +1535,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1489,6 +1551,10 @@ "$ref": "#/definitions/GetReportScheduleResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1497,7 +1563,192 @@ } } }, - "parameters": [] + "delete": { + "tags": [ + "reports" + ], + "description": "Cancels the report schedule that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "cancelReportSchedule", + "parameters": [ + { + "name": "reportScheduleId", + "in": "path", + "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "reportScheduleId": { + "value": "ID" + } + } + }, + "response": {} + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": {} + }, + "response": { + "errors": [ + { + "code": "400", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "401": { + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request's Content-Type header is invalid.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/CancelReportScheduleResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + } }, "/reports/2020-09-04/documents/{reportDocumentId}": { "get": { @@ -1522,6 +1773,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1556,6 +1811,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1588,6 +1847,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1612,6 +1875,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1624,6 +1891,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -1636,6 +1907,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1648,6 +1923,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1660,6 +1939,10 @@ "$ref": "#/definitions/GetReportDocumentResponse" }, "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." + }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference ID." @@ -1702,7 +1985,6 @@ }, "ReportDocumentEncryptionDetails": { "type": "object", - "description": "Encryption details required for decryption of a report document's contents.", "required": [ "initializationVector", "key", @@ -1710,8 +1992,8 @@ ], "properties": { "standard": { - "description": "The encryption standard required to decrypt the document contents.", "type": "string", + "description": "The encryption standard required to decrypt the document contents.", "enum": [ "AES" ], @@ -1730,54 +2012,55 @@ "type": "string", "description": "The encryption key used to decrypt the document contents." } - } + }, + "description": "Encryption details required for decryption of a report document's contents." }, "Report": { "type": "object", "required": [ + "createdTime", "processingStatus", "reportId", - "reportType", - "createdTime" + "reportType" ], "properties": { "marketplaceIds": { - "description": "A list of marketplace identifiers for the report.", "type": "array", + "description": "A list of marketplace identifiers for the report.", "items": { "type": "string" } }, "reportId": { - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", - "type": "string" + "type": "string", + "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." }, "reportType": { - "description": "The report type.", - "type": "string" + "type": "string", + "description": "The report type." }, "dataStartTime": { - "description": "The start of a date and time range used for selecting the data to report.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The start of a date and time range used for selecting the data to report." }, "dataEndTime": { - "description": "The end of a date and time range used for selecting the data to report.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The end of a date and time range used for selecting the data to report." }, "reportScheduleId": { - "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID.", - "type": "string" + "type": "string", + "description": "The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID." }, "createdTime": { - "description": "The date and time when the report was created.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the report was created." }, "processingStatus": { - "description": "The processing status of the report.", "type": "string", + "description": "The processing status of the report.", "enum": [ "CANCELLED", "DONE", @@ -1809,18 +2092,18 @@ ] }, "processingStartTime": { - "description": "The date and time when the report processing started, in ISO 8601 date time format.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the report processing started, in ISO 8601 date time format." }, "processingEndTime": { - "description": "The date and time when the report processing completed, in ISO 8601 date time format.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the report processing completed, in ISO 8601 date time format." }, "reportDocumentId": { - "description": "The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents.", - "type": "string" + "type": "string", + "description": "The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents." } } }, @@ -1839,24 +2122,24 @@ ], "properties": { "reportType": { - "description": "The report type.", - "type": "string" + "type": "string", + "description": "The report type." }, "marketplaceIds": { - "description": "A list of marketplace identifiers for the report schedule.", "type": "array", - "minItems": 1, - "maxItems": 25, + "description": "A list of marketplace identifiers for the report schedule.", "items": { "type": "string" - } + }, + "maxItems": 25, + "minItems": 1 }, "reportOptions": { "$ref": "#/definitions/ReportOptions" }, "period": { - "description": "One of a set of predefined ISO 8601 periods that specifies how often a report should be created.", "type": "string", + "description": "One of a set of predefined ISO 8601 periods that specifies how often a report should be created.", "enum": [ "PT5M", "PT15M", @@ -1953,9 +2236,9 @@ ] }, "nextReportCreationTime": { - "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } } }, @@ -1970,39 +2253,38 @@ "$ref": "#/definitions/ReportOptions" }, "reportType": { - "description": "The report type.", - "type": "string" + "type": "string", + "description": "The report type." }, "dataStartTime": { - "description": "The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." }, "dataEndTime": { - "description": "The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this." }, "marketplaceIds": { - "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", "type": "array", - "minItems": 1, - "maxItems": 25, + "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", "items": { "type": "string" - } + }, + "maxItems": 25, + "minItems": 1 } } }, "ReportOptions": { - "description": "Additional information passed to reports. This varies by report type.", "type": "object", + "description": "Additional information passed to reports. This varies by report type.", "additionalProperties": { "type": "string" } }, "ReportSchedule": { - "description": "Detailed information about a report schedule.", "type": "object", "required": [ "period", @@ -2011,16 +2293,16 @@ ], "properties": { "reportScheduleId": { - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", - "type": "string" + "type": "string", + "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." }, "reportType": { - "description": "The report type.", - "type": "string" + "type": "string", + "description": "The report type." }, "marketplaceIds": { - "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", "type": "array", + "description": "A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.", "items": { "type": "string" } @@ -2029,15 +2311,16 @@ "$ref": "#/definitions/ReportOptions" }, "period": { - "description": "An ISO 8601 period value that indicates how often a report should be created.", - "type": "string" + "type": "string", + "description": "An ISO 8601 period value that indicates how often a report should be created." }, "nextReportCreationTime": { - "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format.", "type": "string", - "format": "date-time" + "format": "date-time", + "description": "The date and time when the schedule will create its next report, in ISO 8601 date time format." } - } + }, + "description": "Detailed information about a report schedule." }, "ReportScheduleList": { "type": "array", @@ -2052,8 +2335,8 @@ ], "properties": { "reportId": { - "description": "The identifier for the report. This identifier is unique only in combination with a seller ID.", - "type": "string" + "type": "string", + "description": "The identifier for the report. This identifier is unique only in combination with a seller ID." } } }, @@ -2065,8 +2348,8 @@ "$ref": "#/definitions/ReportList" }, "nextToken": { - "description": "Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter.", - "type": "string" + "type": "string", + "description": "Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter." }, "errors": { "$ref": "#/definitions/ErrorList" @@ -2151,8 +2434,8 @@ ], "properties": { "reportScheduleId": { - "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID.", - "type": "string" + "type": "string", + "description": "The identifier for the report schedule. This identifier is unique only in combination with a seller ID." } } }, @@ -2172,25 +2455,25 @@ "ReportDocument": { "type": "object", "required": [ - "reportDocumentId", "encryptionDetails", + "reportDocumentId", "url" ], "properties": { "reportDocumentId": { - "description": "The identifier for the report document. This identifier is unique only in combination with a seller ID.", - "type": "string" + "type": "string", + "description": "The identifier for the report document. This identifier is unique only in combination with a seller ID." }, "url": { - "description": "A presigned URL for the report document. This URL expires after 5 minutes.", - "type": "string" + "type": "string", + "description": "A presigned URL for the report document. This URL expires after 5 minutes." }, "encryptionDetails": { "$ref": "#/definitions/ReportDocumentEncryptionDetails" }, "compressionAlgorithm": { - "description": "If present, the report document contents have been compressed with the provided algorithm.", "type": "string", + "description": "If present, the report document contents have been compressed with the provided algorithm.", "enum": [ "GZIP" ], @@ -2215,6 +2498,5 @@ }, "description": "Response schema." } - }, - "basePath": "/" -} + } +} \ No newline at end of file diff --git a/models/reports-api-model/reports_2021-06-30.json b/models/reports-api-model/reports_2021-06-30.json index 0520fd1..488853d 100644 --- a/models/reports-api-model/reports_2021-06-30.json +++ b/models/reports-api-model/reports_2021-06-30.json @@ -234,7 +234,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -278,7 +278,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -294,7 +294,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -310,7 +310,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -326,7 +326,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -441,7 +441,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -485,7 +485,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -501,7 +501,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -517,7 +517,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -533,7 +533,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -626,7 +626,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -670,7 +670,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -686,7 +686,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -702,7 +702,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -718,7 +718,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -825,7 +825,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -869,7 +869,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -885,7 +885,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -901,7 +901,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -917,7 +917,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1047,7 +1047,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1091,7 +1091,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1107,7 +1107,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1123,7 +1123,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1139,7 +1139,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1252,7 +1252,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1296,7 +1296,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1312,7 +1312,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1328,7 +1328,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1344,7 +1344,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1437,7 +1437,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1481,7 +1481,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1497,7 +1497,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1513,7 +1513,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1529,7 +1529,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1632,7 +1632,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1676,7 +1676,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1692,7 +1692,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1708,7 +1708,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1724,7 +1724,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1828,7 +1828,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1872,7 +1872,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1888,7 +1888,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1904,7 +1904,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": { @@ -1920,7 +1920,7 @@ }, "headers": { "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.", + "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", "type": "string" }, "x-amzn-RequestId": {