Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'reportTypes', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'processingStatuses', 'CANCELLED'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'marketplaceIds', '<string>'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'pageSize', 10
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'createdSince', '<dateTime>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'createdUntil', '<dateTime>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'nextToken', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @processingStatus nvarchar(4000)
DECLARE @reportId nvarchar(4000)
DECLARE @reportType nvarchar(4000)
DECLARE @createdTime nvarchar(4000)
DECLARE @dataStartTime nvarchar(4000)
DECLARE @dataEndTime nvarchar(4000)
DECLARE @reportScheduleId nvarchar(4000)
DECLARE @processingStartTime nvarchar(4000)
DECLARE @processingEndTime nvarchar(4000)
DECLARE @reportDocumentId nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @nextToken nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @nextToken OUT, 'nextToken'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'reports'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @processingStatus OUT, 'reports[i].processingStatus'
EXEC sp_OAMethod @jResp, 'StringOf', @reportId OUT, 'reports[i].reportId'
EXEC sp_OAMethod @jResp, 'StringOf', @reportType OUT, 'reports[i].reportType'
EXEC sp_OAMethod @jResp, 'StringOf', @createdTime OUT, 'reports[i].createdTime'
EXEC sp_OAMethod @jResp, 'StringOf', @dataStartTime OUT, 'reports[i].dataStartTime'
EXEC sp_OAMethod @jResp, 'StringOf', @dataEndTime OUT, 'reports[i].dataEndTime'
EXEC sp_OAMethod @jResp, 'StringOf', @reportScheduleId OUT, 'reports[i].reportScheduleId'
EXEC sp_OAMethod @jResp, 'StringOf', @processingStartTime OUT, 'reports[i].processingStartTime'
EXEC sp_OAMethod @jResp, 'StringOf', @processingEndTime OUT, 'reports[i].processingEndTime'
EXEC sp_OAMethod @jResp, 'StringOf', @reportDocumentId OUT, 'reports[i].reportDocumentId'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'reports[i].marketplaceIds'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'reports[i].marketplaceIds[j]'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
