Notification Type Values
Subscribe to selling partner notifications.
You can use notification type values to subscribe to Selling Partner API notifications. Determine which notifications you want to receive to choose notification type values.
The following notificationType
and payloadVersion
values indicate the notification type with supported payload version:
ACCOUNT_STATUS_CHANGED
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 selling partner/marketplace pairs. A notification is published whenever the selling partner's account status changes between NORMAL
, AT_RISK
, and DEACTIVATED
.
Payload schema: Version 2021-01-01
Workflow: Amazon Simple Queue Service workflow
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: |
currentAccountStatus |
The seller's new account status.
Required. Type: string Possible values: |
Notification schema: AccountStatusChangedNotification.json
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"
}
}
ANY_OFFER_CHANGED
ANY_OFFER_CHANGED
Sellers can subscribe to this notification.
This notification supports the following eventFilter
values: aggregationSettings
, marketplaceIds
. To use these filters, you must also provide the following
eventFilterType
: "eventFilterType": "ANY_OFFER_CHANGED"
.
Refer to 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.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
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: |
Summary |
Information about the product that had the offer change. The information in this summary applies to all conditions of the product.
Required. Type: |
Offers |
The top 20 competitive offers for the item and condition that triggered the notification.
Required. Type: Array of |
BuyBoxPrice
BuyBoxPrice
The following table shows the objects and properties of the BuyBoxPrice
object:
Name | Description |
---|---|
LandedPrice |
ListingPrice + Shipping - Points .
Required. Type: |
ListingPrice |
The price of the item.
Required. Type: |
Shipping |
The shipping cost.
Required. Type: |
Points |
The number of Amazon Points offered with the purchase of an item.
Optional. Note: The Type: |
Condition |
Indicates the condition of the item. For example: New , Used , Collectible , Refurbished , or Club .
Required. Type: String |
LowestPrice
LowestPrice
The following table shows the objects and properties of the LowestPrice
object:
Name | Description |
---|---|
LandedPrice |
Required. Type: |
ListingPrice |
The price of the item. Required. Type: |
Shipping |
The shipping cost. Required. Type: |
Points |
The number of Amazon Points offered with the purchase of an item. Optional. Note: The Type: |
Condition |
Indicates the condition of the item. For example: Required. Type: String |
FulfillmentChannel |
Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: |
Offer
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: 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: |
ShippingTime |
The minimum and maximum time, in hours, that the item will likely be shipped after the order has been placed. Required. Type: |
ListingPrice |
The price of the item. Required. Type: |
Points |
The number of Amazon Points offered with the purchase of an item. Optional. Note: The Type: |
Shipping |
The shipping cost. Required. Type: |
ShipsFrom |
The state and country from where the item is shipped. Optional. Type: |
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: |
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
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 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.
Required. Type: string |
OfferCount
OfferCount
The following table shows the objects and properties of the OfferCount
object:
Name | Description |
---|---|
Condition |
Indicates the condition of the item. For example: Required. Type: string |
FulfillmentChannel |
Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: |
OfferCount |
The total number of offers for the specified condition and fulfillment channel. Required. Type: integer |
Points
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
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
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
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
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 Optional. Type: string |
ShipsFrom
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
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 |
LowestPrices |
A list that contains the lowest prices of the item for the given conditions and fulfillment channels. Required. Type: Array of |
BuyBoxPrices |
A list that contains the Buy Box price of the item for the given conditions. Optional. Type: Array of |
ListPrice |
The list price of the item as suggested by the manufacturer. Optional. Type: |
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: |
SalesRankings |
A list that contains the sales rank of the item in the given product categories. Optional. Type: Array of |
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 |
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 Optional. Type: |
Notification schema: AnyOfferChangedNotification.json
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
}
]
}
}
}
B2B_ANY_OFFER_CHANGED
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 for Amazon Business, in the form of any price change (for single-unit and seven pre-defined quantity discount tiers: 2, 3, 5, 10, 20, 30, and 50) 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.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
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: |
Summary |
Information about the product that had the offer change. The information in this summary applies to all conditions of the product. Required. Type: |
Offers |
The top 20 competitive B2B offers for the item and condition that triggered the notification. Required. Type: Array of |
SellerId |
The seller identifier for the offer. Required. Type: string |
BuyBoxPrice
BuyBoxPrice
The following table shows the objects and properties of the BuyBoxPrice
object.
Name | Description |
---|---|
landedPrice |
Optional. Type: |
listingPrice |
The price of the item. Required. Type: |
shipping |
The shipping cost. Optional. Type: |
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: Required. Type: string |
sellerId |
The seller identifier for the offer. Optional. Type: string |
LowestPrice
LowestPrice
The following table shows the objects and properties of the LowestPrice
type under Summary
object:
Name | Description |
---|---|
LandedPrice |
Optional. Type: |
ListingPrice |
The price of the item. Required. Type: |
Shipping |
The shipping cost. Optional. Type: |
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: Required. Type: string |
FulfillmentChannel |
Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: |
Offer
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: 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: |
ShippingTime |
The minimum and maximum time, in hours, that the item will likely be shipped after the order has been placed. Required. Type: |
ListingPrice |
The price of the item. Required. Type: |
Shipping |
The shipping cost. Required. Type: |
ShipsFrom |
The country from where the item is shipped. Optional. Type: |
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: |
IsFeaturedMerchant |
Indicates whether the seller of the item is eligible to win the Buy Box. Optional. Type: boolean |
OfferChangeTrigger
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 Required. Type: string |
TimeOfOfferChange |
The update time for the offer that caused this notification. Required. Type: string |
OfferCount
OfferCount
The following table shows the objects and properties of the OfferCount
type:
Name | Description |
---|---|
Condition |
Indicates the condition of the item. For example: Required. Type: string |
FulfillmentChannel |
Indicates whether the item is fulfilled by Amazon or by the seller. Required. Type: |
OfferCount |
The total number of offers for the specified condition and fulfillment channel. Type: integer |
PrimeInformation
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
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
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 Optional. Type: string |
ShipsFrom
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
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 |
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 |
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 |
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 |
Notification schema: B2bAnyOfferChangedNotification.json
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
}
]
}
}
}
BRANDED_ITEM_CONTENT_CHANGE
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.
Payload schema: Version 1.0
Workflow: Amazon EventBridge workflow
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, refer to the Product Type Definitions API Use Case Guide.
Type: Array of string Possible values:bullet_point item_name product_description ...and all product image attributes ( main_product_image_locator , other_product_image_locator_1 , etc.). Refer to the images property group of this JSON response example in the Product Type Definitions API Use Case Guide for the complete list of image attributes.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
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"
}
}
DETAIL_PAGE_TRAFFIC_EVENT
DETAIL_PAGE_TRAFFIC_EVENT
Sellers and vendors can subscribe to this notification.
The DETAIL_PAGE_TRAFFIC_EVENT
notification is sent five minutes after the beginning of each hour. This notification shares traffic data at an ASIN level and includes data for the hour before the previous hour, as well as any delayed data from up to 24 hours earlier. ASINs that have glance views are included. Each notification may include multiple ASINs, and a selling partner can expect to receive multiple notifications every hour.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
DetailPageTrafficEventNotifications
DetailPageTrafficEventNotifications
The following table shows the objects and properties of the DetailPageTrafficEventNotifications
object:
Name | Description | Required | Type |
---|---|---|---|
detailPageTrafficEventNotifications | A list of hourly grain traffic metrics by ASIN. | Yes | Array of DetailPageTrafficEventNotification |
DetailPageTrafficEventNotification
DetailPageTrafficEventNotification
Name | Description | Required | Type |
---|---|---|---|
accountId | The merchant customer ID or vendor group ID of the partner account this notification is sent to. | Yes | String |
marketplaceId | The marketplace identifier of the traffic data. | Yes | String |
startTime | The start of the date-time range of the traffic data ISO 8601 format in UTC time. | Yes | String |
endTime | The end of the date-time range of the traffic data in ISO 8601 format in UTC time. | Yes | String |
asin | The Amazon Standard Identification Number of the product. | Yes | String |
glanceViews | The number of customer views of the product detail page for this ASIN. | Yes | Integer |
Notification Schema: DetailPageTrafficEventNotification
Notification Example
{
"notificationVersion": "2020-09-04",
"notificationType": "DETAIL_PAGE_TRAFFIC_EVENT",
"payloadVersion": "2020-09-04",
"eventTime": "2023-02-07T16:05:32.378Z",
"payload": {
"detailPageTrafficEventNotifications": [
{
"accountId": "amzn1.merchant.o.A21CXK3C4ERTY8",
"marketplaceId": "ATVPDKIKX0DER",
"startTime": "2023-02-07T15:00:00Z",
"endTime": "2023-02-07T16:00:00Z",
"asin": "B00032HE0O",
"glanceViews": 42
}, {
"accountId": "amzn1.merchant.o.A21CXK3C4ERTY8",
"marketplaceId": "ATVPDKIKX0DER",
"startTime": "2023-02-07T15:00:00Z",
"endTime": "2023-02-07T16:00:00Z",
"asin": "B00094A20U",
"glanceViews": 69
}
]
},
"notificationMetadata": {
"applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
"subscriptionId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2023-02-07T16:45:32.378Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
FBA_INVENTORY_AVAILABILITY_CHANGES
FBA_INVENTORY_AVAILABILITY_CHANGES
Sellers can subscribe to this notification.
The FBA_INVENTORY_AVAILABILITY_CHANGES
notification is sent whenever there is a change in the Fulfillment By Amazon (FBA) inventory quantities. This notification includes a snapshot of the FBA inventory in all eligible marketplaces in a particular region.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
FBAInventoryAvailabilityChangeNotification
FBAInventoryAvailabilityChangeNotification
The following table shows the objects and properties of the FBAInventoryAvailabilityChangeNotification
object:
Name | Description |
---|---|
SellerId |
The seller identifier. Type: string |
FNSKU |
The Fulfillment Network SKU of the affected inventory item. Type: string |
ASIN |
The Amazon Standard Identification Number of the affected inventory item. Type: string |
SKU |
The seller SKU of the affected inventory item. Type: string |
FulfillmentInventoryByMarketplace |
A list of fulfillment inventory details for each marketplace. Type: Array of |
FulfillmentInventoryDetails
FulfillmentInventoryDetails
The following table describes the objects and properties of a FulfillmentInventoryDetails
object:
Name | Description |
---|---|
MarketplaceId |
The marketplace identifier for the destination where the affected inventory can be used to fulfill the order. Type: string |
ItemName |
The product title of the affected inventory item. Type: string |
FulfillmentInventory |
Detail of the affected item's inventory availability. Type: |
FulfillmentInventory
FulfillmentInventory
The following table describes the objects and properties of a FulfillmentInventory
object:
Name | Description |
---|---|
InboundQuantityBreakdown |
Details of the affected item's inbound units, which are either still in Type: |
Fulfillable |
The number of units of the affected item that can be used to fulfill orders in the given marketplace. Type: int |
Unfulfillable |
The number of units of the affected item that can not be used to fulfill orders due to the item's current condition. Type: int |
Researching |
Number of units of the affected item currently being investigated upon adjustments. Type: int |
ReservedQuantityBreakdown |
Details of the inventory that is temporarily undergoing internal processes. |
FutureSupplyBuyable |
The number of units available for customers to find and buy while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start. Type: int |
PendingCustomerOrderInTransit |
The number of units that customers have purchased while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start. Type: int |
InboundQuantityBreakdown
InboundQuantityBreakdown
The following table describes the objects and properties of a InboundQuantityBreakdown
object:
Name | Description |
---|---|
Working |
The number of units of the affected item that currently reside in a Type: int |
Shipped |
The number of units of the affected item that currently reside in a Type: int |
Receiving |
Number of units of the affected item that arrived and are in progress to be received in Amazon warehouses. Type: int |
ReservedQuantityBreakdown
ReservedQuantityBreakdown
The following table describes the objects and properties of a ReservedQuantityBreakdown
object:
Name | Description |
---|---|
WarehouseProcessing |
The number of units of the affected item temporarily sidelined for internal processing. Type: int |
WarehouseTransfer |
The number of units of the affected item in progress to be trans-shipped to another Amazon Warehouse location. Type: int |
PendingCustomerOrder |
The number of units of the affected item that will soon be shipped out as a customer order shipment. Type: int |
Notification schema: FBAInventoryAvailabilityChangeNotification.json
Notification example
{
"NotificationVersion": "1.0",
"NotificationType": "FBA_INVENTORY_AVAILABILITY_CHANGES",
"PayloadVersion": "1.0",
"EventTime": "2020-07-13T19:42:04.284Z",
"Payload": {
"SellerId": "A3TH9S8BH6GOGM",
"FNSKU": "X001ABCDEF",
"ASIN": "B00001ABCD",
"SKU": "SELLERSKU-1",
"FulfillmentInventoryByMarketplace":[
{
"MarketplaceId": "ATVPDKIKX0DER",
"ItemName": "Product Title",
"FulfillmentInventory": {
"InboundQuantityBreakdown":{
"Working": 0,
"Shipped": 5,
"Receiving": 10
},
"Fulfillable": 50,
"Unfulfillable":0,
"Researching": 0,
"ReservedQuantityBreakdown": {
"WarehouseProcessing": 5,
"WarehouseTransfer": 15,
"PendingCustomerOrder": 10
},
"FutureSupplyBuyable":10,
"PendingCustomerOrderInTransit":0
}
},
{
"MarketplaceId": "A2EUQ1WTGCTBG2",
"ItemName": "Product Title",
"FulfillmentInventory": {
"InboundQuantityBreakdown":{
"Working": 1,
"Shipped": 2,
"Receiving": 3
},
"Fulfillable": 40,
"Unfulfillable":0,
"Researching": 0,
"ReservedQuantityBreakdown": {
"WarehouseProcessing": 5,
"WarehouseTransfer": 15,
"PendingCustomerOrder": 10
},
"FutureSupplyBuyable":0,
"PendingCustomerOrderInTransit":0
}
}
]
},
"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"
}
}
FBA_OUTBOUND_SHIPMENT_STATUS
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.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
FBAOutboundShipmentStatusNotification
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: Type: string |
Notification schema: FBAOutboundShipmentStatusNotification.json
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"
}
}
FEE_PROMOTION
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, refer to Selling on Amazon Fee Schedule and FBA features and fees on Seller Central.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
FeeDetail
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: 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 Type: |
IncludedFees |
A structured list of FeeDetail that contains the itemization of a specific fee type. |
No | Type: Array of FeeDetail
|
FeesEstimate
FeesEstimate
The following table shows the objects and properties of the FeesEstimate
object:
FeePromotionNotification
FeePromotionNotification
Each FeePromotionNotification
object is made up of the following data objects:
Name | Description | Required | Value |
---|---|---|---|
FeePromotionType |
The type of promotion. | Yes |
Values: 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
Identifier
The following table describes the objects and properties of an object from the Identifiers
array:
Name | Description | Required | Value |
---|---|---|---|
IdentifierType |
The selling partner (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 selling partner's actual ASINs or SKUs, an actual list of brands (like Nike), an actual list of browse nodes. Type: Array of |
IdentifierValue
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 selling partner (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
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: 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 Type: |
FeeDiscountValue |
The percentage discount of your fees if the FeeDiscountType involves a non-monetary amount. |
No |
If the 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
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
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"
}
}
]
}
}
]
}
}
}
FEED_PROCESSING_FINISHED
FEED_PROCESSING_FINISHED
Sellers and vendors 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
.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
A FEED_PROCESSING_FINISHED
notification with PayloadVersion
=2020-09-04 includes the following objects in the feedProcessingFinishedNotification
object.
Name | Description | Type | Required |
---|---|---|---|
accountId |
The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the feed was submitted. | string | Yes |
sellerId |
The merchant customer identifier of the selling partner account on whose behalf the feed was submitted. This field will be null when the feed was submitted on behalf of a vendor group identifier. | string | No |
feedId |
The identifier for the feed. | string | Yes |
feedType |
The feed type. For more information, refer to 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
Notification example for merchants
{
"notificationVersion": "2020-09-04",
"notificationType": "FEED_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-13T19:42:04.284Z",
"payload": {
"feedProcessingFinishedNotification": {
"sellerId": "A3TH9S8BH6GOGM",
"accountId": "amzn1.merchant.o.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:45:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
Notification example for vendors
{
"notificationVersion": "2020-09-04",
"notificationType": "FEED_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-13T19:42:04.284Z",
"payload": {
"feedProcessingFinishedNotification": {
"accountId": "amzn1.vg.6213651",
"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:45:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
FULFILLMENT_ORDER_STATUS
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 order.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
FulfillmentOrderStatusNotification
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.
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 Required Type: string |
FulfillmentOrderStatus |
The current status of the fulfillment order.
Required Type: string |
FulfillmentShipment |
Delivery and item information for a shipment in a fulfillment order. Optional. Returned only when Type: |
FulfillmentReturnItem |
Information about an item that was returned to an Amazon fulfillment center. Optional. Returned only when 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
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, 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
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"
}
}
ITEM_INVENTORY_EVENT_CHANGE
ITEM_INVENTORY_EVENT_CHANGE
Sellers and vendors can subscribe to this notification.
The ITEM_INVENTORY_EVENT_CHANGE
notification is sent five minutes after the beginning of each hour. This notification shares inventory data at an ASIN level, and includes data for the previous hour, as well as any delayed data from up to 24 hours earlier. ASINs are included if the number of units available for purchase
by customers has changed. Each notification may include multiple ASINs, and a selling partner can expect to receive multiple notifications every hour.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
ItemInventoryEventChangeNotifications
ItemInventoryEventChangeNotifications
Name | Description | Required | Type |
---|---|---|---|
itemInventoryEventChangeNotifications | A list of hourly grain inventory metrics by ASIN. | Yes | Array of ItemInventoryEventChangeNotification |
ItemInventoryEventChangeNotification
ItemInventoryEventChangeNotification
Name | Description | Required | Type |
---|---|---|---|
accountId | The merchant customer ID or vendor group ID of the partner account this notification is sent to. | Yes | String |
marketplaceId | The marketplace identifier of the inventory data. | Yes | String |
startTime | The start of the date-time range of the inventory data ISO 8601 format in UTC time. | Yes | String |
endTime | The end of the date-time range of the inventory data in ISO 8601 format in UTC time. | Yes | String |
asin | The Amazon Standard Identification Number of the product. | Yes | String |
highlyAvailableInventory | The number of units available to be sold on the website, based on units in Amazon fulfillment centers that are in sellable condition, minue units in customer shopping carts or otherwise bound for other orders (for example, subscribe-and-save orders). | Yes | Integer |
Notification Schema: ItemInventoryEventChangeNotification
Notification example
{
"notificationVersion": "2020-09-04",
"notificationType": "ITEM_INVENTORY_EVENT_CHANGE",
"payloadVersion": "2020-09-04",
"eventTime": "2023-02-07T16:05:32.378Z",
"payload": {
"itemInventoryEventChangeNotifications": [
{
"accountId": "amzn1.merchant.o.A21CXK3C4ERTY8",
"marketplaceId": "ATVPDKIKX0DER",
"startTime": "2023-02-07T15:00:00Z",
"endTime": "2023-02-07T16:00:00Z",
"asin": "B00032HE0O",
"highlyAvailableInventory": 650
}, {
"accountId": "amzn1.merchant.o.A21CXK3C4ERTY8",
"marketplaceId": "ATVPDKIKX0DER",
"startTime": "2023-02-07T15:00:00Z",
"endTime": "2023-02-07T16:00:00Z",
"asin": "B00094A20U",
"highlyAvailableInventory": 519
}
]
},
"notificationMetadata": {
"applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
"subscriptionId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2023-02-07T16:45:32.378Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
ITEM_SALES_EVENT_CHANGE
ITEM_SALES_EVENT_CHANGE
Sellers and vendors can subscribe to this notification.
The ITEM_SALES_EVENT_CHANGE
notification is sent five minutes after the beginning of each hour. This notification shares sales data at an ASIN level and includes data for the previous hour, as well as any delayed data from up to 24 hours earlier. ASINs are included when they have orders or cancellations during a given hour. Each notification may include multiple ASINs, and a selling partner can expect to receive multiple notifications every hour.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
ItemSalesEventNotifications
ItemSalesEventNotifications
Name | Description | Required | Type |
---|---|---|---|
itemSalesEventChangeNotifications | A list of hourly grain sales metrics by ASIN. | Yes | Array of ItemSalesEventChangeNotification |
ItemSalesEventChangeNotification
ItemSalesEventChangeNotification
Name | Description | Required | Type |
---|---|---|---|
accountId | The merchant customer ID or vendor group ID of the partner account this notification is sent to. | Yes | String |
marketplaceId | The marketplace identifier of the sales data. | Yes | String |
currencyCode | The currency code of any monetary amounts in ISO 4217 format. | Yes | String |
startTime | The start of the date-time range of the sales data in ISO 8601 format in UTC time. | Yes | String |
endTime | The end of the date-time range of the sales data in ISO 8601 format in UTC time. | Yes | String |
asin | The Amazon Standard Identification Number of the product. | Yes | String |
orderedUnits | The number of units ordered by Amazon customers in the specified time frame. This number can be negative if there are more cancellations than orders. | Yes | Integer |
orderedRevenue | The ordered product sales in the specified time frame. Adjustments are made for cancellations. | Yes | Number |
Notification Schema: ItemSalesEventChangeNotification
Notification example
{
"notificationVersion": "2020-09-04",
"notificationType": "ITEM_SALES_EVENT_CHANGE",
"payloadVersion": "2020-09-04",
"eventTime": "2023-02-07T16:05:32.378Z",
"payload": {
"itemSalesEventChangeNotifications": [
{
"accountId": "amzn1.merchant.o.A21CXK3C4ERTY8",
"marketplaceId": "ATVPDKIKX0DER",
"currencyCode": "USD",
"startTime": "2023-02-07T15:00:00Z",
"endTime": "2023-02-07T16:00:00Z",
"asin": "B00032HE0O",
"orderedUnits": 9,
"orderedRevenue": 80.91
}, {
"accountId": "amzn1.merchant.o.A21CXK3C4ERTY8",
"marketplaceId": "ATVPDKIKX0DER",
"currencyCode": "USD",
"startTime": "2023-02-07T15:00:00Z",
"endTime": "2023-02-07T16:00:00Z",
"asin": "B00094A20U",
"orderedUnits": 5,
"orderedRevenue": 527.60
}
]
},
"notificationMetadata": {
"applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
"subscriptionId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2023-02-07T16:45:32.378Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
ITEM_PRODUCT_TYPE_CHANGE
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.
Payload schema: Version 1.0
Workflow: Amazon EventBridge workflow
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
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"
}
}
LISTINGS_ITEM_STATUS_CHANGE
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, refer to the Listings Items API Use Case Guide.
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.
Payload schema: Version 1.0
Workflow: Amazon EventBridge workflow
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 selling partner (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 ISO 8601 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
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
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"
}
}
LISTINGS_ITEM_ISSUES_CHANGE
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, refer to the Listings Items API Use Case Guide.
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.
Currently, LISTINGS_ITEM_ISSUES_CHANGE
notification supports two payload versions: “2023-12-13”
, and “1.0”
. “2023-12-13”
is newer than “1.0”
. “2023-12-13”
has more “EnforcementActions”
than “1.0”
, which provides more listings item Issues' impact information. For example, “LISTING_SUPPRESSED”
enforcement action takes down the current listing item's buyability. Please subscribe or migrate to newer version “2023-12-13”
, and “1.0”
version will be deprecated soon.
Payload schema: Version 2023-12-13
Workflow: Amazon EventBridge workflow
A LISTINGS_ITEM_ISSUES_CHANGE
notification with PayloadVersion
=2023-12-13 includes the following objects in the Payload
object.
Name | Description | Type | Required |
---|---|---|---|
SellerId |
Selling partner identifier, such as a selling partner (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. Current possible values:
|
Array of string | No |
IssueSeverity
IssueSeverity
This table shows the possible values for IssueSeverity
:
Name | Description |
---|---|
ERROR | When provided, at least one issue with ERROR severity has occurred preventing the submission from processing, such as validation error. |
WARNING | When provided, at least one issue with WARNING severity has occurred that should be reviewed, but has not prevented the submission from processing. |
NONE | When provided, there are no defined issues affecting the listings item. However, there may be other problems with the listing. |
Notification schema: ListingsItemIssuesChangeNotification_2023-12-13.json
Notification example
{
"NotificationVersion":"1.0",
"NotificationType":"LISTINGS_ITEM_ISSUES_CHANGE",
"PayloadVersion":"2023-12-13",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "BT6RZ7JM4H",
"Sku": "NLS-SHOES-03",
"Severities": [
"ERROR",
"WARNING"
],
"EnforcementActions": [
"SEARCH_SUPPRESSED",
"LISTING_SUPPRESSED",
"ATTRIBUTE_SUPPRESSED",
"CATALOG_ITEM_REMOVED"
]
},
"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"
}
}
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 selling partner (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
IssueSeverity
This table shows the possible values for IssueSeverity
:
Name | Description |
---|---|
ERROR | When provided, at least one issue with ERROR severity has occurred preventing the submission from processing, such as a validation error. |
WARNING | When provided, at least one issue with WARNING severity has occurred that should be reviewed, but has not prevented the submission from processing. |
NONE | When provided, there are no defined issues affecting the listings item. However, there may be other problems with the listing. |
IssueEnforcementActions
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
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"
}
}
LISTINGS_ITEM_MFN_QUANTITY_CHANGE
LISTINGS_ITEM_MFN_QUANTITY_CHANGE
Sellers can subscribe to this notification.
Amazon sends a LISTINGS_ITEM_MFN_QUANTITY_CHANGE
notification to an integrator or seller whenever the available quantity for the seller-fulfilled (MFN) listings item changes. The available quantity is the number of units available at Amazon for customers to order. When a customer places an order, Amazon decrements the number of ordered units from the available quantity for that listings item. When the available quantity reaches zero, customers can no longer place orders on the item. Selling partners typically update Amazon with the exact number of units available in their stock to allow customers to place orders.
The available quantity for a listings item changes because of various factors, such as inventory quantity updates from the selling partner, new orders being placed, and existing orders being canceled. With this notification, subscribing selling partners no longer need to constantly poll the Selling Partner getListingsItem
operation or the Orders API to retrieve the latest available quantity.
The key features of this notification are:
- Selling partners stay up to date on the actual inventory available at Amazon.
- Selling partners plan ahead based on the inventory levels to meet the demand for their listings items.
- Selling partners synchronize and update inventory levels of their listings items with their internal systems and across their other sales channels.
- Selling partners do not need to frequently poll the inventory report or call the Selling Partner
getListingsItem
operation to determine the available quantity.
Payload schema: Version 1.0
Workflow: Amazon EventBridge workflow
A LISTINGS_ITEM_MFN_QUANTITY_CHANGE
notification with PayloadVersion
=1.0 includes the following properties in the Payload
object.
Name | Description | Type | Required |
---|---|---|---|
SellerId |
The Merchant Token of the selling partner who owns the listings item. | string | Yes |
FulfillmentChannelCode |
The Fulfillment channel code representing the MFN (seller-fulfilled) fulfillment program, network, or channel where the quantity is applicable. | string | Yes |
Sku |
A selling partner provided identifier for an Amazon listings item. | string | Yes |
Quantity |
The number of units available at Amazon. | integer | Yes |
Notification schema: ListingsItemMfnQuantityChange.json
Notification example
{
"NotificationVersion": "1.0",
"NotificationType": "LISTINGS_ITEM_MFN_QUANTITY_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2021-02-03T18:59:30.194Z",
"Payload": {
"SellerId": "AXXXXXXXXXXXXX",
"FulfillmentChannelCode": "DEFAULT",
"Sku": "NLS-SHOES-03",
"Quantity": 99
},
"NotificationMetadata": {
"ApplicationId": "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0",
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime": "2021-02-03T18:59:30.194Z",
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
}
}
ORDER_CHANGE
ORDER_CHANGE
Sellers can subscribe to this notification.
The ORDER_CHANGE
notification is sent whenever there is an important change in the order. Important changes include order status changes and buyer requested cancelations.
This notification supports the following eventFilter
value: orderChangeTypes
. To use this filter, you must also provide the following eventFilterType
: "eventFilterType": "ORDER_CHANGE"
.
Refer to Processing Directives for more information.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
The ORDER_CHANGE
notification with PayloadVersion
=1.0 includes the following properties in the OrderNotification
object.
Name | Description | Type | Required |
---|---|---|---|
NotificationLevel |
The notification level of the current notification. | string | Yes |
SellerId |
The selling partner identifier. | string | Yes |
AmazonOrderId |
An Amazon-defined order identifier in 3-7-7 format. | string | Yes |
OrderChangeType |
The type of order change that triggered the notification to be sent. Possible values are BuyerRequestedChange and OrderStatusChange . |
string | Yes |
OrderChangeTrigger |
Details about what caused this ORDER_CHANGE notification to be sent. |
OrderChangeReason |
Yes |
Summary |
Information about the order and order items that had the change. | OrderChangeSummary |
Yes |
OrderChangeReason
OrderChangeReason
Name | Description | Type | Required |
---|---|---|---|
TimeOfOrderChange |
The time of the change that caused this notification, in ISO 8601 date/time format. Will be null when there is no related timestamp. | string | Yes |
ChangeReason |
The reason this ORDER_CHANGE notification was sent. |
string | Yes |
OrderChangeSummary
OrderChangeSummary
Name | Description | Type | Required |
---|---|---|---|
MarketplaceID |
The Amazon marketplace identifier of the order. | string | Yes |
OrderStatus |
The current order status. The possible values are UpComing , Pending , Unshipped , PartiallyShipped , PendingAvailability , Canceled , InvoiceUnconfirmed , Shipped , and Unfulfillable . |
string | Yes |
PurchaseDate |
The purchase date of the order, in ISO 8601 date/time format. It will be null when there is no related information. | string | Yes |
DestinationPostalCode |
The destination postal code. It will be null when there is no related information. | string | Yes |
FulfillmentType |
Fulfillment type of the affected order, MFN or AFN. | string | Yes |
OrderType |
The type of the order. | string | Yes |
NumberOfItemsShipped |
The number of items shipped. | integer | No |
NumberOfItemsUnshipped |
The number of items unshipped. | integer | No |
EarliestDeliveryDate |
The start of the time period during which you committed to fulfill the order, in ISO 8601 date/time format. Returned only for seller-fulfilled orders. | string | No |
LatestDeliveryDate |
The end of the time period during which you committed to fulfill the order, in ISO 8601 date/time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability , Pending , or Canceled status. |
string | No |
EarliestShipDate |
The start of the time period during which you committed to ship the order, in ISO 8601 date/time format. | string | No |
LatestShipDate |
The end of the time period during which you committed to ship the order, in ISO 8601 date/time format. | string | No |
CancelNotifyDate |
The end of the time period during which you must notify the seller of possible cancellation, in ISO 8601 date/time format. | string | No |
OrderPrograms |
The order programs in which this order participates. | array of string | No |
ShippingPrograms |
The shipping programs in which this order participates. | array of string | No |
EasyShipShipmentStatus |
The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. | string | No |
ElectronicInvoiceStatus |
The status of the electronic invoice. | string | No |
OrderItems |
Information about order items included in this order. For OrderItemLevel notifications, one payload includes one item, while for OrderLevel notifications, one payload includes all items. |
Array of OrderItem |
Yes |
OrderItem
OrderItem
Name | Description | Type | Required |
---|---|---|---|
OrderItemId |
The Amazon-defined order item identifier. | string | Yes |
SellerSKU |
The seller-specific SKU for an item. | string | Yes |
SupplySourceId |
The unique identifier of the supply source. Will be null when there is no related information. | string | Yes |
OrderItemStatus |
The current status of the order item. This field Will have a non-null value when items' statuses are different. | string | No |
Quantity |
The number of items in the order. | integer | Yes |
QuantityShipped |
The number of items shipped. | integer | No |
IsBuyerRequestedCancel |
True when the buyer has requested cancelation. | boolean | No |
ItemEarliestDeliveryDate |
The start of the time period during which you have committed to fulfill the order. | string | No |
ItemLatestDeliveryDate |
The end of the time period during which you have committed to fulfill the order. | string | No |
Notification schema: OrderChangeNotification.json
Notification example
{
"NotificationVersion" : "1.0",
"NotificationType" : "ORDER_CHANGE",
"PayloadVersion" : "1.0",
"EventTime" : "2020-01-11T00:09:53.109Z",
"Payload" : {
"OrderChangeNotification": {
"NotificationLevel": "OrderLevel",
"SellerId": "A3TH9S8BH6GOGM",
"AmazonOrderId": "903-8868176-2219830",
"OrderChangeType": "BuyerRequestedChange",
"OrderChangeTrigger": {
"TimeOfOrderChange": "2022-11-29T19:42:04.284Z",
"ChangeReason": "Buyer Requested Cancel"
},
"Summary": {
"MarketplaceId": "ATVPDKIKX0DER",
"OrderStatus": "Unshipped",
"PurchaseDate": "2022-07-13T19:42:04.284Z",
"DestinationPostalCode": "48110",
"FulfillmentType": "MFN",
"OrderType": "StandardOrder",
"NumberOfItemsShipped": 0,
"NumberOfItemsUnshipped": 10,
"EarliestDeliveryDate": "2022-11-07T19:42:04.284Z",
"LatestDeliveryDate": "2022-12-07T19:42:04.284Z",
"EarliestShipDate": "2022-11-07T19:42:04.284Z",
"LatestShipDate": "2022-12-07T19:42:04.284Z",
"CancelNotifyDate": "2022-12-07T19:42:04.284Z",
"OrderPrograms": ["Business"],
"ShippingPrograms": ["EasyShip"],
"EasyShipShipmentStatus": "Delivered",
"ElectronicInvoiceStatus": "NotFound",
"OrderItems": [
{
"OrderItemId": "OIID34853450",
"SellerSKU": "SellerSKUID1",
"SupplySourceId": "d7679e14-031b-4ab3-a81b-ec4fc7a460b3",
"OrderItemStatus": "Unshipped",
"Quantity": 10,
"QuantityShipped": 0,
"IsBuyerRequestedCancel": true,
"ItemEarliestDeliveryDate": "2022-11-07T19:42:04.284Z",
"ItemLatestDeliveryDate": "2022-12-07T19:42:04.284Z"
}
]
}
}
},
"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"
}
}
PRICING_HEALTH
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.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
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: |
merchantOffer |
Offer details of the selling partner (merchant) receiving the notification.
Required. Type: |
summary |
Information about the item that had the offer change. The information in this summary applies to all conditions of the product.
Required. Type: |
buyBoxPrice
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 Required. Type: |
listingPrice |
The price of the item. Required. Type: |
shipping |
The shipping cost. Required. Type: |
points |
The number of Amazon Points offered with the purchase of an item. Optional. Type: |
merchantOffer
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: |
listingPrice |
The price of the item.
Required. Type: |
shipping |
The shipping cost.
Required. Type: string |
points |
The number of Amazon Points offered with the purchase of an item.
Optional. Note: The Type: |
offerChangeTrigger
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
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
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
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: |
competitivePriceThreshold |
The competitive price threshold from external competitors of Amazon. Optional. Type: |
retailOfferPrice |
The 14 day maximum of retail offer price. Optional. Type: |
msrpPrice |
The manufacturer suggested retail price for the ASIN. Optional. Type: |
salesRank
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
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 |
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 |
buyBoxPrices |
A list that contains the Buy Box price of the item for the given conditions. Optional. Type: array of |
salesRankings |
A list that contains the sales rankings of the ASIN in various product categories. Optional. Type: array of |
referencePrice |
A set of reference prices for the given ASIN. Required. Type: |
Notification schema: PricingHealthNotification.json
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"
}
}
PRODUCT_TYPE_DEFINITIONS_CHANGE
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, refer to the Product Type Definitions API Use Case Guide.
Payload schema: Version 1.0
Workflow: Amazon EventBridge workflow
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 selling partner (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 newly released Amazon product type definition. | string | Yes |
NewProductTypes |
List of product types launched in a marketplace. | Array of string | No |
Notification schema: ProductTypeDefinitionsChangeNotification.json
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"
}
}
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"
}
}
REPORT_PROCESSING_FINISHED
REPORT_PROCESSING_FINISHED
Sellers and vendors can subscribe to this notification.
The REPORT_PROCESSING_FINISHED
notification is sent whenever any report that you have requested using the Selling Partner API for Reports reaches a report processing status of DONE
, CANCELLED
, or FATAL
.
Payload schema: Version 1.0
Workflow: Amazon Simple Queue Service workflow
The REPORT_PROCESSING_FINISHED
notification with PayloadVersion
=2020-09-04 includes the following objects in the reportProcessingFinishedNotification
object.
Name | Description | Type | Required |
---|---|---|---|
accountId |
The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the report was submitted. | string | Yes |
sellerId |
The merchant customer identifier of the selling partner account on whose behalf the feed was submitted. This field will be null when the feed was submitted on behalf of a vendor group identifier. | string | No |
reportId |
The identifier of the report. | string | Yes |
reportType |
The report type. For more information, refer to 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
Notification example for merchants
{
"notificationVersion": "2020-09-04",
"notificationType": "REPORT_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-14T03:35:13.214Z",
"payload": {
"reportProcessingFinishedNotification": {
"sellerId": "A3TH9S8BH6GOGM",
"accountId": "amzn1.merchant.o.A3TH9S8BH6GOGM",
"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:45:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
Notification example for vendors
{
"notificationVersion": "2020-09-04",
"notificationType": "REPORT_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-14T03:35:13.214Z",
"payload": {
"reportProcessingFinishedNotification": {
"accountId": "amzn1.vg.6213651",
"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:45:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
Common types
Contains common types that are used by all notifications that are contained in the Notification payload objects.
FulfillmentChannelType
FulfillmentChannelType
Indicates whether the item is fulfilled by Amazon or by the seller.
Type: string
FulfillmentChannelType
values:
-
Amazon
-
Merchant
moneyType
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
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 |
Updated about 2 months ago