{ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Notifications", "description": "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.\n\nFor more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" }, "license": { "name": "Apache License 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "v1" }, "servers": [ { "url": "https://sellingpartnerapi-na.amazon.com/" } ], "paths": { "/notifications/v1/subscriptions/{notificationType}": { "get": { "tags": [ "notifications" ], "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.\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getSubscription", "parameters": [ { "$ref": "#/components/parameters/NotificationType" }, { "name": "payloadVersion", "in": "query", "description": "The version of the payload object to be used in the notification.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } }, "Successful Response": { "example": { "payload": { "subscriptionId": "7fcacc7e-727b-11e9-8848-1681be663d3e", "payloadVersion": "1.0", "destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2", "processingDirective": { "eventFilter": { "marketplaceIds": [ "ATVPDKIKX0DER", "A2EUQ1WTGCTBG2" ], "aggregationSettings": { "aggregationTimePeriod": "FiveMinutes" }, "eventFilterType": "ANY_OFFER_CHANGED" } } } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "payload": { "subscriptionId": "TEST_CASE_200_SUBSCRIPTION_ID", "payloadVersion": "1.0", "destinationId": "TEST_CASE_200_DESTINATION_ID" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } } } }, "post": { "tags": [ "notifications" ], "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.\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createSubscription", "parameters": [ { "$ref": "#/components/parameters/NotificationType" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } }, "Successful Response": { "example": { "payload": { "subscriptionId": "7fcacc7e-727b-11e9-8848-1681be663d3e", "payloadVersion": "1.0", "destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2" } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "payload": { "subscriptionId": "TEST_CASE_200_SUBSCRIPTION_ID", "payloadVersion": "1.0", "destinationId": "TEST_CASE_200_DESTINATION_ID" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionResponse" } } } } }, "x-codegen-request-body-name": "body" } }, "/notifications/v1/subscriptions/{notificationType}/{subscriptionId}": { "get": { "tags": [ "notifications" ], "description": "Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getSubscriptionById", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "The identifier for the subscription that you want to get.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/NotificationType" } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } }, "Successful Response": { "example": { "payload": { "subscriptionId": "7fcacc7e-727b-11e9-8848-1681be663d3e", "payloadVersion": "1.0", "destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2" } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "payload": { "subscriptionId": "TEST_CASE_200_SUBSCRIPTION_ID", "payloadVersion": "1.0", "destinationId": "TEST_CASE_200_DESTINATION_ID" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionByIdResponse" } } } } } }, "delete": { "tags": [ "notifications" ], "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](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deleteSubscriptionById", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "The identifier for the subscription that you want to delete.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/NotificationType" } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } }, "Successful Operation Response": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSubscriptionByIdResponse" } } } } } } }, "/notifications/v1/destinations": { "get": { "tags": [ "notifications" ], "description": "Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getDestinations", "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } }, "Successful Response": { "example": { "payload": [ { "destinationId": "9e7a83ee-7730-11e9-8f9e-2a86e4085a59", "name": "SQSDestination", "resource": { "sqs": { "arn": "arn:aws:sqs:us-east-2:444455556666:queue1" } } } ] } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "payload": [ { "destinationId": "TEST_CASE_200", "resource": { "sqs": { "arn": "arn:aws:sqs:us-east-2:444455556666:queue1" } }, "name": "SQSDestination" } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationsResponse" } } } } } }, "post": { "tags": [ "notifications" ], "description": "Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createDestination", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationRequest" } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } }, "Successful Response": { "example": { "payload": { "destinationId": "9e7a83ee-7730-11e9-8f9e-2a86e4085a59", "resource": { "sqs": { "arn": "arn:aws:sqs:us-east-2:444455556666:queue1" } }, "name": "SQSDestination" } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "payload": { "destinationId": "TEST_CASE_200_DESTINATION_ID", "resource": { "sqs": { "arn": "arn:aws:sqs:us-east-2:444455556666:queue1" } }, "name": "SQSDestination" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDestinationResponse" } } } } }, "x-codegen-request-body-name": "body" } }, "/notifications/v1/destinations/{destinationId}": { "get": { "tags": [ "notifications" ], "description": "Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getDestination", "parameters": [ { "name": "destinationId", "in": "path", "description": "The identifier generated when you created the destination.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } }, "Successful Response": { "example": { "payload": { "destinationId": "9e7a83ee-7730-11e9-8f9e-2a86e4085a59", "name": "SQSDestination", "resource": { "sqs": { "arn": "arn:aws:sqs:us-east-2:444455556666:queue1" } } } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "payload": { "destinationId": "TEST_CASE_200_DESTINATION", "resource": { "sqs": { "arn": "arn:aws:sqs:us-east-2:444455556666:queue1" } }, "name": "SQSDestination" } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDestinationResponse" } } } } } }, "delete": { "tags": [ "notifications" ], "description": "Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).\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 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "deleteDestination", "parameters": [ { "name": "destinationId", "in": "path", "description": "The identifier for the destination that you want to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } }, "Successful Response": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "409": { "description": "The resource specified conflicts with the current state.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDestinationResponse" } } } } } } } }, "components": { "schemas": { "ProcessingDirective": { "type": "object", "properties": { "eventFilter": { "$ref": "#/components/schemas/EventFilter" } }, "description": "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 `marketplaceId`s, 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`.\n\nThis feature is currently only supported by the `ANY_OFFER_CHANGED` and `ORDER_CHANGE` `notificationType`s." }, "EventFilter": { "description": "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.", "allOf": [ { "$ref": "#/components/schemas/AggregationFilter" }, { "$ref": "#/components/schemas/MarketplaceFilter" }, { "$ref": "#/components/schemas/OrderChangeTypeFilter" }, { "required": [ "eventFilterType" ], "type": "object", "properties": { "eventFilterType": { "type": "string", "description": "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](https://developer-docs.amazon.com/sp-api/docs/notification-type-values) to determine if an `eventFilterType` is supported.", "enum": [ "ANY_OFFER_CHANGED", "ORDER_CHANGE" ] } } } ] }, "MarketplaceFilter": { "type": "object", "properties": { "marketplaceIds": { "$ref": "#/components/schemas/MarketplaceIds" } }, "description": "An event filter to customize your subscription to send notifications for only the specified `marketplaceId`s." }, "MarketplaceIds": { "type": "array", "description": "A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.", "items": { "type": "string" } }, "AggregationFilter": { "type": "object", "properties": { "aggregationSettings": { "$ref": "#/components/schemas/AggregationSettings" } }, "description": "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)." }, "AggregationSettings": { "required": [ "aggregationTimePeriod" ], "type": "object", "properties": { "aggregationTimePeriod": { "$ref": "#/components/schemas/AggregationTimePeriod" } }, "description": "A container that holds all of the necessary properties to configure the aggregation of notifications." }, "AggregationTimePeriod": { "type": "string", "description": "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.", "enum": [ "FiveMinutes", "TenMinutes" ], "x-docgen-enum-table-extension": [ { "value": "FiveMinutes", "description": "An aggregated notification will be sent every five minutes." }, { "value": "TenMinutes", "description": "An aggregated notification will be sent every ten minutes." } ] }, "OrderChangeTypeFilter": { "type": "object", "properties": { "orderChangeTypes": { "$ref": "#/components/schemas/OrderChangeTypes" } }, "description": "An event filter to customize your subscription to send notifications for only the specified `orderChangeType`." }, "OrderChangeTypes": { "type": "array", "description": "A list of order change types to subscribe to (for example: `BuyerRequestedChange`). To receive notifications of all change types, do not provide this list.", "items": { "$ref": "#/components/schemas/OrderChangeTypeEnum" } }, "OrderChangeTypeEnum": { "type": "string", "description": "The supported order change type of ORDER_CHANGE notification.", "enum": [ "OrderStatusChange", "BuyerRequestedChange" ] }, "Subscription": { "required": [ "destinationId", "payloadVersion", "subscriptionId" ], "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier generated when the subscription is created." }, "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "$ref": "#/components/schemas/ProcessingDirective" } }, "description": "Information about the subscription." }, "CreateSubscriptionResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Subscription" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `createSubscription` operation." }, "CreateSubscriptionRequest": { "required": [ "destinationId", "payloadVersion" ], "type": "object", "properties": { "payloadVersion": { "type": "string", "description": "The version of the payload object to be used in the notification." }, "destinationId": { "type": "string", "description": "The identifier for the destination where notifications will be delivered." }, "processingDirective": { "$ref": "#/components/schemas/ProcessingDirective" } }, "description": "The request schema for the `createSubscription` operation." }, "GetSubscriptionByIdResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Subscription" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `getSubscriptionById` operation." }, "GetSubscriptionResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Subscription" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `getSubscription` operation." }, "DeleteSubscriptionByIdResponse": { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `deleteSubscriptionById` operation." }, "DestinationList": { "type": "array", "description": "A list of destinations.", "items": { "$ref": "#/components/schemas/Destination" } }, "Destination": { "required": [ "destinationId", "name", "resource" ], "type": "object", "properties": { "name": { "maxLength": 256, "type": "string", "description": "The developer-defined name for this destination." }, "destinationId": { "type": "string", "description": "The destination identifier generated when you created the destination." }, "resource": { "$ref": "#/components/schemas/DestinationResource" } }, "description": "Information about the destination created when you call the `createDestination` operation." }, "DestinationResource": { "type": "object", "properties": { "sqs": { "$ref": "#/components/schemas/SqsResource" }, "eventBridge": { "$ref": "#/components/schemas/EventBridgeResource" } }, "description": "The destination resource types." }, "DestinationResourceSpecification": { "type": "object", "properties": { "sqs": { "$ref": "#/components/schemas/SqsResource" }, "eventBridge": { "$ref": "#/components/schemas/EventBridgeResourceSpecification" } }, "description": "The information required to create a destination resource. Applications should use one resource type (sqs or eventBridge) per destination." }, "SqsResource": { "required": [ "arn" ], "type": "object", "properties": { "arn": { "maxLength": 1000, "pattern": "^arn:aws:sqs:\\S+:\\S+:\\S+", "type": "string", "description": "The Amazon Resource Name (ARN) associated with the SQS queue." } }, "description": "The information required to create an Amazon Simple Queue Service (Amazon SQS) queue destination." }, "EventBridgeResourceSpecification": { "required": [ "accountId", "region" ], "type": "object", "properties": { "region": { "type": "string", "description": "The AWS region in which you will be receiving the notifications." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "description": "The information required to create an Amazon EventBridge destination." }, "EventBridgeResource": { "required": [ "accountId", "name", "region" ], "type": "object", "properties": { "name": { "maxLength": 256, "type": "string", "description": "The name of the partner event source associated with the destination." }, "region": { "type": "string", "description": "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](https://docs.aws.amazon.com/general/latest/gr/ev.html)." }, "accountId": { "type": "string", "description": "The identifier for the AWS account that is responsible for charges related to receiving notifications." } }, "description": "The Amazon EventBridge destination." }, "CreateDestinationRequest": { "required": [ "name", "resourceSpecification" ], "type": "object", "properties": { "resourceSpecification": { "$ref": "#/components/schemas/DestinationResourceSpecification" }, "name": { "type": "string", "description": "A developer-defined name to help identify this destination." } }, "description": "The request schema for the `createDestination` operation." }, "CreateDestinationResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Destination" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the createDestination operation." }, "GetDestinationResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/Destination" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `getDestination` operation." }, "GetDestinationsResponse": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/DestinationList" }, "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `getDestinations` operation." }, "DeleteDestinationResponse": { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/ErrorList" } }, "description": "The response schema for the `deleteDestination` operation." }, "ErrorList": { "type": "array", "description": "A list of error responses returned when a request is unsuccessful.", "items": { "$ref": "#/components/schemas/Error" } }, "Error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "description": "An error response returned when the request is unsuccessful." } }, "parameters": { "NotificationType": { "name": "notificationType", "in": "path", "description": "The type of notification.\n\n For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).", "required": true, "schema": { "type": "string" } } } }, "x-original-swagger-version": "2.0" }