Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/:notificationType/:subscriptionId",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "payload": {
// "destinationId": "<string>",
// "payloadVersion": "<string>",
// "subscriptionId": "<string>",
// "processingDirective": {
// "eventFilter": {
// "eventFilterType": "<string>",
// "aggregationSettings": {
// "aggregationTimePeriod": "FiveMinutes"
// },
// "marketplaceIds": [
// "<string>",
// "<string>"
// ]
// }
// }
// },
// "errors": [
// {
// "code": "<string>",
// "message": "<string>",
// "details": "<string>"
// },
// {
// "code": "<string>",
// "message": "<string>",
// "details": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcDestinationId = loJResp.StringOf("payload.destinationId")
lcPayloadVersion = loJResp.StringOf("payload.payloadVersion")
lcSubscriptionId = loJResp.StringOf("payload.subscriptionId")
lcEventFilterType = loJResp.StringOf("payload.processingDirective.eventFilter.eventFilterType")
lcAggregationTimePeriod = loJResp.StringOf("payload.processingDirective.eventFilter.aggregationSettings.aggregationTimePeriod")
i = 0
lnCount_i = loJResp.SizeOfArray("payload.processingDirective.eventFilter.marketplaceIds")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("payload.processingDirective.eventFilter.marketplaceIds[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
do while i < lnCount_i
loJResp.I = i
lcCode = loJResp.StringOf("errors[i].code")
lcMessage = loJResp.StringOf("errors[i].message")
lcDetails = loJResp.StringOf("errors[i].details")
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/:notificationType/:subscriptionId
Postman Collection Item JSON
{
"name": "get Subscription By Id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType",
"value": "<string>"
},
{
"key": "subscriptionId",
"value": "<string>"
}
]
},
"description": "Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see [Grantless operations](doc:grantless-operations) in the Selling Partner API Developer Guide.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\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](doc:usage-plans-and-rate-limits-in-the-sp-api)."
},
"response": [
{
"name": "Success.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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": "Request has missing or invalid parameters and cannot be parsed.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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 resource specified does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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 resource specified conflicts with the current state.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "Conflict",
"code": 409,
"_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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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 size exceeded the maximum accepted size.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"status": "Request Entity Too Large",
"code": 413,
"_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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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 payload is in an unsupported format.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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}}/notifications/v1/subscriptions/:notificationType/:subscriptionId",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType",
":subscriptionId"
],
"variable": [
{
"key": "notificationType"
},
{
"key": "subscriptionId"
}
]
}
},
"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 \"payload\": {\n \"destinationId\": \"<string>\",\n \"payloadVersion\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"processingDirective\": {\n \"eventFilter\": {\n \"eventFilterType\": \"<string>\",\n \"aggregationSettings\": {\n \"aggregationTimePeriod\": \"FiveMinutes\"\n },\n \"marketplaceIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n },\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}"
}
]
}
