# What is the Notifications API?
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. Instead of polling for information, your application can receive information directly from Amazon when an event triggers a notification to which you are subscribed.
You can subscribe to notifications on behalf of sellers or vendors. To determine whether you can subscribe to a notification type on behalf of sellers only, vendors only, or both, go to notificationType.
# Terminology
Amazon EventBridge: A serverless event bus that connects application data from your own applications, integrated Software-as-a-Service (SaaS) applications, and AWS services. For more information, refer to Amazon EventBridge (opens new window).
Amazon Simple Queue Service (Amazon SQS): A fully managed message queuing service for microservices, distributed systems, and serverless applications. For more information, refer to Amazon Simple Queue Service (opens new window).
Partner event source: Used by an AWS partner to send events to an AWS customer account. To receive these events, the customer must associate an event bus with the partner event source. For more information, refer to What Is Amazon EventBridge? (opens new window)
Event bus: Receives events from a source and routes them to target resources according rules associated with the event bus. For more information, see EventBus (opens new window).
# Notification workflows
There are two separate workflows for receiving notifications. The workflow you use depends on the notification type that you want to receive.
Amazon EventBridge workflow
Use this workflow to receive the following notification types:
BRANDED_ITEM_CONTENT_CHANGE. Sent whenever there is a change to the title, description, bullet points, or images, for any ASIN that the selling partner has a brand relationship with.
ITEM_PRODUCT_TYPE_CHANGE. Sent whenever there is a change to the product type name of any ASIN that the selling partner has a brand relationship with.
LISTINGS_ITEM_STATUS_CHANGE. Sent whenever there is a listing status change including buyable transition, listing create or delete for any SKU that the selling partner has.
LISTINGS_ITEM_ISSUES_CHANGE. Sent whenever there is an issues change for any SKU that the selling partner has.
PRODUCT_TYPE_DEFINITIONS_CHANGE. Sent whenever there is a new Product Type or Product Type Version.
See Tutorial: Set up notifications (Amazon EventBridge workflow).
Amazon Simple Queue Service workflow
Use this workflow to receive the following notification types:
ACCOUNT_STATUS_CHANGED. Sent whenever the Account Status changes for the developers subscribed merchant/marketplace pairs. A notification is published whenever the merchant's account status changes between NORMAL, AT_RISK, and DEACTIVATED.
ANY_OFFER_CHANGED. Sent whenever there is a change to any of the top 20 offers, by condition (new or used), or if the external price (the price from other retailers) changes for an item listed by the seller.
B2B_ANY_OFFER_CHANGED. Sent whenever there is a change in any of the top 20 B2B offers, in the form of any price change (either single unit or quantity discount tier prices) for an item listed by the seller.
FBA_OUTBOUND_SHIPMENT_STATUS. Sent whenever we create or cancel a Fulfillment by Amazon shipment for a seller.
FEE_PROMOTION. Sent when a promotion becomes active.
FEED_PROCESSING_FINISHED. Sent whenever any feed submitted using the Selling Partner API for Feeds reaches a feed processing status of DONE, CANCELLED, or FATAL.
FULFILLMENT_ORDER_STATUS. Sent whenever there is a change in the status of a Multi-Channel Fulfillment order.
MFN_ORDER_STATUS_CHANGE. Sent whenever there is a change in the status of a MFN order availability.
ORDER_STATUS_CHANGE. Sent whenever there is a change in the status of order availability.
PRICING_HEALTH. Sent whenever a seller offer is ineligible to be the Featured Offer (Buy Box offer) because of an uncompetitive price.
REPORT_PROCESSING_FINISHED. Sent whenever any report that you have requested using the the Selling Partner API for Reports reaches a report processing status of DONE, CANCELLED, or FATAL.
See Tutorial: Set up notifications (Amazon Simple Queue Service workflow).
# Tutorial: Set up notifications (Amazon EventBridge workflow)
Use this tutorial to receive any of the following notifications types:
BRANDED_ITEM_CONTENT_CHANGE. Sent whenever there is a change to the title, description, bullet points, or images, for any ASIN that the selling partner has a brand relationship with.
ITEM_PRODUCT_TYPE_CHANGE. Sent whenever there is a change to the product type name of any ASIN that the selling partner has a brand relationship with.
LISTINGS_ITEM_STATUS_CHANGE. Sent whenever there is a listing status change including buyable transition, listing create or delete for any SKU that the selling partner has.
LISTINGS_ITEM_ISSUES_CHANGE. Sent whenever there is an issues change for any SKU that the selling partner has.
PRODUCT_TYPE_DEFINITIONS_CHANGE. Sent whenever there is a new Product Type or Product Type Version.
If you want to receive any other notification type, skip this tutorial and go to Tutorial: Set up notifications (Amazon Simple Queue Service workflow).
Prerequisites
To complete this tutorial you will need:
Authorization from the selling partners (sellers or vendors) for whom you are making calls. See the Selling Partner API Developer Guide (opens new window) for more information.
An AWS Account. This AWS account will be responsible for charges related to receiving notifications. If you are not already an AWS customer, you can create a free AWS account. For more information, see AWS Free Tier (opens new window).
A target resource to receive notification events. For more information, see What Is Amazon EventBridge? (opens new window)
A basic understanding of Amazon EventBridge. For more information, see Amazon EventBridge (opens new window).
# Step 1. Create a destination
Call the createDestination operation to create an Amazon EventBridge destination.
Note: You can only create one EventBridge destination per AWS account.
- Call the createDestination (opens new window) operation, passing the following body parameters:
| Parameter | Description | Required |
|---|---|---|
| resourceSpecification |
The information required to create a destination resource. In this workflow, include the eventBridge specification.
Type: resourceSpecification | Yes |
| name |
A developer-defined name to help identify this destination.
Type: string | Yes |
Note: Calling the createDestination operation does not require authorization from any selling partner. In this respect, this operation is a "grantless" operation and has a different authorization model from most other Selling Partner API operations. For more information, see Grantless operations (opens new window) in the Selling Partner API Developer Guide.
Request example:
POST https://sellingpartnerapi-na.amazon.com/notifications/v1/destinations
{
"resourceSpecification":
{
"eventBridge":
{
"accountId": "123456789",
"region": "us-east-1"
}
},
"name": "YourDestinationName"
}
2
3
4
5
6
7
8
9
10
11
12
Response
A successful response includes the following:
| Name | Description |
|---|---|
| resource |
The resource that will receive notifications associated with this destination.
Type: DestinationResource |
| destinationId |
The destination identifier generated when you created the destination.
Type: string |
| name |
The name of this destination.
Type: string |
Response example:
{
"payload": {
"resource": {
"sqs": null,
"eventBridge": {
"name": "sellingpartnerapi.amazon.com/amzn1.sellerapps.app.15a75829-cd4a-4efc-b947-0cc39d874577",
"accountId": "123456789",
"region": "us-east-1"
}
},
"destinationId": "64a4a891-60dd-303f-89f9-43caf25cb3ec",
"name": "YourDestinationName"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
- Save the following values:
resource:eventBridge:name. Use this value in Step 2. Configure Amazon EventBridge to handle notifications.
destinationId. Pass in this value in Step 4. Create a subscription.
# Step 2. Configure Amazon EventBridge to handle notifications
Associate an event bus with your partner event source. For definitions, see Terminology.
Go to Amazon EventBridge (opens new window) and sign into the AWS Console using the AWS Account ID that you specified when you called the createDestination operation in Step 1. Create a destination.
In the console, ensure that the AWS Region that you specified when you called the createDestination operation is selected.
In the navigation pane, click Partner event sources.
In the Partner event sources area, under Name, click the partner event source that matches the resource:eventBridge:name value returned in Step 1. Create a destination. The partner event source is in this format: aws.partner/sellingpartnerapi.amazon.com/{AWS Account Id}/{Application Id}
On the new page that appears, click the Associate with event bus button.
On the Associate with event bus page, leave the checkboxes cleared and click the Associate button.
You have created a partner event bus and associated it with your partner event source. Go to Step 3. Create a rule that triggers on a notification event.
# Step 3. Create a rule that triggers on a notification event
Create a rule that watches for specific notification events and routes them to the target resource of your choice.
Go to Amazon EventBridge (opens new window). If you are not already signed into the AWS Console, sign in using the AWS Account ID that you specified when you called the createDestination operation in Step 1. Create a destination.
In the console, ensure that the AWS Region that you specified when you called the createDestination operation is selected.
In the navigation pane, click Rules.
Click the Create rule button.
Enter a name and optional description for the rule.
In the Define pattern area, select Event pattern.
Select Pre-defined pattern by service.
Under Service provider, select Service partners.
Under Service name, select Amazon Selling Partner APIs.
The event pattern that displays should be similar to the following, which indicates that you will receive all events emitted by sellingpartnerapi.amazon.com:
{
"account": [
"1234567890"
]
}
2
3
4
5
6
- (Optional) Edit the event pattern to include rules that match only the notification events that you want. The following event pattern contains a rule that matches only BRANDED_ITEM_CONTENT_CHANGE events from sellingpartnerapi.amazon.com:
{
"account": [
"1234567890"
],
"detail-type": [
"BRANDED_ITEM_CONTENT_CHANGE"
]
}
2
3
4
5
6
7
8
For information about creating more complex rules, see Event Patterns (opens new window) in the AWS documentation.
In the Select event bus area, select Custom or partner event bus and then select the partner event bus that you configured in Step 2. Configure Amazon EventBridge to handle notifications.
In the Select targets area, select the AWS service that is to act when an event of the selected type is detected. Enter other information specific to this target type, if required.
Note. For many target types, EventBridge needs permissions to send events to the target. In these cases, you can create a new IAM role or you can use an existing IAM role. Do one of the following:
To create an IAM role, select Create a new role for this specific resource.
To use an IAM role that you have already created, select Use existing role.
(Optional) Click Add target to add another target for this rule.
(Optional) Enter one or more tags for the rule. For more information, see Tagging Your Amazon EventBridge Resources (opens new window) in the AWS documentation.
Click the Create button.
Troubleshooting:
If you create a rule with an encrypted Amazon SQS queue as a target, you must include a decrypt action in your AWS Key Management Service (opens new window) key policy for the event to be successfully delivered to the encrypted queue. For more information, see My events are not delivered to the target Amazon SQS queue (opens new window) in the AWS documentation.
For more troubleshooting information, see Troubleshooting Amazon EventBridge (opens new window) in the AWS documentation.
# Step 4. Create a subscription
Subscribe to a notification type, to be delivered to the destination that you created in Step 1. Create a destination.
Note: Only one subscription per application, notification type, and party(seller/vendor) is allowed per region.
- Call the createSubscription (opens new window) operation, passing the following parameters:
Path parameters:
| Parameter | Description | Required |
|---|---|---|
| notificationType |
The type of notification to which you want to subscribe.
Possible values: BRANDED_ITEM_CONTENT_CHANGE, ITEM_PRODUCT_TYPE_CHANGE, LISTINGS_ITEM_STATUS_CHANGE, LISTINGS_ITEM_ISSUES_CHANGE, PRODUCT_TYPE_DEFINITIONS_CHANGE. See notificationType. Type: string | Yes |
Body parameters:
| Parameter | Description | Required |
|---|---|---|
| payloadVersion |
The version of the payload object to be used in the notification.
Type: string | Yes |
| destinationId |
The identifier for the destination where notifications will be delivered. Use the destinationId value that you saved in Step 1. Create a destination.
Type: string | Yes |
Request example:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/BRANDED_ITEM_CONTENT_CHANGE
{
"payloadVersion":"1.0",
"destinationId":"3acafc7e-121b-1329-8ae8-1571be663aa2"
}
2
3
4
5
Response
| Name | Description |
|---|---|
| subscriptionId |
The subscription identifier generated when the subscription is created.
Type: string |
| payloadVersion |
The version of the payload object to be used in the notification.
Type: string |
| destinationId |
The identifier for the destination where notifications will be delivered.
Type: string |
Response example:
{
"payload":{
"subscriptionId":" 7fcacc7e-727b-11e9-8848-1681be663d3e",
"payloadVersion":" 1.0",
"destinationId":"3acafc7e-121b-1329-8ae8-1571be663aa2"
}
}
2
3
4
5
6
7
You are now subscribed to receive BRANDED_ITEM_CONTENT_CHANGE notifications.
# Tutorial: Set up notifications (Amazon Simple Queue Service workflow)
Use this tutorial to set up your system to receive any of the following notifications types:
ACCOUNT_STATUS_CHANGED. Sent whenever the Account Status changes for the developers subscribed merchant/marketplace pairs. A notification is published whenever the merchant's account status changes between NORMAL, AT_RISK, and DEACTIVATED.
ANY_OFFER_CHANGED. Sent whenever there is a listing change for any of the top 20 offers, by condition (new or used), or if the external price (the price from other retailers) changes for an item listed by the seller.
B2B_ANY_OFFER_CHANGED. Sent whenever there is a change in any of the top 20 B2B offers, in the form of any price change (either single unit or quantity discount tier prices) for an item listed by the seller.
FBA_OUTBOUND_SHIPMENT_STATUS. Sent whenever we create or cancel a Fulfillment by Amazon shipment for a seller.
FEE_PROMOTION. Sent when a promotion becomes active.
FEED_PROCESSING_FINISHED. Sent whenever any feed submitted using the Selling Partner API for Feeds reaches a feed processing status of DONE, CANCELLED, or FATAL.
FULFILLMENT_ORDER_STATUS. Sent whenever there is a change in the status of a Multi-Channel Fulfillment order.
MFN_ORDER_STATUS_CHANGE. Sent whenever there is a change in the status of a MFN order availability.
ORDER_STATUS_CHANGE. Sent whenever there is a change in the status of order availability.
PRICING_HEALTH. Sent whenever a seller offer is ineligible to be the Featured Offer (Buy Box offer) because of an uncompetitive price.
REPORT_PROCESSING_FINISHED. Sent whenever any report that you have requested using the the Selling Partner API for Reports reaches a report processing status of DONE, CANCELLED, or FATAL.
Important: To receive any other notification type, go to Tutorial: Set up notifications (Amazon EventBridge workflow).
Prerequisites
To complete this tutorial you will need:
Authorization from the selling partners for whom you are making calls. See the Selling Partner API Developer Guide (opens new window) for more information.
An AWS Account. If you are not already an AWS customer, you can create a free AWS account. For more information, see AWS Free Tier (opens new window).
An Amazon Simple Queue Service (SQS) queue. For information about setting up an SQS queue, see Amazon Simple Queue Service (opens new window).
# Step 1. Grant Selling Partner API permission to write to your SQS queue
To receive notifications you must grant Selling Partner API permission to write to your SQS queue.
Open the AWS Management Console (opens new window) and sign in with your AWS credentials.
From the console, open Simple Queue Service.
Select the Standard queue where you want to receive notifications.
Choose the Access Policy tab.
From the Access policy (Permissions) section, select Edit. The Edit Test Queue page opens.
Scroll down to Access policy, then select the Policy generator link. The AWS Policy Generator opens in a new tab.
In Step 1 of the policy generator, select SQS Queue Policy.
In Step 2 of the policy generator:
- Set Effect to Allow.
- Set Principal to 437568002678.
- Set Actions to SendMessage and GetQueueAttributes.
- Enter the SQS ARN value in Amazon Resource Name (ARN).
- Choose Add Statement and verify the details.
In Step 3 of the policy generator, select Generate Policy. A dialog box with the new policy opens.
Copy the policy.
Navigate back to the Amazon SQS queue, open the Access policy tab, then paste the policy into the Access Policy (Permissions) section.
Save the changes.
Reference the queue's Details section and note the ARN for this queue. You will pass this value using the arn parameter when you call the createDestination operation in Step 2. Create a destination.
Note: If you are using server-side encryption (SSE), then you must provide Selling Partner API access to your key using the AWS Key Management Service (KMS) (opens new window). Consider using the following policy:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::437568002678:root"
},
"Action": [
"kms:GenerateDataKey",
"kms:Decrypt"
],
"Resource": "*"
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
See Key management (opens new window) for more information.
# Step 2. Create a destination
Call the createDestination operation to create an Amazon Simple Queue Service (SQS) destination.
- Call the createDestination (opens new window) operation, passing the following body parameters:
| Parameter | Description | Required |
|---|---|---|
| resourceSpecification |
The information required to create an SQS destination. This includes the sqs:arn value that you got from Step 1. Grant Selling Partner API permission to write to your SQS queue.
Type: object | Yes. |
| name |
A name that you specify to help you identify this destination.
Type: string | Yes |
Note: Calling the createDestination operation does not require authorization from any selling partner. In this respect, this operation is a "grantless" operation and has a different authorization model from most other Selling Partner API operations. For more information, see Grantless operations (opens new window) in the Selling Partner API Developer Guide.
Request example:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/destinations
{
"name": "YourDestinationName",
"resourceSpecification":
{
"sqs":
{
"arn": "arn:aws:sqs:us-east-2:444455556666:queue1"
}
}
}
2
3
4
5
6
7
8
9
10
11
Response
| Name | Description |
|---|---|
| name |
The developer-defined name for this destination.
Type: string |
| destinationId |
The destination identifier generated when you created the destination.
Type: string |
| resource |
The resource that will receive notifications associated with this destination.
Type: object |
Response example:
{
"payload": {
"name": "YourDestinationName",
"destinationId": "ExampleDestinationId",
"resource": {
"sqs": {
"arn": "arn:aws:sqs:us-east-2:444455556666:queue1"
}
}
}
}
2
3
4
5
6
7
8
9
10
11
- Save the destinationId value as input for Step 3. Create a subscription.
# Step 3. Create a subscription
Create a subscription to a notification type, to be delivered to the destination that you created in the previous step.
Note: Only one subscription per application, notification type, and party(seller/vendor) is allowed per region.
- Call the createSubscription (opens new window) operation, passing the following parameters:
Path parameters:
| Parameter | Description | Required |
|---|---|---|
| notificationType |
The type of notification to which you want to subscribe.
Possible values: ACCOUNT_STATUS_CHANGED, ANY_OFFER_CHANGED, B2B_ANY_OFFER_CHANGED, FBA_OUTBOUND_SHIPMENT_STATUS, FEE_PROMOTION, FEED_PROCESSING_FINISHED, FULFILLMENT_ORDER_STATUS, MFN_ORDER_STATUS_CHANGE, ORDER_STATUS_CHANGE, PRICING_HEALTH, REPORT_PROCESSING_FINISHED. See notificationType Type: string | Yes |
Body parameters:
| Parameter | Description | Required |
|---|---|---|
| payloadVersion |
The version of the payload object to be used in the notification.
Type: string | Yes |
| destinationId |
The identifier for the destination where notifications will be delivered. Use the value you saved in Step 2. Create a destination.
Type: string | Yes |
| 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 marketplaceId's, or select the aggregation time period at which to send notifications (e.g. limit to one notification every five minutes for high frequency notifications). The specific features available vary depending on the notificationType. Note: This feature is limited to specific notificationTypes and is currently only supported by the ANY_OFFER_CHANGED notificationType. Type: ProcessingDirective | No |
Request example (without a processing directive):
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"payloadVersion":"1.0",
"destinationId":"3acafc7e-121b-1329-8ae8-1571be663aa2"
}
2
3
4
5
Response
| Name | Description |
|---|---|
| subscriptionId |
The subscription identifier generated when the subscription is created.
Type: string |
| payloadVersion |
The version of the payload object to be used in the notification.
Type: string |
| destinationId |
The identifier for the destination where notifications will be delivered. Use the destinationId value that you saved in the previous step.
Type: string |
Response example:
{
"payload": {
"subscriptionId": "7fcacc7e-727b-11e9-8848-1681be663d3e",
"payloadVersion": "1.0",
"destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2",
}
}
2
3
4
5
6
7
Response
| Name | Description |
|---|---|
| subscriptionId |
The subscription identifier generated when the subscription is created.
Type: string |
| payloadVersion |
The version of the payload object to be used in the notification.
Type: string |
| destinationId |
The identifier for the destination where notifications will be delivered. Use the destinationId value that you saved in the previous step.
Type: string |
Examples that use a processingDirective (Only supported by the ANY_OFFER_CHANGED notificationType)
Request example to create a subscription that sends notifications for only the specified marketplaceId's:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ANY_OFFER_CHANGED",
"marketplaceIds": ["ATVPDKIKX0DER"]
}
}
}
2
3
4
5
6
7
8
9
10
11
Response example:
{
"payload": {
"subscriptionId": "7318ddfb-18e4-4fe0-89f5-a437321d2e79",
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Request example to create a subscription that limits the frequency of notifications to one every five minutes:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ANY_OFFER_CHANGED",
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
Response example:
{
"payload": {
"subscriptionId": "b8877fdf-17a6-4d59-bb1d-9650d9d823e0",
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
},
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Processing notifications from your queue
There are several important properties of Amazon SQS queues that you must understand in order to process notifications properly:
Selling Partner API does not support delivery to FIFO queues. You must use Amazon SQS standard queues to receive notifications.
Selling Partner API standard queues do not guarantee that notifications will be received in the order they were sent. Standard queues provide best-effort ordering, which means that notifications are generally delivered in the same order as they're sent. However, occasionally, more than one copy of a notification might be delivered out of order. Therefore, you must design your application to accept notifications in any order.
Amazon SQS standard queue notifications might be delivered more than once. Amazon SQS stores copies of your notifications on multiple servers for redundancy and high availability. On rare occasions, one of the servers that stores a copy of a notification might be unavailable when you receive or delete a notification. If this scenario occurs, the copy of the notification isn't deleted on that unavailable server, and you might get that notification copy again when you receive notifications. Therefore, you must design your application to accept multiple copies of any given notification.
You can determine if a notification is a duplicate of a notification you have already received by looking at the
notificationIdproperty of the notification. You can find thenotificationIdproperty in theNotificationMetaDataobject of the notification.
For more information about processing notifications from Amazon SQS queues, see the Amazon Simple Queue Service Developer Guide (opens new window) and the Amazon Simple Queue Service API Reference (opens new window) at the AWS Documentation (opens new window) portal.
# Processing Directives
A processing directive is an optional parameter that you can provide when you call the createSubscription (opens new window) operation. It can be used to change the behavior of a subscription for certain notificationTypes. It is currently only supported for use with the ANY_OFFER_CHANGED notificationType. Use with an unsupported notificationType results in a request failure with an HTTP 400 response.
Use a processingDirective to pass additional information 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 to select the aggregation time period at which to send notifications (e.g. limit to one notification every five minutes for high frequency notifications).
The following eventFilter values are supported:
| Name | Description |
|---|---|
| eventFilterType | An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter.
Example: |
| aggregationSettings | A container to support aggregated filtering of notifications. Supports using an aggregationTimePeriod to limit (filter) the sending of notifications to a five or ten minute frequency.
Example: |
| marketplaceIds | A list of marketplace identifiers to subscribe to. To receive notifications for every marketplace, do not provide this list.
Example: |
For more information, refer to ProcessingDirective (opens new window) in the API reference.
Request example that implements a processingDirective with both eventFilter values:
POST https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"payloadVersion": "1.0",
"destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2",
"processingDirective": {
"eventFilter": {
"marketplaceIds": [
"ATVPDKIKX0DER",
"A2EUQ1WTGCTBG2"
],
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
},
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Response:
{
"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"
}
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Notification structure
Selling Partner notifications are in JSON format. Each notification contains a Payload object, which contains the actionable data of the notification. Notification Type, in combination with PayloadVersion, determines the structure of the Payload object.
A Selling Partner notification with NotificationVersion=1.0 contain the following properties:
| Object | Description | Type |
|---|---|---|
| NotificationVersion | The notification version. This controls the structure of the notification. | string |
| NotificationType | The notification type. NotificationType, combined with PayloadVersion, controls the structure of the Payload object. | string |
| PayloadVersion | The payload version. PayloadVersion, combined with NotificationType, controls the structure of the Payload object. | string |
| EventTime | The date and time (in UTC) that the event which triggered the notification occurred. | string |
| Payload | The actionable data of the notification. The structure of the Payload is determined by NotificationType, in combination with PayloadVersion. | JSON object For more information, see Notifications. |
| NotificationMetadata |
The notification metadata. This includes the following objects:
| JSON object |
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "BRANDED_ITEM_CONTENT_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2019-03-20T18:59:30.194Z",
"Payload":
{
"MarketplaceId": "ATVPDKIKX0DER",
"BrandName": "Great Brand",
"Asin": "B1234567",
"AttributesChanged": [
"bullet_point",
"item_name",
"product_description",
"main_product_image_locator",
"other_product_image_locator_1",
"other_product_image_locator_2",
"other_product_image_locator_3",
"other_product_image_locator_4",
"other_product_image_locator_5",
"other_product_image_locator_6",
"other_product_image_locator_7",
"other_product_image_locator_8",
"swatch_product_image_locator"
]
},
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime": "2019-03-20T18:59:48.768Z",
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# notificationType
You can subscribe to various notifications, depending on the selling partner information that you want to receive.
The following notificationType values indicate the notification type:
ACCOUNT_STATUS_CHANGED. Sent whenever the Account Status changes for the developers subscribed merchant/marketplace pairs. A notification is published whenever the merchant's account status changes between NORMAL, AT_RISK, and DEACTIVATED.
ANY_OFFER_CHANGED. Sent whenever there is a change in any of the top 20 offers, by condition (new or used), or if the external price (the price from other retailers) changes for an item listed by the seller.
B2B_ANY_OFFER_CHANGED. Sent whenever there is a change in any of the top 20 B2B offers, in the form of any price change (either single unit or quantity discount tier prices) for an item listed by the seller.
BRANDED_ITEM_CONTENT_CHANGE. Sent whenever there is a change to the title, description, bullet points, or images, for any ASIN that the selling partner has a brand relationship with.
FBA_OUTBOUND_SHIPMENT_STATUS. Sent whenever we create or cancel a Fulfillment by Amazon shipment for a seller.
FEE_PROMOTION. Sent when a promotion becomes active.
FEED_PROCESSING_FINISHED. Sent whenever any feed submitted using the Selling Partner API for Feeds reaches a feed processing status of DONE, CANCELLED, or FATAL.
FULFILLMENT_ORDER_STATUS. Sent whenever there is a change in the status of a Multi-Channel Fulfillment order.
ITEM_PRODUCT_TYPE_CHANGE. Sent whenever there is a change to the product type name of any ASIN that the selling partner has a brand relationship with.
LISTINGS_ITEM_STATUS_CHANGE. Sent whenever there is a change in the status of a listings item that a selling partner owns.
LISTINGS_ITEM_ISSUES_CHANGE. Sent whenever there is a change to the issues associated with a listings item that the selling partner owns.
MFN_ORDER_STATUS_CHANGE. Sent whenever there is a change in the status of a MFN order availability.
ORDER_STATUS_CHANGE. Sent whenever there is a change in the status of order availability.
PRICING_HEALTH. Sent whenever a seller offer is ineligible to be the Featured Offer (Buy Box offer) because of an uncompetitive price.
PRODUCT_TYPE_DEFINITIONS_CHANGE. Sent whenever there is a new Product Type or Product Type Version.
REPORT_PROCESSING_FINISHED. Sent whenever any report that you have requested using the the Selling Partner API for Reports reaches a report processing status of DONE, CANCELLED, or FATAL.
# ACCOUNT_STATUS_CHANGED
Sellers can subscribe to this notification.
The ACCOUNT_STATUS_CHANGED notification is sent whenever the Account Status changes for the developers subscribed merchant/marketplace pairs. A notification is published whenever the merchant's account status changes between NORMAL, AT_RISK, and DEACTIVATED.
ACCOUNT_STATUS_CHANGED Payload schema: Version 2021-01-01
The following table shows the properties of the accountStatusChangeNotification object:
| Name | Description |
|---|---|
| previousAccountStatus |
The seller's account status prior to this update.
Required. Type: string Possible values: NORMAL, AT_RISK, DEACTIVATED |
| currentAccountStatus |
The seller's new account status.
Required. Type: string Possible values: NORMAL, AT_RISK, DEACTIVATED |
Notification schema: AccountStatusChangedNotification.json (opens new window)
Notification example:
{
"notificationVersion": "1.0",
"notificationType": "ACCOUNT_STATUS_CHANGED",
"payloadVersion": "2021-01-01",
"eventTime": "2020-12-11T19:42:04.284Z",
"payload": {
"accountStatusChangeNotification": {
"previousAccountStatus" : "NORMAL",
"currentAccountStatus" : "AT_RISK"
}
},
"notificationMetadata": {
"applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746",
"subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2020-12-11T19:45:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# ANY_OFFER_CHANGED
Sellers can subscribe to this notification.
This notification supports the following event filter values: aggregationSettings, marketplaceIds. To use these filters, you must also provide the following
eventFilterType: "eventFilterType": "ANY_OFFER_CHANGED".
See Processing Directives for more information.
The ANY_OFFER_CHANGED notification is sent whenever there is a change to any of the top 20 offers, by condition (new or used), or if the external price (the price from other retailers) changes for an item that you sell, or if there is a change to which offer wins the BuyBox, or a change to the BuyBox price. The top 20 offers are determined by the landed price, which is the price plus shipping minus Amazon Points. If multiple sellers are charging the same landed price, the results will be returned in random order.
You will only receive ANY_OFFER_CHANGED notifications for items for which you have active offers. You cannot subscribe to notifications for items for which you do not have active offers.
The following table shows the objects and properties of the AnyOfferChangedNotification object:
| Name | Description |
|---|---|
| SellerId |
The seller identifier for the offer.
Required. Type: String |
| OfferChangeTrigger |
The event that caused the notification to be sent.
Required. Type: OfferChangeTrigger |
| Summary |
Information about the product that had the offer change. The information in this summary applies to all conditions of the product.
Required. Type: Summary |
| Offers |
The top 20 competitive offers for the item and condition that triggered the notification.
Required. Type: Array of Offer |
BuyBoxPrice
The following table shows the objects and properties of the BuyBoxPrice object:
| Name | Description |
|---|---|
| LandedPrice |
ListingPrice + Shipping - Points.
Required. Type: MoneyType |
| ListingPrice |
The price of the item.
Required. Type: MoneyType |
| Shipping |
The shipping cost.
Required. Type: MoneyType |
| Points |
The number of Amazon Points offered with the purchase of an item.
Optional. Note: The Points object is only returned in Japan (JP). Type: Points |
| Condition |
Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.
Required. Type: String |
LowestPrice
The following table shows the objects and properties of the LowestPrice object:
| Name | Description |
|---|---|
| LandedPrice | ListingPrice + Shipping - Points. Required. Type: MoneyType |
| ListingPrice | The price of the item. Required. Type: MoneyType |
| Shipping | The shipping cost. Required. Type: MoneyType |
| Points | The number of Amazon Points offered with the purchase of an item. Optional. Note: The Points object is only returned in Japan (JP). Type: Points |
| Condition | Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. Required. Type: String |
| FulfillmentChannel | Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: FulfillmentChannelType |
Offer
The following table shows the objects and properties of the Offer object:
| Name | Description |
|---|---|
| SellerId | The seller identifier for the offer. Required. Type: String |
| SubCondition | The subcondition of the item. For example: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. Required. Type: String |
| SellerFeedbackRating | Information about the seller's feedback, including the percentage of positive feedback, and the total count of feedback received. Optional. Type: SellerFeedbackRating |
| ShippingTime | The minimum and maximum time, in hours, that the item will likely be shipped after the order has been placed. Required. Type: ShippingTime |
| ListingPrice | The price of the item. Required. Type: MoneyType |
| Points | The number of Amazon Points offered with the purchase of an item. Optional. Note: The Points object is only returned in Japan (JP). Type: Points |
| Shipping | The shipping cost. Required. Type: MoneyType |
| ShipsFrom | The state and country from where the item is shipped. Optional. Type: ShipsFrom |
| IsFulfilledByAmazon | Indicates whether the offer is fulfilled by Amazon. Required. Type: boolean |
| IsBuyBoxWinner | Indicates whether the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. Optional. Type: boolean |
| ConditionNotes | Information about the condition of the item. Optional. Type: string |
| PrimeInformation | Amazon Prime information. Optional. Type: PrimeInformation |
| IsExpeditedShippingAvailable | Indicates whether expedited shipping is available. Optional. Type: boolean |
| IsFeaturedMerchant | Indicates whether the seller of the item is eligible to win the Buy Box. Optional. Type: boolean |
| ShipsDomestically | Indicates whether the item ships domestically. Optional. Type: boolean |
OfferChangeTrigger
The following table shows the properties of the OfferChangeTrigger object:
| Name | Description |
|---|---|
| MarketplaceId | The marketplace identifier of the item that had an offer change. Required. Type: string |
| ASIN | The ASIN for the item that had an offer change. Required. Type: string |
| ItemCondition | The condition of the item that had an offer change. For example, if a used offer changes, the array of offers in the Offers object will be only used items. The Summary object provides a summary for the other conditions that can be used for repricing. Required. Type: string |
| TimeOfOfferChange | The update time for the offer that caused this notification, in ISO 8601 format. Required. Type: string |
| OfferChangeType | The type of offer that changed and triggered this notification. OfferChangeType values: External - The CompetitivePriceThreshold in the Summary object has changed, triggered by a new offer from a non-Amazon seller. Internal - The price of an offer on Amazon's retail website has changed. Featured Offer - The BuyBox winner or BuyBox price has changed. Required. Type: string |
OfferCount
The following table shows the objects and properties of the OfferCount object:
| Name | Description |
|---|---|
| Condition | Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. Required. Type: string |
| FulfillmentChannel | Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: FulfillmentChannelType |
| OfferCount | The total number of offers for the specified condition and fulfillment channel. Type: integer |
Points
The following table shows the properties of the Points object:
| Name | Description |
|---|---|
| PointsNumber | The number of Amazon Points offered with the purchase of an item. Required. Type: integer |
PrimeInformation
The following table shows the objects and properties of the PrimeInformation object:
| Name | Description |
|---|---|
| IsOfferNationalPrime | Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. Required. Type: boolean |
| IsOfferPrime | Indicates whether the offer is an Amazon Prime offer. Required. Type: boolean |
SalesRank
The following table shows the properties of the SalesRank object:
| Name | Description |
|---|---|
| ProductCategoryId | The product category identifier of the item. Required. Type: string |
| Rank | The sales rank of the item in the given product category. Required. Type: integer |
SellerFeedbackRating
The following table shows the objects and properties of the SellerFeedbackRating object:
| Name | Description |
|---|---|
| SellerPositiveFeedbackRating | The percentage of positive feedback for the seller in the past 365 days. Optional. Type: double |
| FeedbackCount | The count of feedback received about the seller. Required. Type: long |
ShippingTime
The following table shows the properties of the ShippingTime object:
| Name | Description |
|---|---|
| MinimumHours | The minimum time, in hours, that the item will likely be shipped after the order has been placed. Optional. Type: short |
| MaximumHours | The maximum time, in hours, that the item will likely be shipped after the order has been placed. Optional. Type: short |
| AvailableDate | The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. Optional. Type: string |
| AvailabilityType | Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate attribute indicates the date that the item will be available for shipping. Optional. Type: string |
ShipsFrom
The following table shows the objects and properties of the ShipsFrom object:
| Name | Description |
|---|---|
| State | The state from where the item is shipped. Optional. Type: string |
| Country | The country from where the item is shipped. Optional. Type: string |
| IsFulfilledByAmazon | Indicates whether the offer is fulfilled by Amazon. Required. Type: boolean |
Summary
The following table shows the objects and properties of the Summary object:
| Name | Description |
|---|---|
| NumberOfOffers | A list that contains the total number of offers for the item for the given conditions and fulfillment channels. Required. Type: Array of OfferCount |
| LowestPrices | A list that contains the lowest prices of the item for the given conditions and fulfillment channels. Required. Type: Array of LowestPrice |
| BuyBoxPrices | A list that contains the Buy Box price of the item for the given conditions. Optional. Type: Array of BuyBoxPrice |
| ListPrice | The list price of the item as suggested by the manufacturer. Optional. Type: MoneyType |
| SuggestedLowerPricePlusShipping | The suggested lower price of the item, including shipping (minus Amazon Points). The suggested lower price is based on a range of factors, including historical selling prices, recent Buy Box-eligible prices, and input from customers for your products. Optional. Type: MoneyType |
| SalesRankings | A list that contains the sales rank of the item in the given product categories. Optional. Type: Array of SalesRank |
| NumberOfBuyBoxEligibleOffers | A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels. Required. Type: Array of OfferCount |
| CompetitivePriceThreshold | This price is based on competitive prices from other retailers (excluding other Amazon sellers). Your offer may be ineligible for the Buy Box if your price + shipping is greater than this competitive price. Optional. Type: MoneyType |
Notification schema: AnyOfferChangedNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "ANY_OFFER_CHANGED",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "7d78cc50-95c8-4641-add7-10af4b1fedc9",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": " 2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"
},
"Payload":
{
"AnyOfferChangedNotification":
{
"SellerId": "merchantId",
"OfferChangeTrigger":
{
"MarketplaceId": "marketplaceId",
"ASIN": "ysp2k4cziG",
"ItemCondition": "Collectible",
"TimeOfOfferChange": "2020-01-11T00:02:50.501Z",
"OfferChangeType": ""
},
"Summary":
{
"NumberOfOffers": [
{
"Condition": "new",
"FulfillmentChannel": "Merchant",
"OfferCount": 28
}
],
"LowestPrices": [
{
"Condition": "new",
"FulfillmentChannel": "Merchant",
"LandedPrice":
{
"Amount": 28.59,
"CurrencyCode": "USD"
},
"ListingPrice":
{
"Amount": 28.59,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 0,
"CurrencyCode": "USD"
}
}
],
"BuyBoxPrices": [
{
"Condition": "new",
"LandedPrice":
{
"Amount": 14,
"CurrencyCode": "USD"
},
"ListingPrice":
{
"Amount": 12,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 2,
"CurrencyCode": "USD"
}
}
],
"ListPrice":
{
"Amount": 14,
"CurrencyCode": "USD"
},
"SalesRankings": [
{
"ProductCategoryId": "lawn_and_garden_display_on_website",
"Rank": 4013
},
{
"ProductCategoryId": "home_garden_display_on_website",
"Rank": 17316
}
],
"NumberOfBuyBoxEligibleOffers": [
{
"Condition": "new",
"FulfillmentChannel": "Merchant",
"OfferCount": 10
}
]
},
"Offers": [
{
"SellerId": "AQNACJEM8PUJ1",
"SubCondition": "new",
"SellerFeedbackRating":
{
"FeedbackCount": 78786,
"SellerPositiveFeedbackRating": 92
},
"ShippingTime":
{
"MinimumHours": 24,
"MaximumHours": 48,
"AvailabilityType": "",
"AvailableDate": ""
},
"ListingPrice":
{
"Amount": 28.59,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 0,
"CurrencyCode": "USD"
},
"ShipsFrom":
{
"Country": "",
"State": ""
},
"IsFulfilledByAmazon": false
},
{
"SellerId": "A28SS3BS1DBQ92",
"SubCondition": "new",
"SellerFeedbackRating":
{
"FeedbackCount": 6532,
"SellerPositiveFeedbackRating": 99
},
"ShippingTime":
{
"MinimumHours": 24,
"MaximumHours": 48,
"AvailabilityType": "",
"AvailableDate": ""
},
"ListingPrice":
{
"Amount": 28.69,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 0,
"CurrencyCode": "USD"
},
"ShipsFrom":
{
"Country": "",
"State": ""
},
"IsFulfilledByAmazon": false
}
]
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# B2B_ANY_OFFER_CHANGED
Sellers can subscribe to this notification.
The B2B_ANY_OFFER_CHANGED notification is sent whenever there is a change in any of the top 20 B2B offers, in the form of any price change (either single unit or quantity discount tier prices) for an item listed by the seller. The top 20 B2B offers are determined by the single-unit landed price, which is the price plus shipping. If multiple sellers are charging the same landed price, the results will be returned in random order.
You will only receive B2B_ANY_OFFER_CHANGED notifications for items for which the seller has active offers. You cannot subscribe to notifications for items for which the seller does not have active offers.
The following table shows the objects and properties of the b2b AnyOfferChangedNotification object:
| Name | Description |
|---|---|
| OfferChangeTrigger | The event that caused the notification to be sent. Required. Type: OfferChangeTrigger |
| Summary | Information about the product that had the offer change. The information in this summary applies to all conditions of the product. Required. Type: Summary |
| Offers | The top 20 competitive B2B offers for the item and condition that triggered the notification. Required. Type: Array of Offer |
| SellerId | The seller identifier for the offer. Required. Type: string |
# BuyBoxPrice
The following table shows the objects and properties of the BuyBoxPrice object.
| Name | Description |
|---|---|
| landedPrice | listingPrice + shipping. Optional. Type: MoneyType |
| listingPrice | The price of the item. Required. Type: MoneyType |
| shipping | The shipping cost. Optional. Type: MoneyType |
| offerType | Indicates whether the offer is a B2B offer or a B2C offer. When the offer type is B2C in a quantity discount, the seller is winning the Buy Box because others do not have inventory at that quantity, not because they have a quantity discount on the ASIN. Required. Type: string |
| quantityTier | The quantity tier for the offer. Required. Type: integer |
| discountType | Indicates whether the quantity tier is for Quantity Discount or Progressive Discount. Optional. Type: string |
| condition | Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. Required. Type: string |
| sellerId | The seller identifier for the offer. Optional. Type: string |
# LowestPrice
The following table shows the objects and properties of the LowestPrice type under Summary object:
| Name | Description |
|---|---|
| LandedPrice | ListingPrice + Shipping. Optional. Type: MoneyType |
| ListingPrice | The price of the item. Required. Type: MoneyType |
| Shipping | The shipping cost. Optional. Type: MoneyType |
| OfferType | Indicates whether the offer is a B2B offer or a B2C offer Required. Type: string |
| QuantityTier | The quantity tier for the offer Required. Type: integer |
| DiscountType | Indicates whether the quantity tier is for Quantity Discount or Progressive Discount. Optional. Type: string |
| Condition | Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. Required. Type: string |
| FulfillmentChannel | Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: FulfillmentChannelType |
# Offer
The following table shows the objects and properties of the Offer object:
| Name | Description |
|---|---|
| SellerId | The seller identifier for the offer. Required. Type: string |
| SubCondition | The subcondition of the item. For example: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. Required. Type: string |
| SellerFeedbackRating | Information about the seller's feedback, including the percentage of positive feedback, and the total count of feedback received. Optional. Type: SellerFeedbackRating |
| ShippingTime | The minimum and maximum time, in hours, that the item will likely be shipped after the order has been placed. Required. Type: ShippingTime |
| ListingPrice | The price of the item. Required. Type: MoneyType |
| Shipping | The shipping cost. Required. Type: MoneyType |
| ShipsFrom | The country from where the item is shipped. Optional. Type: ShipsFrom |
| IsFulfilledByAmazon | Indicates whether the offer is fulfilled by Amazon. Required. Type: boolean |
| IsBuyBoxWinner | Indicates whether the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. Optional. Type: boolean |
| ConditionNotes | Information about the condition of the item. Optional. Type: string |
| PrimeInformation | Amazon Prime information. Optional. Type: PrimeInformation |
| IsFeaturedMerchant | Indicates whether the seller of the item is eligible to win the Buy Box. Optional. Type: boolean |
# OfferChangeTrigger
The following table shows the properties of the OfferChangeTrigger object:
| Name | Description |
|---|---|
| MarketplaceId | The marketplace identifier of the item that had an offer change. Required. Type: string |
| ASIN | The ASIN for the item that had an offer change. Required. Type: string |
| ItemCondition | The condition of the item that had an offer change. For example, if a used offer changes, the array of offers in the Offers object will be only used items. The Summary object provides a summary for the other conditions that can be used for repricing. Required. Type: string |
| TimeOfOfferChange | The update time for the offer that caused this notification. Required. Type: string |
# OfferCount
The following table shows the objects and properties of the OfferCount type:
| Name | Description |
|---|---|
| Condition | Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. Required. Type: string |
| FulfillmentChannel | Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: FulfillmentChannelType |
| OfferCount | The total number of offers for the specified condition and fulfillment channel. Type: integer |
# PrimeInformation
The following table shows the properties of the PrimeInformation object:
| Name | Description |
|---|---|
| IsOfferNationalPrime | Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. Required. Type: boolean |
| IsOfferPrime | Indicates whether the offer is an Amazon Prime offer. Required. Type: boolean |
# SellerFeedbackRating
The following table shows the properties of the SellerFeedbackRating object:
| Name | Description |
|---|---|
| SellerPositiveFeedbackRating | The percentage of positive feedback for the seller in the past 365 days. Optional. Type: integer |
| FeedbackCount | The count of feedback received about the seller. Required. Type: integer |
# ShippingTime
The following table shows the properties of the ShippingTime object:
| Name | Description |
|---|---|
| MinimumHours | The minimum time, in hours, that the item will likely be shipped after the order has been placed. Optional. Type: integer |
| MaximumHours | The maximum time, in hours, that the item will likely be shipped after the order has been placed. Optional. Type: integer |
| AvailableDate | The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. Optional. Type: string |
| AvailabilityType | Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Optional. Type: string |
# ShipsFrom
The following table shows the properties of the ShipsFrom object:
| Name | Description |
|---|---|
| Country | The country from where the item is shipped. Optional. Type: string |
# Summary
The following table shows the objects and properties of the Summary object:
| Name | Description |
|---|---|
| NumberOfOffers | A list that contains the total number of B2B offers for the item for the given conditions and fulfillment channels. Required. Type: Array of OfferCount |
| LowestPrices | A list that contains the lowest prices of the item for the given conditions, fulfillment channels, quantity tiers, and discount types. The seven pre-defined quantity tiers for discount type “Quantity Discounts” are 2, 3, 5, 10, 20, 30 and 50. Required. Type: Array of LowestPrice |
| BuyBoxPrices | A list that contains the Buy Box price of the item for the given conditions, quantity tiers, and discount types. Up to the first 50 quantity tiers are shown. Optional. Type: Array of BuyBoxPrice |
| BuyBoxEligibleOffers | A list that contains the total number of B2B offers that are eligible for the Buy Box for the given conditions and fulfillment channels. Required. Type: Array of OfferCount |
Notification schema: B2bAnyOfferChangedNotification.json (opens new window)
Notification example:
{
"notificationVersion": "1.0",
"notificationType": "B2B_ANY_OFFER_CHANGED",
"payloadVersion": "1.0",
"eventTime": "2020-09-23T21:30:13.713Z",
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a",
"subscriptionId": "e3a059ca-677a-442a-8d39-05b2848971b6",
"publishTime": "2020-09-23T21:30:16.903Z",
"notificationId": "23ae41cd-3537-4676-af46-6ee9abf8802e"
},
"payload":
{
"b2bAnyOfferChangedNotification":
{
"sellerId": "A3EZFOFNDPFB8R",
"offerChangeTrigger":
{
"marketplaceId": "ATVPDKIKX0DER",
"asin": "B007IBIWZY",
"itemCondition": "new",
"timeOfOfferChange": "2020-09-23T21:30:13.409Z"
},
"summary":
{
"numberOfOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerCount": 3
}
],
"buyBoxEligibleOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerCount": 3
}
],
"lowestPrices": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerType": "B2B",
"quantityTier": 1,
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
}
},
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerType": "B2B",
"quantityTier": 20,
"listingPrice":
{
"amount": 7500,
"currencyCode": "USD"
}
},
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerType": "B2B",
"quantityTier": 30,
"discountType": "QUANTITY_DISCOUNT",
"listingPrice":
{
"amount": 6975,
"currencyCode": "USD"
}
}
],
"buyBoxPrices": [
{
"condition": "new",
"offerType": "B2B",
"quantityTier": 1,
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
}
},
{
"condition": "new",
"offerType": "B2B",
"quantityTier": 20,
"discountType": "QUANTITY_DISCOUNT",
"listingPrice":
{
"amount": 8000,
"currencyCode": "USD"
}
},
{
"condition": "new",
"offerType": "B2B",
"quantityTier": 30,
"discountType": "QUANTITY_DISCOUNT",
"listingPrice":
{
"amount": 7800,
"currencyCode": "USD"
}
}
]
},
"offers": [
{
"sellerId": "A2VUIDM8BZ902A",
"subCondition": "new",
"sellerFeedbackRating":
{
"feedbackCount": 1,
"sellerPositiveFeedbackRating": 0
},
"shippingTime":
{
"minimumHours": 24,
"maximumHours": 48,
"availabilityType": "available",
"availableDate": "2020-07-13T19:42:04.284Z"
},
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"shipsFrom":
{
"country": "US"
},
"isFulfilledByAmazon": false,
"isBuyBoxWinner": true,
"conditionNotes": "New in box",
"primeInformation":
{
"isPrime": true,
"isNationalPrime": true
},
"isFeaturedMerchant": true
}
]
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# BRANDED_ITEM_CONTENT_CHANGE
Sellers can subscribe to this notification.
Amazon sends a BRANDED_ITEM_CONTENT_CHANGE notification whenever there is a change to the title, description, bullet points, or images, for any ASIN that the selling partner has a brand relationship with. A selling partner has a brand relationship with an ASIN, as defined in the Amazon Registered Brands program, when they are a verified brand owner. The selling partner is the party who authorizes an application to call the Notifications API on their behalf, for the purpose of creating and managing notification subscriptions. Amazon sends BRANDED_ITEM_CONTENT_CHANGE notifications for items listed in any Amazon marketplace.
BRANDED_ITEM_CONTENT_CHANGE Payload schema: Version 1.0
A BRANDED_ITEM_CONTENT_CHANGE notification with PayloadVersion=1.0 includes the following properties in the Payload object.
| Name | Description | Required |
|---|---|---|
| MarketplaceId |
The marketplace that the item is listed in.
Type: string | Yes |
| BrandName |
The brand name of the item.
Type: string | Yes |
| Asin |
The ASIN of the item.
Type: string | Yes |
| AttributesChanged |
The array of item attributes that have changed. Attribute names, descriptions, and requirements are available by calling the Product Type Definitions API. For more information, see the Product Type Definitions API Use Case Guide.
Type: Array of string Possible values:bullet_point item_name product_description main_product_image_locator other_product_image_locator_1 other_product_image_locator_2 other_product_image_locator_3 other_product_image_locator_4 other_product_image_locator_5 other_product_image_locator_6 other_product_image_locator_7 other_product_image_locator_8 swatch_product_image_locator NOTE: The presence of one or more of the above values that contain the word image (for example, main_product_image_locator, other_product_image_locator_1, and so on) indicates that at least one image changed on the product detail page. The number of values that contain the word image does not necessarily match the number of images changed on the product detail page. | Yes |
Notification schema: BrandedItemContentChangeNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "BRANDED_ITEM_CONTENT_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2019-03-20T18:59:30.194Z",
"Payload":
{
"MarketplaceId": "ATVPDKIKX0DER",
"BrandName": "Great Brand",
"Asin": "B1234567",
"AttributesChanged": [
"bullet_point",
"item_name",
"product_description",
"main_product_image_locator",
"other_product_image_locator_1",
"other_product_image_locator_2",
"other_product_image_locator_3",
"other_product_image_locator_4",
"other_product_image_locator_5",
"other_product_image_locator_6",
"other_product_image_locator_7",
"other_product_image_locator_8",
"swatch_product_image_locator"
]
},
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime": "2019-03-20T18:59:48.768Z",
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# FBA_OUTBOUND_SHIPMENT_STATUS
Sellers can subscribe to this notification.
The FBA_OUTBOUND_SHIPMENT_STATUS notification is sent whenever Amazon creates or cancels a Fulfillment by Amazon shipment for a seller. This notification is only for FBA Onsite shipments. This notification is available only in the Brazil marketplace.
# FBAOutboundShipmentStatusNotification
The following table shows the objects and properties of the FBAOutboundShipmentStatusNotification object:
| Name | Description |
|---|---|
| SellerId | The seller identifier. Type: string |
| AmazonOrderId | The Amazon-defined order identifier. Type: string |
| AmazonShipmentId | The Amazon-defined shipment identifier. Type: string |
| ShipmentStatus | The shipment status. ShipmentStatus values: Created, Cancelled. Type: string |
Notification schema: FBAOutboundShipmentStatusNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "FBA_OUTBOUND_SHIPMENT_STATUS",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"Payload":
{
"FBAOutboundShipmentStatusNotification":
{
"SellerId": "merchantId",
"AmazonOrderId": "113-2646096-4474645",
"AmazonShipmentId": "DrLqQwqvb",
"ShipmentStatus": "Created"
}
},
"NotificationMetadata":
{
"ApplicationId": "appId",
"SubscriptionId": "subId",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": "requestId"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# FEE_PROMOTION
Sellers can subscribe to this notification.
Sellers using Selling Partner API can benefit from time-limited fee promotions. To receive notification of available fee promotions, sellers must subscribe to the FEE_PROMOTION notification. When the seller initially signs up for the subscription and isEnabled is set to true, the seller receives all currently active promotions. Each promotion is sent as a single message. Subsequent promotion notifications are sent when the promotion becomes active.
The FEE_PROMOTION notification is made up of a set of data fields describing the details of that promotion. All qualifying criteria for each promotion will be described in those data fields.
Note: The estimated fees returned by this API are not guaranteed. Actual fees may vary. For more information on fees, see Selling on Amazon Fee Schedule (opens new window) and FBA features and fees (opens new window) on Seller Central.
# FeeDetail
The following table shows the objects and properties of a FeeDetail object:
| Name | Description | Required | Value |
|---|---|---|---|
| FeeType | The type of fees charged. | Yes | Allowed Fee types: ReferralFee, VariableClosingFee, PerItemFee, FBAFees, FBAPickAndPack, FBAWeightHandling, FBAOrderHandling, FBADeliveryServicesFee. Type: string |
| FeeAmount | The fee amount corresponding to the fee type. | Yes | Type: MoneyType |
| FeePromotion | The fee promotion amount corresponding to the fee type. | No | Type: MoneyType |
| TaxAmount | The tax calculated over fee that would be charged to the seller. | No | Type: MoneyType |
| FinalFee | The final fee that would be charged to the seller. | Yes | The FeeAmount minus the FeePromotion. Type: MoneyType |
| IncludedFees | A structured list of FeeDetail that contains the itemization of a specific fee type. | No | Type: Array of FeeDetail |
# FeesEstimate
The following table shows the objects and properties of the FeesEstimate object:
| Name | Description | Required | Value |
|---|---|---|---|
| TimeOfFeesEstimated | The date time when the fees were estimated. | Yes | Type: string |
| TotalFeesEstimate | The total amount of fees if the price is lowered to or below the price threshold. | Yes | Type: MoneyType |
| FeeDetails | An itemization of the TotalFeesEstimate). | Yes | Type: Array of FeeDetail |
# FeePromotionNotification
Each FeePromotionNotification object is made up of the following data objects:
| Name | Description | Required | Value |
|---|---|---|---|
| FeePromotionType | The type of promotion. | Yes | Values: Pricing, SelectionASIN, or SelectionCategory. Additional types may become available in the future. Type: string |
| FeePromotionTypeDescription | Provides more details on the purpose of a promotion. | No | A friendly, localized string description. Useful for integrators to display on a UI. Type: string |
| MarketplaceId | The promotion applies to this marketplaceId. | Yes | Type: string |
| MerchantId | The promotion applies to this merchantId. | Yes | Type: string |
| Identifiers | A list of items to which this promotion applies. | Yes | Type: Array of Identifier |
| PromotionActiveTimeRange | The range of time when this promotion is active. | Yes | Type: PromotionActiveTimeRange |
| PromotionInformation | An object containing additional details about the promotion. A fee estimate is included if applicable. | Yes | Type: PromotionInformation |
# Identifier
The following table describes the objects and properties of an object from the Identifiers array:
| Name | Description | Required | Value |
|---|---|---|---|
| IdentifierType | The merchant identifier type for which this promotion will apply to. | Yes | For example: ASIN, SKU, Browse node, Brand. Type: string |
| IdentifierValues | The friendly name of the ID value. | Yes | For example: the merchant's actual ASINs or SKUs, an actual list of brands (like Nike), an actual list of browse nodes. Type: Array of IndentifierValue |
# IdentifierValue
A description of identifier values to which this promotion applies.
| Name | Description | Required | Value |
|---|---|---|---|
| IdentifierValueId | The actual browse node ID, actual ASIN/SKU, or brand value. | Yes | Type: string |
| IdentifierValueFriendlyName | The merchant identifier values to which this promotion will apply. | No |
Only relevant/populated for things like browse nodes. For example, this would be a browse node's friendly name.
Type: string |
# PromotionInformation
The following table shows the objects and properties of the PromotionInformation object:
| Name | Description | Required | Value |
|---|---|---|---|
| FeeType | The fee type which is being discounted in this promotion. | Yes | Allowed Fee types: ReferralFee, VariableClosingFee, PerItemFee, FBAFees, FBAPickAndPack, FBAWeightHandling, FBAOrderHandling, FBADeliveryServicesFee. Type: string |
| FeeDiscountType | The type of promotion you will be receiving for your fees. | Yes | Either Fixed, Discount, or Percentage points off. Type: string |
| PriceThreshold | The qualifying threshold offer price, or less, that must be met for the promotion to apply. | No | Type: MoneyType |
| FeeDiscountMonetaryAmount | The amount you will receive off of your fees if the FeeDiscountType involves a monetary amount. | No | If the FeeDiscountType involves a monetary amount, this value will be populated. Type: MoneyType |
| FeeDiscountValue | The percentage discount of your fees if the FeeDiscountType involves a non-monetary amount. | No | If the FeeDiscountType involves a non-monetary amount, this value will be populated. Type: number |
| FeesEstimate | The fee estimate for this promotion, if it is available. The estimate assumes that all condition required for the promotion have been met. | No | Type: FeesEstimate |
# PromotionActiveTimeRange
The following table shows the properties of the PromotionActiveTimeRange object:
| Name | Description | Required | Value |
|---|---|---|---|
| EffectiveFromDate | Date (inclusive) when the promotion becomes active. | Yes | Type: string |
| EffectiveThroughDate | Date (exclusive) when the promotion has ended. | Yes | Type: string |
Notification schema: FeePromotionNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "FEE_PROMOTION",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "7d78cc50-95c8-4641-add7-10af4b1fedc9",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": " 2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"
},
"Payload":
{
"FeePromotionNotification":
{
"MerchantId": "merchantId",
"MarketplaceId": "marketplaceId1",
"FeePromotionType": "Pricing",
"FeePromotionTypeDescription": "To help you offer a lower price to customers, we are offering you a temporary referral fee discount for every sale when the total sale price (price + shipping+ gift wrap) is at or below the pricing threshold.",
"PromotionActiveTimeRange":
{
"EffectiveFromDate": "2016-05-04T22:24:39.615Z",
"EffectiveThroughDate": "2016-04-28T02:45:12.786Z"
},
"Identifiers": [
{
"IdentifierType": "ASIN",
"IdentifierValues": [
{
"IdentifierValueId": "B0000000",
"IdentifierValueFriendlyName": "1234"
}
]
}
],
"PromotionInformations": [
{
"FeeType": "ReferralFee",
"FeeDiscountType": "Percentage points off",
"FeeDiscountValue": 5,
"PriceThreshold":
{
"Amount": 1,
"CurrencyCode": "USD"
},
"FeesEstimate":
{
"TimeOfFeesEstimated": "2016-05-05T22:24:39.635Z",
"TotalFeesEstimate":
{
"Amount": 10,
"CurrencyCode": "USD"
},
"FeeDetails": [
{
"FeeType": "feeType",
"FeeAmount":
{
"Amount": 1,
"CurrencyCode": "USD"
},
"FeePromotion":
{
"Amount": 0.8,
"CurrencyCode": "USD"
},
"FinalFee":
{
"Amount": 0.2,
"CurrencyCode": "USD"
}
}
]
}
}
]
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# FEED_PROCESSING_FINISHED
Sellers can subscribe to this notification.
The FEED_PROCESSING_FINISHED notification is sent whenever any feed submitted using the Selling Partner API for Feeds reaches a feed processing status of DONE, CANCELLED, or FATAL.
FEED_PROCESSING_FINISHED Payload schema: Version 1.0
A FEED_PROCESSING_FINISHED notification with PayloadVersion=2020-09-04 includes the following objects in the feedProcessingFinishedNotification object.
| Name | Description | Type | Required |
|---|---|---|---|
| sellerId | The selling partner identifier. | string | Yes |
| feedId | The identifier for the feed. | string | Yes |
| feedType | The feed type. For more information, see feedType values. | string | Yes |
| processingStatus | The processing status of the feed. | string | Yes |
| resultFeedDocumentId | The identifier for the feed document. This identifier is unique only in combination with a seller ID. | string | No |
Notification schema: FeedProcessingFinishedNotification.json (opens new window)
Notification example:
{
"notificationVersion": "2020-09-04",
"notificationType": "FEED_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-13T19:42:04.284Z",
"payload":
{
"feedProcessingFinishedNotification":
{
"sellerId": "A3TH9S8BH6GOGM",
"feedId": "53347018456",
"feedType": "POST_PRODUCT_DATA",
"processingStatus": "DONE",
"resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"
}
},
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746",
"subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2020-07-13T19:42:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# FULFILLMENT_ORDER_STATUS
Sellers can subscribe to this notification.
The FULFILLMENT_ORDER_STATUS notification is sent whenever there is a change in the status of a Multi-Channel Fulfillment fulfillment order.
# FulfillmentOrderStatusNotification
The following table shows the objects and properties of the FulfillmentOrderStatusNotification object:
| Name | Description |
|---|---|
| EventType | Indicates whether the notification contains order, shipment, or return information. EventType values: Order - This notification contains information about a fulfillment order. Shipment - This notification contains information about a fulfillment shipment. For more information, see the FulfillmentShipment object. Return - This notification contains information about a fulfillment return. Required Type: string |
| SellerId | The identifier of the seller. Type: string |
| StatusUpdatedDateTime | The date and time when the status was last updated. In ISO 8601 format. Required Type: string |
| SellerFulfillmentOrderId | The fulfillment order identifier that you created and submitted using the CreateFulfillmentOrder operation. Required Type: string |
| FulfillmentOrderStatus | The current status of the fulfillment order. FulfillmentOrderStatus values:
Required Type: string |
| FulfillmentShipment | Delivery and item information for a shipment in a fulfillment order. Optional. Returned only when EventType is Shipment. Type: FulfillmentShipment |
| FulfillmentReturnItem | Information about an item that was returned to an Amazon fulfillment center. Optional. Returned only when EventType is Return. Type: FulfillmentReturnItem |
# FulfillmentReturnItem
The following table shows the objects and properties of the FulfillmentReturnItem object:
| Name | Description |
|---|---|
| ReceivedDateTime | The date and time when the returned item was received by the Amazon fulfillment center. In ISO 8601 date time format. Required Type: string |
| ReturnedQuantity | The quantity that was returned. Required Type: integer |
| SellerSKU | The seller SKU of the item. Required Type: string |
# FulfillmentShipment
The following table shows the objects and properties of the FulfillmentShipment object:
| Name | Description |
|---|---|
| FulfillmentShipmentStatus | The current status of the shipment. FulfillmentShipmentStatus values:
Required Type: string |
| AmazonShipmentId | A shipment identifier assigned by Amazon. Required Type: string |
| EstimatedArrivalDateTime | The estimated arrival time of the shipment, in ISO 8601 date time format. Note that this value can change over time. If a shipment includes more than one package, EstimatedArrivalDateTime applies to all of the packages in the shipment. If the shipment has been cancelled, EstimatedArrivalDateTime is not returned. Required Type: string |
| FulfillmentShipmentPackages | Contains all the packages in the fulfillment shipment. Optional Type: Array of FulfillmentShipmentPackage |
# FulfillmentShipmentPackage
The following table shows the objects and properties of the FulfillmentShipmentPackage object:
| Name | Description |
|---|---|
| PackageNumber | Identifies a package within a shipment. Required Type: integer |
| CarrierCode | Identifies the carrier that will deliver the package. Required Type: string |
| TrackingNumber | The tracking number used to obtain tracking and delivery information. Required Type: string |
Notification schema: FulfillmentOrderStatusNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "FULFILLMENT_ORDER_STATUS",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"Payload":
{
"FulfillmentOrderStatusNotification":
{
"SellerId": "merchantId",
"EventType": "Shipment",
"StatusUpdatedDateTime": "2020-01-11T00:09:53.109Z",
"SellerFulfillmentOrderId": "OrderId",
"FulfillmentOrderStatus": "Complete",
"FulfillmentShipment":
{
"FulfillmentShipmentStatus": "Shipped",
"AmazonShipmentId": "DZRSmwG2N",
"EstimatedArrivalDateTime": "2014-12-19T22:59:59Z",
"FulfillmentShipmentPackages": [
{
"PackageNumber": 1,
"CarrierCode": "HERMESIT",
"TrackingNumber": "&0113838XXXXXX8300169397"
}
]
}
}
},
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "7d78cc50-95c8-4641-add7-10af4b1fedc9",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": " 2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# ITEM_PRODUCT_TYPE_CHANGE
Sellers can subscribe to this notification.
Amazon sends an ITEM_PRODUCT_TYPE_CHANGE notification whenever there is a change to the product type of any item that the selling partner has a brand relationship with. A selling partner has a brand relationship with an item, as defined in the Amazon Registered Brands program, when they are a verified brand owner. The selling partner is the party who authorizes an application to call the Notifications API on their behalf, for the purpose of creating and managing notification subscriptions. Amazon sends ITEM_PRODUCT_TYPE_CHANGE notifications for items listed in any Amazon marketplace.
ITEM_PRODUCT_TYPE_CHANGE Payload schema: Version 1.0
An ITEM_PRODUCT_TYPE_CHANGE notification with PayloadVersion=1.0 includes the following objects in the Payload object.
| Object | Description |
|---|---|
| MarketplaceId | The marketplace that the item is listed in. |
| Asin | The ASIN of the item. |
| PreviousProductType | The previous product type. |
| CurrentProductType | The current product type. |
Notification schema: ItemProductTypeChangeNotification.json (opens new window)
Notification example:
{
"NotificationVersion":"1.0",
"NotificationType":"ITEM_PRODUCT_TYPE_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2019-03-20T18:59:30.194Z",
"Payload":{
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "B1234567",
"PreviousProductType": "PET_HEALTH_CARE",
"CurrentProductType": "PET_APPAREL"
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2019-03-20T18:59:48.768Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# LISTINGS_ITEM_STATUS_CHANGE
Sellers can subscribe to this notification.
Amazon sends a LISTINGS_ITEM_STATUS_CHANGE notification when the status of a listings item changes for a selling partner. LISTINGS_ITEM_STATUS_CHANGE notifications are published when a listings item is created, deleted, or its buyability changes. The notification payload provides the current listings item information and status. Amazon sends LISTINGS_ITEM_STATUS_CHANGE notifications for items listed in any Amazon marketplace.
To retrieve additional associated details about the listing, such as listings item issues, call the Selling Partner API for Listings Items. For more information, see the Listings Items API Use Case Guide (opens new window).
The selling partner is the party who authorizes an application to call the Notifications API on their behalf for the purpose of creating and managing notification subscriptions.
LISTINGS_ITEM_STATUS_CHANGE Payload schema: Version 1.0
A LISTINGS_ITEM_STATUS_CHANGE notification with PayloadVersion=1.0 includes the following objects in the Payload object.
| Name | Description | Type | Required |
|---|---|---|---|
| SellerID | Selling partner identifier, such as a seller (merchant) account, of the affected listings item. | string | Yes |
| MarketplaceId | Amazon marketplace identifier of the affected listings item. | string | No |
| Asin | The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item. | string | No |
| Sku | Identifier of the affected listings item. | string | Yes |
| CreatedDate | Timestamp of when the listings item was created, formatted as ISO8601 date-time. | string | No |
| Status | List of status states currently associated with the affected listings item. The absence of a value indicates the status state is not currently applicable to the listings item. For example, if "BUYABLE" is not present, the listings item is not currently buyable. | Array of ListingsItemStatus | Yes |
# ListingsItemStatus
This table shows the possible values for ListingsItemStatus:
| Name | Description |
|---|---|
| BUYABLE | Indicates the listings item is available for purchase on the Amazon retail website for the corresponding Amazon marketplace. When provided, the listings item is buyable. When omitted, the listings item is non-buyable. |
| DISCOVERABLE | Indicates the associated Amazon catalog item (ASIN) is discoverable in search results on the Amazon retail website for the corresponding Amazon marketplace. When provided, the listings item is discoverable. When omitted, the listings item is non-discoverable. |
| DELETED | When provided, the listings item is deleted. When omitted, the listings item is non-deleted. |
Notification schema: ListingsItemStatusChangeNotification.json (opens new window)
Notification example:
{
"NotificationVersion":"1.0",
"NotificationType":"LISTINGS_ITEM_STATUS_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "BT6RZ7JM4H",
"Sku": "NLS-SHOES-03",
"CreatedDate": "2021-02-03T18:50:26.196Z",
"Status": [
"BUYABLE",
"DISCOVERABLE"
]
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# LISTINGS_ITEM_ISSUES_CHANGE
Sellers and vendors can subscribe to this notification.
Amazon sends a LISTINGS_ITEM_ISSUES_CHANGE notification whenever there is a change to the issues associated with a listings item that the selling partner owns. Issues point out that the listings item has problems which cause listing inactive, search suppression, or other quality problems. For example, if the selling partner's product image has low resolution, this issue will cause search suppression for this product. Amazon sends LISTINGS_ITEM_ISSUES_CHANGE notifications for items listed in any Amazon marketplace.
LISTINGS_ITEM_ISSUES_CHANGE notifications are triggered when an issue on a listing is either created, fixed, or updated. The notification payload includes basic listing information, related issue severity, and enforcement actions caused by issues. To retrieve more details about issues associated with a listing, call the Selling Partner API for Listings Items. For more information, see the Listings Items API Use Case Guide (opens new window).
All problems that can occur with a listing do not have corresponding defined issues. As a result, this notification does not necessarily represent all problems with a listing (neither does the Selling Partner API for Listings Items). Amazon is working to define more issues to more closely represent the listings problems that can occur.
The selling partner is the party who authorizes an application to call the Notifications API on their behalf for the purpose of creating and managing notification subscriptions.
LISTINGS_ITEM_ISSUES_CHANGE Payload schema: Version 1.0
A LISTINGS_ITEM_ISSUES_CHANGE notification with PayloadVersion=1.0 includes the following objects in the Payload object.
| Name | Description | Type | Required |
|---|---|---|---|
| SellerId | Selling partner identifier, such as a seller (merchant) account or vendor code, of the affected listings item. | string | Yes |
| MarketplaceId | Amazon marketplace identifier of the affected listings item. | string | No |
| Asin | The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item. | string | No |
| Sku | Identifier of the affected listings item. | string | Yes |
| Severities | List of severities for the issues associated with the affected listings item. When no issues are affecting the listings item, "NONE" is provided instead. | Array of IssueSeverity | Yes |
| EnforcementActions | List of enforcement actions taken by Amazon for the issues associated with the affected listings item. | Array of IssueEnforcementActions | No |
# IssueSeverity
This table shows the possible values for IssueSeverity:
| Name | Description |
|---|---|
| ERROR | When provided, at least one issue with "ERROR" severity is affecting the listings item. |
| WARNING | When provided, at least one issue with "WARNING" severity is affecting the listings item. |
| NONE | When provided, there are no defined issues affecting the listings item. However, there may be other problems with the listing. |
# IssueEnforcementActions
This table shows the possible values for IssueEnforcementActions:
| Name | Description |
|---|---|
| SEARCH_SUPPRESSED | When provided, the listing item is suppressed from search results caused by at least one issue currently associated with the affected listing item. |
Notification schema: ListingsItemIssuesChangeNotification.json (opens new window)
Notification example:
{
"NotificationVersion":"1.0",
"NotificationType":"LISTINGS_ITEM_ISSUES_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "BT6RZ7JM4H",
"Sku": "NLS-SHOES-03",
"Severities": [
"ERROR",
"WARNING"
],
"EnforcementActions": [
"SEARCH_SUPPRESSED"
]
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# MFN_ORDER_STATUS_CHANGE
Sellers can subscribe to this notification.
The MFN_ORDER_STATUS_CHANGE notification is sent whenever there is a change in the status of a MFN order availability.
MFN_ORDER_STATUS_CHANGE Payload schema: Version 1.0
A MFN_ORDER_STATUS_CHANGE notification with PayloadVersion=1.0 includes the following properties in the MFNOrderNotification object.
| Name | Description | Type | Required |
|---|---|---|---|
| SellerId | The selling partner identifier. | string | Yes |
| MarketplaceId | The marketplace identifier. | string | Yes |
| AmazonOrderId | An Amazon-defined order identifier in 3-7-7 format. | string | Yes |
| PurchaseDate | The purchase date of the order in Epoch time. | integer or null | Yes |
| OrderStatus | The current order status. | string | Yes |
| DestinationPostalCode | The destination postal code. Note: This postal code is temporarily unavailable and will appear in the notification as a null value. | string or null | Yes |
| SupplySourceId | The unique identifier of the supply source. | string or null | Yes |
| OrderItemId | The Amazon-defined order item identifier. | string | Yes |
| SellerSKU | The seller-specific SKU identifier for an item. | string | Yes |
| Quantity | The number of items in the order. | string | Yes |
Notification schema: MfnOrderStatusChangeNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "MFN_ORDER_STATUS_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2020-07-13T19:42:04.284Z",
"Payload":
{
"MFNOrderStatusChangeNotification":
{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"AmazonOrderId": "333-7777777-7777777",
"PurchaseDate": 1595882000633,
"OrderStatus": "SHIPPING",
"DestinationPostalCode": "48110",
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
"OrderItemId": "OIID34853450",
"SellerSKU": "SellerSKUID1",
"Quantity": 45
}
},
"NotificationMetadata":
{
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"PublishTime": "2020-07-13T19:42:04.284Z",
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# ORDER_STATUS_CHANGE
Sellers can subscribe to this notification.
The ORDER_STATUS_CHANGE notification is sent whenever there is a change in the status of order availability.
ORDER_STATUS_CHANGE Payload schema: Version 1.0
The ORDER_STATUS_CHANGE notification with PayloadVersion=1.0 includes the following properties in the OrderNotification object.
| Name | Description | Type | Required |
|---|---|---|---|
| SellerId | The selling partner identifier. | string | Yes |
| MarketplaceId | The Amazon marketplace identifier of the affected order. | string | Yes |
| AmazonOrderId | An Amazon-defined order identifier in 3-7-7 format. | string | Yes |
| PurchaseDate | The purchase date of the order in Epoch time. | integer or null | Yes |
| OrderStatus | The current order status. The possible values include UpComing, Pending, Unshipped, PartiallyShipped, PendingAvailability, Canceled, InvoiceUnconfirmed, Shipped, and Unfulfillable. | string | Yes |
| DestinationPostalCode | The destination postal code. Note: This postal code is temporarily unavailable and will appear in the notification as a null value. | string or null | Yes |
| SupplySourceId | The unique identifier of the supply source. | string or null | Yes |
| OrderItemId | The Amazon-defined order item identifier. | string | Yes |
| SellerSKU | The seller-specific SKU identifier for an item. | string | Yes |
| Quantity | The number of items in the order. | string | Yes |
| FulfillmentChannel | The fulfillment channel of the affected order. Possible values: MFN or AFN. | string | Yes |
Notification schema: OrderStatusChangeNotification.json (opens new window)
Notification example:
{
"NotificationVersion": "1.0",
"NotificationType": "ORDER_STATUS_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2020-07-13T19:42:04.284Z",
"Payload":
{
"OrderStatusChangeNotification":
{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"AmazonOrderId": "333-7777777-7777777",
"PurchaseDate": 1595882000633,
"OrderStatus": "Unshipped",
"DestinationPostalCode": "48110",
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
"OrderItemId": "OIID34853450",
"SellerSKU": "SellerSKUID1",
"Quantity": 45,
"FulfillmentChannel": "MFN"
}
},
"NotificationMetadata":
{
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"PublishTime": "2020-07-13T19:42:04.284Z",
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# PRICING_HEALTH
Sellers can subscribe to this notification.
The PRICING_HEALTH notification is sent whenever a seller offer is ineligible to be the Featured Offer (Buy Box offer) because of an uncompetitive price. Sellers can take steps to restore featured offer eligibility by adjusting an offer's total price (price plus shipping minus points) so that it matches or is lower than the competitive price, or is in line with the reference prices provided. These include the Featured Offer price, 60-day average selling price, highest 14-day price (shipped and sold by Amazon), and the list price. To be Featured Offer eligible, you must price competitively and meet other qualifying criteria designed to give customers a great shopping experience, including great prices, availability, and delivery speed. The Featured Offer is the offer selected when the customer chooses Add to Cart on the product detail page.
The PRICING_HEALTH notification with payloadVersion=1.0 includes the following properties in the payload object.
| Name | Description |
|---|---|
| issueType | The issue type for the notification.
Required. Type: string |
| sellerId | The seller identifier for the offer.
Required. Type: string |
| offerChangeTrigger | The event that caused the notification to be sent.
Required. Type: offerChangeTrigger |
| merchantOffer | Offer details of the merchant receiving the notification.
Required. Type: merchantOffer |
| summary | Information about the item that had the offer change. The information in this summary applies to all conditions of the product.
Required. Type: summary |
buyBoxPrice
The following table shows the objects and properties of the buyBoxPrice object:
| Name | Description |
|---|---|
| condition | Indicates the condition of the item. Required. Type: string |
| landedPrice | The listingPrice plus shipping. Required. Type: moneyType |
| listingPrice | The price of the item. Required. Type: moneyType |
| shipping | The shipping cost. Required. Type: moneyType |
| points | The number of Amazon Points offered with the purchase of an item. Optional. Type: points |
merchantOffer
The following table shows the objects and properties of the merchantOffer object:
| Name | Description |
|---|---|
| condition |
Indicates the condition of the item.
Required. Type: string |
| fulfillmentType |
Indicates whether the item is fulfilled by Amazon or by the seller.
Required. Type: string |
| landedPrice |
The listingPrice plus shipping.
Required. Type: moneyType |
| listingPrice |
The price of the item.
Required. Type: moneyType |
| shipping |
The shipping cost.
Required. Type: string |
| points |
The number of Amazon Points offered with the purchase of an item.
Optional. Note: The Points object is only returned in Japan (JP). Type: points |
offerChangeTrigger
The following table shows the objects and properties of the offerChangeTrigger object:
| Name | Description |
|---|---|
| marketplaceId |
The marketplace identifier of the item that had an offer change.
Required. Type: string |
| asin |
The ASIN for the item that had an offer change.
Required. Type: string |
| itemCondition |
The condition of the item that had an offer change.
Required. Type: string |
| timeOfOfferChange |
The update time for the offer that caused this notification.
Optional. Type: string |
offerCount
The following table shows the objects and properties of the offerCount object:
| Name | Description |
|---|---|
| condition | Indicates the condition of the item. Required. Type: string |
| fulfillmentType | Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: string |
| offerCount | "The total number of offers for the specified condition and fulfillment channel. Required. Type: integer |
points
The following table shows the objects and properties of the points object:
| Name | Description |
|---|---|
| pointsNumber | The number of Amazon Points offered with the purchase of an item. Required. Type: integer |
referencePrice
The following table shows the objects and properties of the referencePrice object:
| Name | Description |
|---|---|
| averageSellingPrice | The average selling price of the item. Optional. Type: moneyType |
| competitivePriceThreshold | The competitive price threshold from external competitors of Amazon. Optional. Type: moneyType |
| retailOfferPrice | The 14 day maximum of retail offer price. Optional. Type: moneyType |
| msrpPrice | The manufacturer suggested retail price for the ASIN. Optional. Type: moneyType |
salesRank
The following table shows the objects and properties of the salesRank object:
| Name | Description |
|---|---|
| productCategoryId | The product category for the rank. Required. Type: string |
| rank | The sales rank of the ASIN. Required. Type: integer |
summary
The following table shows the objects and properties of the summary object:
| Name | Description |
|---|---|
| numberOfOffers | A list that contains the total number of offers for the item for the given conditions and fulfillment channels. Required. Type: array of offerCount |
| buyBoxEligibleOffers | A list that contains the total number of offers that are eligible for the buy box for the given conditions and fulfillment channels. Required. Type: array of offerCount |
| buyBoxPrices | A list that contains the buy box price of the item for the given conditions. Optional. Type: array of buyBoxPrice |
| salesRankings | A list that contains the sales rankings of the ASIN in various product categories. Optional. Type: array of salesRank |
| referencePrice | A set of reference prices for the given ASIN. Required. Type: referencePrice |
Notification schema: PricingHealthNotification.json (opens new window)
Notification example:
{
"notificationVersion": "1.0",
"notificationType": "PRICING_HEALTH",
"payloadVersion": "1.0",
"eventTime": "2020-09-23T21:30:13.713Z",
"payload":
{
"issueType": "BuyBoxDisqualification",
"sellerId": "A3EZFOFNDPFB8R",
"offerChangeTrigger":
{
"marketplaceId": "ATVPDKIKX0DER",
"asin": "B007IBIWZY",
"itemCondition": "new",
"timeOfOfferChange": "2020-09-23T21:30:13.409Z"
},
"merchantOffer":
{
"condition": "new",
"fulfillmentType": "MFN",
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
},
"points":
{
"pointsNumber": 34343
}
},
"summary":
{
"numberOfOffers": [
{
"condition": "new",
"fulfillmentType": "MFN",
"offerCount": 3
}
],
"buyBoxEligibleOffers": [
{
"condition": "new",
"fulfillmentType": "MFN",
"offerCount": 3
}
],
"buyBoxPrices": [
{
"condition": "new",
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
},
"points":
{
"pointsNumber": 34343
}
}
],
"salesRankings": [
{
"productCategoryId": "lawn_and_garden_display_on_website",
"rank": 4013
},
{
"productCategoryId": "home_garden_display_on_website",
"rank": 17316
}
],
"referencePrice":
{
"averageSellingPrice":
{
"amount": 7500,
"currencyCode": "USD"
},
"competitivePriceThreshold":
{
"amount": 8000,
"currencyCode": "USD"
},
"msrpPrice":
{
"amount": 7900,
"currencyCode": "USD"
},
"retailOfferPrice":
{
"amount": 8000,
"currencyCode": "USD"
}
}
}
},
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a",
"subscriptionId": "e3a059ca-677a-442a-8d39-05b2848971b6",
"publishTime": "2020-09-23T21:30:16.903Z",
"notificationId": "23ae41cd-3537-4676-af46-6ee9abf8802e"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# PRODUCT_TYPE_DEFINITIONS_CHANGE
Sellers and vendors can subscribe to this notification.
The PRODUCT_TYPE_DEFINITIONS_CHANGE notification is sent whenever there is a new Product Type or Product Type Version.
If the notification is triggered by the addition of one or more new product types in a marketplace, the notification payload provides the names of the new product types and the product type version applicable to those product types.
If the notification is triggered only by a new product type version, the notification payload provides the new product type version.
For more information about product types, see the Product Type Definitions API Use Case Guide (opens new window).
PRODUCT_TYPE_DEFINITIONS_CHANGE Payload schema: Version 1.0
A PRODUCT_TYPE_DEFINITIONS_CHANGE notification with PayloadVersion=1.0 includes the following properties in the Payload object.
| Name | Description | Type | Required |
|---|---|---|---|
| AccountId | The selling partner identifier, such as a seller (merchant) account or vendor group ID. | string | Yes |
| MarketplaceId | Amazon marketplace identifier of the affected product type or product type version. | string | No |
| ProductTypeVersion | Version of the released Amazon product type definition. | string | Yes |
| NewProductTypes | List of product types launched in a marketplace. | Array of string | No |
Notification schema: ProductTypeDefinitionsChangeNotification.json (opens new window)
Notification example:
Example 1: Notification with new product types
{
"NotificationVersion":"1.0",
"NotificationType":"PRODUCT_TYPE_DEFINITIONS_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"AccountId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr",
"NewProductTypes":[
"LUGGAGE",
"SHOES",
]
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Example 2: Notification with a product type version change
{
"NotificationVersion":"1.0",
"NotificationType":"PRODUCT_TYPE_DEFINITIONS_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"AccountId": "AXXXXXXXXXXXXX",
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# REPORT_PROCESSING_FINISHED
Sellers can subscribe to this notification.
The REPORT_PROCESSING_FINISHED notification is sent whenever any report that you have requested using the the Selling Partner API for Reports reaches a report processing status of DONE, CANCELLED, or FATAL.
REPORT_PROCESSING_FINISHED Payload schema: Version 1.0
The REPORT_PROCESSING_FINISHED notification with PayloadVersion=2020-09-04 includes the following objects in the reportProcessingFinishedNotification object.
| Name | Description | Type | Required |
|---|---|---|---|
| sellerId | The selling partner identifier. | string | Yes |
| reportId | The identifier of the report. | string | Yes |
| reportType | The report type. For more information, see reportType values. | string | Yes |
| processingStatus | The processing status of the report. | string | Yes |
| reportDocumentId | The identifier for the report document. This identifier is unique only in combination with a seller ID. | string | No |
Notification schema: ReportProcessingFinishedNotification.json (opens new window)
Notification example:
{
"notificationVersion": "2020-09-04",
"notificationType": "REPORT_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-14T03:35:13.214Z",
"payload":
{
"reportProcessingFinishedNotification":
{
"sellerId": "AXXXXXXXXXXXXX",
"reportId": "54517018502",
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
"processingStatus": "CANCELLED",
"reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"
}
},
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
"subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2020-07-13T19:42:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Common types
Contains common types that are used by all notifications that are contained in the Notification payload objects.
# FulfillmentChannelType
Indicates whether the item is fulfilled by Amazon or by the seller.
Type: string
FulfillmentChannelType values:
Amazon
Merchant
# moneyType
Currency type and amount.
The following table shows the properties of the MoneyType object:
| Name | Description |
|---|---|
| amount | The currency amount. Type: number |
| currencyCode | Three-digit currency code. In ISO 4217 format. Type: string |
# MoneyType
Currency type and amount.
The following table shows the properties of the MoneyType object:
| Name | Description |
|---|---|
| Amount | The currency amount. Type: number |
| CurrencyCode | Three-digit currency code. In ISO 4217 format. Type: string |