Notifications API v1 Reference
Subscribe to relevant notifications.
Overview
The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more.
For more information, refer to the Notifications Use Case Guide.
Version information
Version : v1
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
getSubscription
createSubscription
getSubscriptionById
deleteSubscriptionById
getDestinations
createDestination
getDestination
deleteDestination
Paths
GET /notifications/v1/subscriptions/{notificationType}
Operation: getSubscription
Description
Returns information about subscription of the specified notification type and payload version. payloadVersion is an optional parameter. When payloadVersion is not provided, it will return latest payload version subscription's information. You can use this API to get subscription information when you do not have a subscription identifier.
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | notificationType required | The type of notification. For more information about notification types, refer to Notification Type Values. | string |
| Query | payloadVersion optional | The version of the payload object to be used in the notification. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
POST /notifications/v1/subscriptions/{notificationType}
Operation: createSubscription
Description
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | The request schema for the createSubscription operation. | CreateSubscriptionRequest |
| Path | notificationType required | The type of notification. For more information about notification types, refer to Notification Type Values. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateSubscriptionResponse |
GET /notifications/v1/subscriptions/{notificationType}/{subscriptionId}
Operation: getSubscriptionById
Description
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | subscriptionId required | The identifier for the subscription that you want to get. | string |
| Path | notificationType required | The type of notification. For more information about notification types, refer to Notification Type Values. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetSubscriptionByIdResponse |
DELETE /notifications/v1/subscriptions/{notificationType}/{subscriptionId}
Operation: deleteSubscriptionById
Description
Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | subscriptionId required | The identifier for the subscription that you want to delete. | string |
| Path | notificationType required | The type of notification. For more information about notification types, refer to Notification Type Values. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteSubscriptionByIdResponse |
GET /notifications/v1/destinations
Operation: getDestinations
Description
Returns information about all destinations. The getDestinations 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
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationsResponse |
POST /notifications/v1/destinations
Operation: createDestination
Description
Creates a destination resource to receive notifications. The createDestination 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | The request schema for the createDestination operation. | CreateDestinationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | CreateDestinationResponse |
GET /notifications/v1/destinations/{destinationId}
Operation: getDestination
Description
Returns information about the destination that you specify. The getDestination 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | destinationId required | The identifier generated when you created the destination. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetDestinationResponse |
DELETE /notifications/v1/destinations/{destinationId}
Operation: deleteDestination
Description
Deletes the destination that you specify. The deleteDestination 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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | destinationId required | The identifier for the destination that you want to delete. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 409 | The resource specified conflicts with the current state. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | DeleteDestinationResponse |
Definitions
ProcessingDirective
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.
| Name | Description | Schema |
|---|---|---|
| eventFilter optional | A notificationType specific filter. | EventFilter |
EventFilter
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.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| aggregationSettings optional | A container that holds all of the necessary properties to configure the aggregation of notifications. | AggregationSettings |
| marketplaceIds optional | A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. | MarketplaceIds |
| orderChangeTypes optional | A list of order change types to subscribe to (for example: BuyerRequestedChange). To receive notifications of all change types, do not provide this list. | OrderChangeTypes |
| eventFilterType required | An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. Refer to Notification Type Values to determine if an eventFilterType is supported. | enum (ANY_OFFER_CHANGED, ORDER_CHANGE) |
MarketplaceFilter
An event filter to customize your subscription to send notifications for only the specified marketplaceIds.
| Name | Description | Schema |
|---|---|---|
| marketplaceIds optional | A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. | MarketplaceIds |
MarketplaceIds
A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.
Type : < string > array
AggregationFilter
A filter used to select the aggregation time period at which to send notifications (for example: limit to one notification every five minutes for high frequency notifications).
| Name | Description | Schema |
|---|---|---|
| aggregationSettings optional | A container that holds all of the necessary properties to configure the aggregation of notifications. | AggregationSettings |
AggregationSettings
A container that holds all of the necessary properties to configure the aggregation of notifications.
| Name | Description | Schema |
|---|---|---|
| aggregationTimePeriod required | The supported time period to use to perform marketplace-ASIN level aggregation. | AggregationTimePeriod |
AggregationTimePeriod
The supported aggregation time periods. For example, if FiveMinutes is the value chosen, and 50 price updates occur for an ASIN within 5 minutes, Amazon will send only two notifications; one for the first event, and then a subsequent notification 5 minutes later with the final end state of the data. The 48 interim events will be dropped.
Type : enum
| Value | Description |
|---|---|
| FiveMinutes | An aggregated notification will be sent every five minutes. |
| TenMinutes | An aggregated notification will be sent every ten minutes. |
OrderChangeTypeFilter
An event filter to customize your subscription to send notifications for only the specified orderChangeType.
| Name | Description | Schema |
|---|---|---|
| orderChangeTypes optional | A list of order change types to subscribe to (for example: BuyerRequestedChange). To receive notifications of all change types, do not provide this list. | OrderChangeTypes |
OrderChangeTypes
A list of order change types to subscribe to (for example: BuyerRequestedChange). To receive notifications of all change types, do not provide this list.
Type : < OrderChangeTypeEnum > array
OrderChangeTypeEnum
The supported order change type of ORDER_CHANGE notification.
Type : enum
| Value | Description |
|---|---|
| OrderStatusChange | - |
| BuyerRequestedChange | - |
Subscription
Information about the subscription.
| Name | Description | Schema |
|---|---|---|
| subscriptionId required | The subscription identifier generated when the subscription is created. | string |
| payloadVersion required | The version of the payload object to be used in the notification. | string |
| destinationId required | The identifier for the destination where notifications will be delivered. | string |
| 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. | ProcessingDirective |
CreateSubscriptionResponse
The response schema for the createSubscription operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the createSubscription operation. | Subscription |
| errors optional | One or more unexpected errors occurred during the createSubscription operation. | ErrorList |
CreateSubscriptionRequest
The request schema for the createSubscription operation.
| Name | Description | Schema |
|---|---|---|
| payloadVersion required | The version of the payload object to be used in the notification. | string |
| destinationId required | The identifier for the destination where notifications will be delivered. | string |
| 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. | ProcessingDirective |
GetSubscriptionByIdResponse
The response schema for the getSubscriptionById operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getSubscriptionById operation. | Subscription |
| errors optional | An unexpected condition occurred during the getSubscriptionById operation. | ErrorList |
GetSubscriptionResponse
The response schema for the getSubscription operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getSubscription operation. | Subscription |
| errors optional | One or more unexpected errors occurred during the getSubscription operation. | ErrorList |
DeleteSubscriptionByIdResponse
The response schema for the deleteSubscriptionById operation.
| Name | Description | Schema |
|---|---|---|
| errors optional | An unexpected condition occurred during the deleteSubscriptionById operation. | ErrorList |
DestinationList
A list of destinations.
Type : < Destination > array
Destination
Information about the destination created when you call the createDestination operation.
| Name | Description | Schema |
|---|---|---|
| name required | The developer-defined name for this destination. maxLength : 256 | string |
| destinationId required | The destination identifier generated when you created the destination. | string |
| resource required | The resource that will receive notifications associated with this destination. | DestinationResource |
DestinationResource
The destination resource types.
| Name | Description | Schema |
|---|---|---|
| sqs optional | An Amazon Simple Queue Service (SQS) queue destination. | SqsResource |
| eventBridge optional | An Amazon EventBridge destination. | EventBridgeResource |
DestinationResourceSpecification
The information required to create a destination resource. Applications should use one resource type (sqs or eventBridge) per destination.
| Name | Description | Schema |
|---|---|---|
| sqs optional | The information required to create an Amazon Simple Queue Service (SQS) queue destination. | SqsResource |
| eventBridge optional | The information required to create an Amazon EventBridge destination. | EventBridgeResourceSpecification |
SqsResource
The information required to create an Amazon Simple Queue Service (Amazon SQS) queue destination.
| Name | Description | Schema |
|---|---|---|
| arn required | The Amazon Resource Name (ARN) associated with the SQS queue. maxLength : 1000 Pattern : "^arn:aws:sqs:\\S+:\\S+:\\S+" | string |
EventBridgeResourceSpecification
The information required to create an Amazon EventBridge destination.
| Name | Description | Schema |
|---|---|---|
| region required | The AWS region in which you will be receiving the notifications. | string |
| accountId required | The identifier for the AWS account that is responsible for charges related to receiving notifications. | string |
EventBridgeResource
The Amazon EventBridge destination.
| Name | Description | Schema |
|---|---|---|
| name required | The name of the partner event source associated with the destination. maxLength : 256 | string |
| region required | The AWS region in which you receive the notifications. For AWS regions that are supported in Amazon EventBridge, refer to Amazon EventBridge endpoints and quotas. | string |
| accountId required | The identifier for the AWS account that is responsible for charges related to receiving notifications. | string |
CreateDestinationRequest
The request schema for the createDestination operation.
| Name | Description | Schema |
|---|---|---|
| resourceSpecification required | The information required to create a destination resource. Applications should use one resource type (sqs or eventBridge) per destination. | DestinationResourceSpecification |
| name required | A developer-defined name to help identify this destination. | string |
CreateDestinationResponse
The response schema for the createDestination operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the createDestination operation. | Destination |
| errors optional | One or more unexpected errors occurred during the createDestination operation. | ErrorList |
GetDestinationResponse
The response schema for the getDestination operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getDestination operation. | Destination |
| errors optional | One or more unexpected errors occurred during the getDestination operation. | ErrorList |
GetDestinationsResponse
The response schema for the getDestinations operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getDestinations operation. | DestinationList |
| errors optional | One or more unexpected errors occurred during the getDestinations operation. | ErrorList |
DeleteDestinationResponse
The response schema for the deleteDestination operation.
| Name | Description | Schema |
|---|---|---|
| errors optional | One or more unexpected errors occurred during the deleteDestination operation. | ErrorList |
ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
Error
An error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
Updated 4 months ago