Document API v1 model
{
"swagger": "2.0",
"info": {
"description": "An Amazon Business API for retrieving and managing invoice reports.",
"version": "2021-09-30",
"title": "Amazon Business Document API",
"license": {
"name": "Amazon Software License",
"url": "https://aws.amazon.com/asl/"
}
},
"host": "api.business.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/reports/2021-09-30/reports": {
"get": {
"tags": [
"reports"
],
"operationId": "getReports",
"description": "Returns detailed pdf reports that match your filter criteria.",
"parameters": [
{
"name": "reportTypes",
"in": "query",
"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"
}
},
{
"name": "processingStatuses",
"in": "query",
"description": "A list of processing statuses used to filter reports.",
"required": false,
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"CANCELLED",
"DONE",
"FATAL",
"IN_PROGRESS",
"IN_QUEUE"
],
"x-docgen-enum-table-extension": [
{
"value": "CANCELLED",
"description": "The report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return."
},
{
"value": "DONE",
"description": "The report has completed processing."
},
{
"value": "FATAL",
"description": "The report was aborted due to a fatal error."
},
{
"value": "IN_PROGRESS",
"description": "The report is being processed."
},
{
"value": "IN_QUEUE",
"description": "The report processing hasn't started. The system may be waiting for another report to complete."
}
]
}
},
{
"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",
"required": false,
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of reports to return in a single call.",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 10
},
{
"name": "createdSince",
"in": "query",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 30 days ago. Reports are retained for a maximum of 30 days.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "createdUntil",
"in": "query",
"description": "The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "nextToken",
"in": "query",
"description": "A string token returned as a response to the previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "getReports request has been submitted.",
"schema": {
"$ref": "#/definitions/GetReportsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportTypes": {
"value": [
"FEE_DISCOUNTS_REPORT",
"GET_AFN_INVENTORY_DATA"
]
},
"processingStatuses": {
"value": [
"IN_QUEUE",
"IN_PROGRESS"
]
}
}
},
"response": {
"nextToken": "VGhpcyB0b2tlbiBpcyBvcGFxdWUgYW5kIGludGVudGlvbmFsbHkgb2JmdXNjYXRlZA==",
"reports": [
{
"reportId": "ID323",
"reportType": "FEE_DISCOUNTS_REPORT",
"dataStartTime": "2019-12-11T13:47:20.677Z",
"dataEndTime": "2019-12-12T13:47:20.677Z",
"createdTime": "2019-12-10T13:47:20.677Z",
"processingStatus": "IN_PROGRESS",
"processingStartTime": "2019-12-10T13:47:20.677Z",
"processingEndTime": "2019-12-12T13:47:20.677Z"
}
]
}
}
]
}
},
"400": {
"description": "The request has missing or invalid parameters and can't be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportTypes": {
"value": [
"FEE_DISCOUNTS_REPORT",
"GET_AFN_INVENTORY_DATA"
]
},
"processingStatuses": {
"value": [
"BAD_VALUE",
"IN_PROGRESS"
]
}
}
},
"response": {
"errors": [
{
"code": "400",
"message": "Invalid request parameters",
"details": "The system encountered an invalid input while processing the request. Please provide all the required parameters to complete the request."
}
]
}
}
]
}
},
"401": {
"description": "The request authorization header is formatted incorrectly or the token is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A 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/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"415": {
"description": "The request's Content-Type header is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"503": {
"description": "The system is experiencing a temporary overloading or a system maintenance is ongoing.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
}
}
},
"post": {
"tags": [
"reports"
],
"operationId": "createReport",
"description": "Creates a report for the specified input parameters.",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateReportSpecification"
}
}
],
"responses": {
"202": {
"description": "The report creation request has been submitted.",
"schema": {
"$ref": "#/definitions/CreateReportResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"reportType": "GET_MERCHANT_LISTINGS_ALL_DATA",
"dataStartTime": "2019-12-10T20:11:24.000Z",
"marketplaceIds": [
"A1PA6795UKMFR9",
"ATVPDKIKX0DER"
]
}
}
}
},
"response": {
"reportId": "ID323"
}
}
]
}
},
"400": {
"description": "The request has missing or invalid parameters and can't be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"reportType": "BAD_FEE_DISCOUNTS_REPORT",
"dataStartTime": "2019-12-10T20:11:24.000Z",
"marketplaceIds": [
"A1PA6795UKMFR9",
"ATVPDKIKX0DER"
]
}
}
}
},
"response": {
"errors": [
{
"code": "400",
"message": "Invalid request parameters",
"details": "The system encountered an invalid input while processing the request. Please provide all the required parameters to complete the request."
}
]
}
}
]
}
},
"401": {
"description": "The request authorization header is formatted incorrectly or the token is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A 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/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"415": {
"description": "The request's Content-Type header is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"503": {
"description": "The system is experiencing a temporary overloading or a system maintenance is ongoing.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/reports/2021-09-30/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.",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The identifier of the report.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The report generation has been cancelled.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportId": {
"value": "ID"
}
}
}
}
]
}
},
"400": {
"description": "The request has missing or invalid parameters and can't be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {}
},
"response": {
"errors": [
{
"code": "400",
"message": "Invalid request parameters",
"details": "The system encountered an invalid input while processing the request. Please provide all the required parameters to complete the request."
}
]
}
}
]
}
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid token.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A 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/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"415": {
"description": "The request's Content-Type header is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"503": {
"description": "The system is experiencing a temporary overloading or a system maintenance is ongoing.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
}
}
},
"get": {
"tags": [
"reports"
],
"operationId": "getReport",
"description": "Returns report details (including the reportDocumentId, if available) for the report that you specify.",
"parameters": [
{
"name": "reportId",
"in": "path",
"required": true,
"description": "The identifier for the report.",
"type": "string"
}
],
"responses": {
"200": {
"description": "The report status has been returned.",
"schema": {
"$ref": "#/definitions/Report"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportId": {
"value": "ID323"
}
}
},
"response": {
"reportId": "ID323",
"reportType": "FEE_DISCOUNTS_REPORT",
"dataStartTime": "2019-12-11T13:47:20.677Z",
"dataEndTime": "2019-12-12T13:47:20.677Z",
"createdTime": "2019-12-10T13:47:20.677Z",
"processingStatus": "IN_PROGRESS",
"processingStartTime": "2019-12-10T13:47:20.677Z",
"processingEndTime": "2019-12-12T13:47:20.677Z"
}
}
]
}
},
"400": {
"description": "The request has missing or invalid parameters and can't be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportId": {
"value": "badReportId1"
}
}
},
"response": {
"errors": [
{
"code": "400",
"message": "Invalid request parameters",
"details": "Invalid input in processing status, please make sure to provide all the required parameters to complete the request."
}
]
}
}
]
}
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid token.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A 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/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"415": {
"description": "The request's Content-Type header is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/reports/2021-09-30/documents/{reportDocumentId}": {
"get": {
"tags": [
"reports"
],
"description": "Returns the information required for retrieving the content of the report.",
"operationId": "getReportDocument",
"parameters": [
{
"name": "reportDocumentId",
"in": "path",
"description": "The identifier for the report document.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The reportDocumentId has been retrieved.",
"schema": {
"$ref": "#/definitions/ReportDocument"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportDocumentId": {
"value": "0356cf79-b8b0-4226-b4b9-0ee058ea5760"
}
}
},
"response": {
"reportDocumentId": "0356cf79-b8b0-4226-b4b9-0ee058ea5760",
"url": "https://d34o8swod1owfl.cloudfront.net/Report_47700__GET_MERCHANT_LISTINGS_ALL_DATA_.txt"
}
}
]
}
},
"400": {
"description": "The request has missing or invalid parameters and can't be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reportDocumentId": {
"value": "badDocumentId1"
}
}
},
"response": {
"errors": [
{
"code": "400",
"message": "Invalid request parameters",
"details": "The system encountered an invalid input while processing the request. Please provide all the required parameters to complete the request."
}
]
}
}
]
}
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid token.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"403": {
"description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"404": {
"description": "The specified resource doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"415": {
"description": "The request's Content-Type header is invalid.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
},
"503": {
"description": "The system is experiencing a temporary overloading or a system maintenance is ongoing.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "A unique request reference identifier."
}
}
}
}
}
}
},
"definitions": {
"ErrorList": {
"type": "object",
"description": "A list of error responses returned when a request is unsuccessful.",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
}
}
},
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occurred."
},
"message": {
"type": "string",
"description": "A message that describes the error condition."
},
"details": {
"type": "string",
"description": "Additional details that can help the caller understand or fix the issue."
}
},
"description": "Error response returned when the request is unsuccessful."
},
"Report": {
"type": "object",
"required": [
"processingStatus",
"reportId",
"reportType",
"createdTime"
],
"properties": {
"marketplaceIds": {
"description": "A list of marketplace identifiers for the report.",
"type": "array",
"items": {
"type": "string"
}
},
"reportId": {
"description": "The identifier for the report.",
"type": "string"
},
"reportType": {
"description": "The requested report type.",
"type": "string"
},
"dataStartTime": {
"description": "The start of a date and time range used for selecting the data to report.",
"type": "string",
"format": "date-time"
},
"dataEndTime": {
"description": "The end of a date and time range used for selecting the data to report.",
"type": "string",
"format": "date-time"
},
"createdTime": {
"description": "The date and time when the report was created.",
"type": "string",
"format": "date-time"
},
"processingStatus": {
"description": "The processing status of the report.",
"type": "string",
"enum": [
"CANCELLED",
"DONE",
"FATAL",
"IN_PROGRESS",
"IN_QUEUE"
],
"x-docgen-enum-table-extension": [
{
"value": "CANCELLED",
"description": "The report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return."
},
{
"value": "DONE",
"description": "The report has completed processing."
},
{
"value": "FATAL",
"description": "The report was aborted due to a fatal error."
},
{
"value": "IN_PROGRESS",
"description": "The report is being processed."
},
{
"value": "IN_QUEUE",
"description": "The report processing hasn't started. The system may be waiting for another report to complete."
}
]
},
"processingStartTime": {
"description": "The date and time when the report processing started, in ISO 8601 date time format.",
"type": "string",
"format": "date-time"
},
"processingEndTime": {
"description": "The date and time when the report processing was completed, in ISO 8601 date time format.",
"type": "string",
"format": "date-time"
},
"reportDocumentId": {
"description": "The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve the report document's contents.",
"type": "string"
}
}
},
"ReportList": {
"type": "array",
"items": {
"$ref": "#/definitions/Report"
}
},
"CreateReportSpecification": {
"type": "object",
"required": [
"marketplaceIds",
"reportType"
],
"properties": {
"reportOptions": {
"$ref": "#/definitions/ReportOptions"
},
"reportType": {
"description": "The type of report used for filtering reports to retrieve.",
"type": "string"
},
"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"
},
"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"
},
"marketplaceIds": {
"description": "A list of marketplace identifiers. The report will contain data for all of the specified marketplaces, unless the report type indicates otherwise.",
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "string"
}
}
}
},
"ReportOptions": {
"description": "Additional information passed in the request. This varies by report type.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"CreateReportResponse": {
"type": "object",
"required": [
"reportId"
],
"properties": {
"reportId": {
"description": "The identifier for the report. This identifier is unique only in combination with a business entity.",
"type": "string"
}
}
},
"GetReportsResponse": {
"type": "object",
"required": [
"reports"
],
"properties": {
"reports": {
"description": "The report list with processingStatus, reportId,reportType, and createdTime",
"$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"
}
},
"description": "The response for the getReports operation."
},
"ReportDocument": {
"type": "object",
"required": [
"reportDocumentId",
"url"
],
"properties": {
"reportDocumentId": {
"description": "The identifier for the report document.",
"type": "string"
},
"url": {
"description": "A presigned URL for the report document. This URL expires after 5 minutes.",
"type": "string"
},
"compressionAlgorithm": {
"description": "If present, the report document contents have been compressed with the provided algorithm.",
"type": "string",
"enum": [
"GZIP"
],
"x-docgen-enum-table-extension": [
{
"value": "GZIP",
"description": "The gzip compression algorithm."
}
]
}
}
}
},
"basePath": "/"
}
Updated 9 days ago
Did this page help you?