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

Body Params application/json

Example

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

Request Code 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

Body

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