createSubscription

POST

/notifications/v1/subscriptions/{notificationType}

Last modified:2024-12-09 09:05:16

Maintainer:Not configured

Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version.

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.

Request

Path Params

notificationType

string

required

The type of notification.

For more information about notification types, refer to Notification Type Values.

Body Params application/json

The request schema for the `createSubscription` operation.

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 (ProcessingDirective)

optional

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.

eventFilter

object (EventFilter)

optional

A notificationType specific filter. This object contains all of the currently available filters and properties that you can use to define a notificationType specific filter.

Example

{
    "payloadVersion": "string",
    "destinationId": "string",
    "processingDirective": {
        "eventFilter": {
            "aggregationSettings": {
                "aggregationTimePeriod": "FiveMinutes"
            },
            "marketplaceIds": [
                "string"
            ],
            "orderChangeTypes": [
                "OrderStatusChange"
            ],
            "eventFilterType": "ANY_OFFER_CHANGED"
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payloadVersion": "string",
    "destinationId": "string",
    "processingDirective": {
        "eventFilter": {
            "aggregationSettings": {
                "aggregationTimePeriod": "FiveMinutes"
            },
            "marketplaceIds": [
                "string"
            ],
            "orderChangeTypes": [
                "OrderStatusChange"
            ],
            "eventFilterType": "ANY_OFFER_CHANGED"
        }
    }
}'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the `createSubscription` operation.

payload

object (Subscription)

optional

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 (ProcessingDirective)

optional

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

errors

array[object (Error) {3}]

optional

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

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

optional

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

Example

{
    "payload": {
        "subscriptionId": "string",
        "payloadVersion": "string",
        "destinationId": "string",
        "processingDirective": {
            "eventFilter": {
                "aggregationSettings": {
                    "aggregationTimePeriod": "FiveMinutes"
                },
                "marketplaceIds": [
                    "string"
                ],
                "orderChangeTypes": [
                    "OrderStatusChange"
                ],
                "eventFilterType": "ANY_OFFER_CHANGED"
            }
        }
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠409409

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Modified at 2024-12-09 09:05:16

getSubscription

getSubscriptionById