getSubscriptionById

get https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/{notificationType}/{subscriptionId}

Returns information about a subscription for the specified notification type. The getSubscriptionById operation is grantless. For more information, refer to Grantless operations.

Usage Plan:

Rate (requests per second)	Burst
1	5

The 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 observe higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Responses

Response body

object

payload

object

Information about the subscription.

subscriptionId

string

required

The subscription identifier generated when the subscription is created.

payloadVersion

string

required

The version of the payload object to be used in the notification.

destinationId

string

required

The identifier for the destination where notifications will be delivered.

processingDirective

object

Additional information passed to the subscription to control the processing of notifications. For example, you can use an eventFilter to customize your subscription to send notifications for only the specified marketplaceIds, or select the aggregation time period at which to send notifications (for example: limit to one notification every five minutes for high frequency notifications). The specific features available vary depending on the notificationType.

This feature is currently only supported by the ANY_OFFER_CHANGED and ORDER_CHANGE notificationTypes.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/notificationType/subscriptionId \
3
     --header 'accept: application/json'


xxxxxxxxxx
28
}
1
{
2
  "payload": {
3
    "subscriptionId": "string",
4
    "payloadVersion": "string",
5
    "destinationId": "string",
6
    "processingDirective": {
7
      "eventFilter": {
8
        "aggregationSettings": {
9
          "aggregationTimePeriod": "FiveMinutes"
10
        },
11
        "marketplaceIds": [
12
          "string"
13
        ],
14
        "orderChangeTypes": [
15
          "OrderStatusChange"
16
        ],
17
        "eventFilterType": "ANY_OFFER_CHANGED"
18
      }
19
    }
20
  },
21
  "errors": [
22
    {
23
      "code": "string",
24
      "message": "string",
25
      "details": "string"

200Success.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

409The resource specified conflicts with the current state.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.