App Integrations API v2024-04-01 Reference
Send notifications to sellers on Seller Central.
Overview
With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
Version information
Version : 2024-04-01
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
createNotification
deleteNotifications
recordActionFeedback
Paths
POST /appIntegrations/2024-04-01/notifications
Operation: createNotification
Description
Create a notification for sellers in Seller Central.
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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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 body for the createNotification operation. | CreateNotificationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successful creation of notification with the identifier captured in response. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateNotificationResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Example HTTP request
Request body
{
"body" : {
"templateId" : "PRICE_CHANGE",
"marketplaceId" : "ATVPDKIKX0DER",
"notificationParameters" : {
"priceValue" : "200"
}
}
}
POST /appIntegrations/2024-04-01/notifications/deletion
Operation: deleteNotifications
Description
Remove your application's notifications from the Appstore notifications dashboard.
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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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 body for the deleteNotifications operation. | DeleteNotificationsRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Successfully processed the deleteNotifications request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | No Content |
For error status codes, descriptions and schemas, see Error responses and schemas.
Example HTTP request
Request body
{
"body" : {
"templateId" : "PRICE_CHANGE",
"deletionReason" : "INCORRECT_CONTENT"
}
}
POST /appIntegrations/2024-04-01/notifications/{notificationId}/feedback
Operation: recordActionFeedback
Description
Records the seller's response to a notification.
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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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 | notificationId required | A notificationId uniquely identifies a notification. | string |
| Body | body required | The request body for the recordActionFeedback operation. | RecordActionFeedbackRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Successfully processed the recordActionFeedback request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | No Content |
For error status codes, descriptions and schemas, see Error responses and schemas.
Example HTTP request
Request body
{
"body" : {
"feedbackActionCode" : "SELLER_ACTION_COMPLETED"
}
}
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 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. | ErrorList |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 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. | ErrorList |
| 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. | ErrorList |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
Error
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 |
ErrorList
A list of error responses returned when a request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors required | Error response returned when the request is unsuccessful. | < Error > array |
CreateNotificationRequest
The request for the createNotification operation.
| Name | Description | Schema |
|---|---|---|
| templateId required | The unique identifier of the notification template you used to onboard your application. | string |
| notificationParameters required | The parameters specified in the template you used to onboard your application. | NotificationParameters |
| marketplaceId optional | An encrypted marketplace identifier for the posted notification. | string |
NotificationParameters
The dynamic parameters required by the notification templated specified by templateId.
Type : object
CreateNotificationResponse
The response for the createNotification operation.
| Name | Description | Schema |
|---|---|---|
| notificationId optional | The unique identifier assigned to each notification. | string |
DeleteNotificationsRequest
The request for the deleteNotifications operation.
| Name | Description | Schema |
|---|---|---|
| templateId required | The unique identifier of the notification template you used to onboard your application. | string |
| deletionReason required | The unique identifier that maps each notification status to a reason code. | enum (DeletionReason) |
RecordActionFeedbackRequest
The request for the recordActionFeedback operation.
| Name | Description | Schema |
|---|---|---|
| feedbackActionCode required | The unique identifier for each notification status. | enum (FeedbackActionCode) |
FeedbackActionCode
The unique identifier for each notification status.
Type : enum
| Value | Description |
|---|---|
| SELLER_ACTION_COMPLETED | The seller completed the action attached to the posted notification. |
DeletionReason
The unique identifier that maps each notification status to a reason code.
Type : enum
| Value | Description |
|---|---|
| INCORRECT_CONTENT | The notification's content is recognized to be incorrect. |
| INCORRECT_RECIPIENT | The notification was sent to incorrect seller. |
Updated 15 days ago