Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sProcessingStatus
String sReportId
String sReportType
String sCreatedTime
String sDataStartTime
String sDataEndTime
String sReportScheduleId
String sProcessingStartTime
String sProcessingEndTime
String sReportDocumentId
Integer j
Integer iCount_j
String sStrVal
String sNextToken
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "reportTypes" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "processingStatuses" "CANCELLED" To iSuccess
Get ComUpdateString Of hoQueryParams "marketplaceIds" "<string>" To iSuccess
Get ComUpdateInt Of hoQueryParams "pageSize" 10 To iSuccess
Get ComUpdateString Of hoQueryParams "createdSince" "<dateTime>" To iSuccess
Get ComUpdateString Of hoQueryParams "createdUntil" "<dateTime>" To iSuccess
Get ComUpdateString Of hoQueryParams "nextToken" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "reports": [
// {
// "processingStatus": "FATAL",
// "reportId": "<string>",
// "reportType": "<string>",
// "createdTime": "<dateTime>",
// "marketplaceIds": [
// "<string>",
// "<string>"
// ],
// "dataStartTime": "<dateTime>",
// "dataEndTime": "<dateTime>",
// "reportScheduleId": "<string>",
// "processingStartTime": "<dateTime>",
// "processingEndTime": "<dateTime>",
// "reportDocumentId": "<string>"
// },
// {
// "processingStatus": "IN_PROGRESS",
// "reportId": "<string>",
// "reportType": "<string>",
// "createdTime": "<dateTime>",
// "marketplaceIds": [
// "<string>",
// "<string>"
// ],
// "dataStartTime": "<dateTime>",
// "dataEndTime": "<dateTime>",
// "reportScheduleId": "<string>",
// "processingStartTime": "<dateTime>",
// "processingEndTime": "<dateTime>",
// "reportDocumentId": "<string>"
// }
// ],
// "nextToken": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "nextToken" To sNextToken
Move 0 To i
Get ComSizeOfArray Of hoJResp "reports" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "reports[i].processingStatus" To sProcessingStatus
Get ComStringOf Of hoJResp "reports[i].reportId" To sReportId
Get ComStringOf Of hoJResp "reports[i].reportType" To sReportType
Get ComStringOf Of hoJResp "reports[i].createdTime" To sCreatedTime
Get ComStringOf Of hoJResp "reports[i].dataStartTime" To sDataStartTime
Get ComStringOf Of hoJResp "reports[i].dataEndTime" To sDataEndTime
Get ComStringOf Of hoJResp "reports[i].reportScheduleId" To sReportScheduleId
Get ComStringOf Of hoJResp "reports[i].processingStartTime" To sProcessingStartTime
Get ComStringOf Of hoJResp "reports[i].processingEndTime" To sProcessingEndTime
Get ComStringOf Of hoJResp "reports[i].reportDocumentId" To sReportDocumentId
Move 0 To j
Get ComSizeOfArray Of hoJResp "reports[i].marketplaceIds" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "reports[i].marketplaceIds[j]" To sStrVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "reportTypes=%3Cstring%3E"
-d "processingStatuses=CANCELLED"
-d "marketplaceIds=%3Cstring%3E"
-d "pageSize=10"
-d "createdSince=%3CdateTime%3E"
-d "createdUntil=%3CdateTime%3E"
-d "nextToken=%3Cstring%3E"
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports
Postman Collection Item JSON
{
"name": "get Reports",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
},
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"reports\": [\n {\n \"processingStatus\": \"FATAL\",\n \"reportId\": \"<string>\",\n \"reportType\": \"<string>\",\n \"createdTime\": \"<dateTime>\",\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"dataStartTime\": \"<dateTime>\",\n \"dataEndTime\": \"<dateTime>\",\n \"reportScheduleId\": \"<string>\",\n \"processingStartTime\": \"<dateTime>\",\n \"processingEndTime\": \"<dateTime>\",\n \"reportDocumentId\": \"<string>\"\n },\n {\n \"processingStatus\": \"IN_PROGRESS\",\n \"reportId\": \"<string>\",\n \"reportType\": \"<string>\",\n \"createdTime\": \"<dateTime>\",\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"dataStartTime\": \"<dateTime>\",\n \"dataEndTime\": \"<dateTime>\",\n \"reportScheduleId\": \"<string>\",\n \"processingStartTime\": \"<dateTime>\",\n \"processingEndTime\": \"<dateTime>\",\n \"reportDocumentId\": \"<string>\"\n }\n ],\n \"nextToken\": \"<string>\"\n}"
},
{
"name": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The specified resource does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "Your rate limit (requests per second) for this operation.",
"type": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The request's Content-Type header is invalid.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Unsupported Media Type",
"code": 415,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "The frequency of requests was greater than allowed.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Temporary overloading or maintenance of the server.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/reports/2021-06-30/reports?reportTypes=<string>&processingStatuses=CANCELLED&marketplaceIds=<string>&pageSize=10&createdSince=<dateTime>&createdUntil=<dateTime>&nextToken=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"2021-06-30",
"reports"
],
"query": [
{
"key": "reportTypes",
"value": "<string>",
"description": "A list of report types used to filter reports. Refer to [Report Type Values](https://developer-docs.amazon.com/sp-api/docs/report-type-values) for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required."
},
{
"key": "processingStatuses",
"value": "CANCELLED",
"description": "A list of processing statuses used to filter reports."
},
{
"key": "marketplaceIds",
"value": "<string>",
"description": "A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify."
},
{
"key": "pageSize",
"value": "10",
"description": "The maximum number of reports to return in a single call."
},
{
"key": "createdSince",
"value": "<dateTime>",
"description": "The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days."
},
{
"key": "createdUntil",
"value": "<dateTime>",
"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."
},
{
"key": "nextToken",
"value": "<string>",
"description": "A string token returned in the response to your 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."
}
]
}
},
"status": "Service Unavailable",
"code": 503,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-amzn-RateLimit-Limit",
"value": "<string>",
"description": {
"content": "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": "text/plain"
}
},
{
"key": "x-amzn-RequestId",
"value": "<string>",
"description": {
"content": "Unique request reference identifier.",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"details\": \"<string>\"\n }\n ]\n}"
}
]
}
