Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.SetRequestHeader "Accept","application/json"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/:notificationType",sbResponseBody)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(http.LastHeader)
System.DebugLog("Failed.")
Return
End If
// 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
Dim strVal As String
Dim code As String
Dim message As String
Dim details As String
Dim DestinationId As String
DestinationId = jResp.StringOf("payload.destinationId")
Dim PayloadVersion As String
PayloadVersion = jResp.StringOf("payload.payloadVersion")
Dim SubscriptionId As String
SubscriptionId = jResp.StringOf("payload.subscriptionId")
Dim EventFilterType As String
EventFilterType = jResp.StringOf("payload.processingDirective.eventFilter.eventFilterType")
Dim AggregationTimePeriod As String
AggregationTimePeriod = jResp.StringOf("payload.processingDirective.eventFilter.aggregationSettings.aggregationTimePeriod")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("payload.processingDirective.eventFilter.marketplaceIds")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("payload.processingDirective.eventFilter.marketplaceIds[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("errors")
While i < count_i
jResp.I = i
code = jResp.StringOf("errors[i].code")
message = jResp.StringOf("errors[i].message")
details = jResp.StringOf("errors[i].details")
i = i + 1
Wend
Curl Command
curl -X GET
-H "Accept: application/json"
https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/:notificationType
Postman Collection Item JSON
{
"name": "get Subscription",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType",
"value": "<string>"
}
]
},
"description": "Returns information about subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier.\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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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 request size exceeded the maximum accepted size.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/notifications/v1/subscriptions/:notificationType",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"notifications",
"v1",
"subscriptions",
":notificationType"
],
"variable": [
{
"key": "notificationType"
}
]
}
},
"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}"
}
]
}
