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

Sellers can subscribe to this notification.

The ACCOUNT_STATUS_CHANGED notification is sent whenever the Account Status changes for the developers subscribed selling partner/Amazon store pairs. A notification is published whenever the selling partner's account status changes between NORMAL, AT_RISK, and DEACTIVATED.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 2021-01-01

Workflow: Amazon Simple Queue Service workflow

The following table shows the properties of the accountStatusChangeNotification object:

NameDescription
previousAccountStatusThe seller's account status prior to this update.

Required.

Type: string

Possible values: NORMAL, AT_RISK, DEACTIVATED

currentAccountStatus

The seller's new account status.

Required.

Type: string

Possible values: NORMAL, AT_RISK, DEACTIVATED

Notification schema: AccountStatusChangedNotification.json

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

Sellers can subscribe to this notification.

This notification supports the following eventFilter values: aggregationSettings, marketplaceIds. To use these filters, you must also provide the
eventFilterType: "eventFilterType": "ANY_OFFER_CHANGED".

This notification also supports filterExpression for CEL-based filtering, but without aggregation capability. You cannot use eventFilter and filterExpression together. For more information, refer to Filter notification subscriptions.

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:

NameDescription
SellerIdThe seller identifier for the offer.

Required.

Type: String

OfferChangeTriggerThe event that caused the notification to be sent.

Required.

Type: OfferChangeTrigger

SummaryInformation about the product that had the offer change. The information in this summary applies to all conditions of the product.

Required.

Type: Summary

OffersThe top 20 competitive offers for the item and condition that triggered the notification.

Required.

Type: Array of Offer

BuyBoxPrice

The following table shows the objects and properties of the BuyBoxPrice object:

NameDescription
LandedPriceListingPrice + Shipping - Points.

Required.

Type: MoneyType

ListingPriceThe price of the item.

Required.

Type: MoneyType

ShippingThe shipping cost.

Required.

Type: MoneyType

PointsThe number of Amazon Points offered with the purchase of an item.

Optional.

Note: The Points object is only returned in Japan (JP).

Type: Points

ConditionIndicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.

Required.

Type: String

LowestPrice

The following table shows the objects and properties of the LowestPrice object:

NameDescription
LandedPrice

ListingPrice + Shipping - Points.

Required.

Type: MoneyType

ListingPrice

The price of the item.

Required.

Type: MoneyType

Shipping

The shipping cost.

Required.

Type: MoneyType

Points

The number of Amazon Points offered with the purchase of an item.

Optional.

Note: The Points object is only returned in Japan (JP).

Type: Points

Condition

Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.

Required.

Type: String

FulfillmentChannel

Indicates whether the item is fulfilled by Amazon or by the seller.

Required.

Type: FulfillmentChannelType

Offer

The following table shows the objects and properties of the Offer object:

NameDescription
SellerId

The seller identifier for the offer.

Required.

Type: String

SubCondition

The subcondition of the item. For example: New, Mint, Very Good, Good, Acceptable, Poor, Club, Ocode, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.

Required.

Type: String

SellerFeedbackRating

Information about the seller's feedback, including the percentage of positive feedback, and the total count of feedback received.

Optional.

Type: SellerFeedbackRating

ShippingTime

The minimum and maximum time, in hours, that the item will likely be shipped after the order has been placed.

Required.

Type: ShippingTime

ListingPrice

The price of the item.

Required.

Type: MoneyType

Points

The number of Amazon Points offered with the purchase of an item.

Optional.

Note: The Points object is only returned in Japan (JP).

Type: Points

Shipping

The shipping cost.

Required.

Type: MoneyType

ShipsFrom

The state and country from where the item is shipped.

Optional.

Type: ShipsFrom

IsFulfilledByAmazon

Indicates whether the offer is fulfilled by Amazon.

Required.

Type: boolean

IsBuyBoxWinner

Indicates whether the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime.

Optional.

Type: boolean

ConditionNotes

Information about the condition of the item.

Optional.

Type: string

PrimeInformation

Amazon Prime information.

Optional.

Type: PrimeInformation

IsExpeditedShippingAvailable

Indicates whether expedited shipping is available.

Optional.

Type: boolean

IsFeaturedMerchant

Indicates whether the seller of the item is eligible to win the Buy Box.

Optional.

Type: boolean

ShipsDomestically

Indicates whether the item ships domestically.

Optional.

Type: boolean

OfferChangeTrigger

The following table shows the properties of the OfferChangeTrigger object:

NameDescription
MarketplaceId

The Amazon store identifier of the item that had an offer change.

Required.

Type: string

ASIN

The ASIN for the item that had an offer change.

Required.

Type: string

ItemCondition

The condition of the item that had an offer change. For example, if a used offer changes, the array of offers in the Offers object will be only used items. The Summary object provides a summary for the other conditions that can be used for repricing.

Required.

Type: string

TimeOfOfferChange

The update time for the offer that caused this notification, in ISO 8601 format.

Required.

Type: string

OfferChangeType

The type of offer that changed and triggered this notification.


OfferChangeType values:

External - The CompetitivePriceThreshold in the Summary object has changed, triggered by a new offer from a non-Amazon seller.

Internal - The price of an offer on Amazon's retail website has changed.

Featured Offer - The Buy Box winner or Buy Box price has changed.

Required.


Type: string

OfferCount

The following table shows the objects and properties of the OfferCount object:

NameDescription
Condition

Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.

Required.

Type: string

FulfillmentChannel

Indicates whether the item is fulfilled by Amazon or by the seller.

Required.

Type: FulfillmentChannelType

OfferCount

The total number of offers for the specified condition and fulfillment channel.

Required.

Type: integer

Points

The following table shows the properties of the Points object:

NameDescription
PointsNumber

The number of Amazon Points offered with the purchase of an item.

Required.

Type: integer

PrimeInformation

The following table shows the objects and properties of the PrimeInformation object:

NameDescription
IsOfferNationalPrime

Indicates whether the offer is an Amazon Prime offer throughout the entire Amazon store where it is listed.

Required.

Type: boolean

IsOfferPrime

Indicates whether the offer is an Amazon Prime offer.

Required.

Type: boolean

SalesRank

The following table shows the properties of the SalesRank object:

NameDescription
ProductCategoryId

The product category identifier of the item.

Required.

Type: string

Rank

The sales rank of the item in the given product category.

Required.

Type: integer

SellerFeedbackRating

The following table shows the objects and properties of the SellerFeedbackRating object:

NameDescription
SellerPositiveFeedbackRating

The percentage of positive feedback for the seller in the past 365 days.

Optional.

Type: double

FeedbackCount

The count of feedback received about the seller.

Required.

Type: long

ShippingTime

The following table shows the properties of the ShippingTime object:

NameDescription
MinimumHours

The minimum time, in hours, that the item will likely be shipped after the order has been placed.

Optional.

Type: short

MaximumHours

The maximum time, in hours, that the item will likely be shipped after the order has been placed.

Optional.

Type: short

AvailableDate

The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping.

Optional.

Type: string

AvailabilityType

Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate attribute indicates the date that the item will be available for shipping.

Optional.

Type: string

ShipsFrom

The following table shows the objects and properties of the ShipsFrom object:

NameDescription
State

The state from where the item is shipped.

Optional.

Type: string

Country

The country from where the item is shipped.

Optional.

Type: string

IsFulfilledByAmazon

Indicates whether the offer is fulfilled by Amazon.

Required.

Type: boolean

Summary

The following table shows the objects and properties of the Summary object:

NameDescription
NumberOfOffers

A list that contains the total number of offers for the item for the given conditions and fulfillment channels.

Required.

Type: Array of OfferCount

LowestPrices

A list that contains the lowest prices of the item for the given conditions and fulfillment channels.

Required.

Type: Array of LowestPrice

BuyBoxPrices

A list that contains the Buy Box price of the item for the given conditions.

Optional.

Type: Array of BuyBoxPrice

ListPrice

The list price of the item as suggested by the manufacturer.

Optional.

Type: MoneyType

SuggestedLowerPricePlusShipping

The suggested lower price of the item, including shipping (minus Amazon Points). The suggested lower price is based on a range of factors, including historical selling prices, recent Buy Box-eligible prices, and input from customers for your products.

Optional.

Type: MoneyType

SalesRankings

A list that contains the sales rank of the item in the given product categories.

Optional.

Type: Array of SalesRank

NumberOfBuyBoxEligibleOffers

A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels.

Required.

Type: Array of OfferCount

CompetitivePriceThreshold

This price is based on competitive prices from other retailers (excluding other Amazon sellers). Your offer may be ineligible for the Buy Box if your price + shipping is greater than this competitive price.

Optional.

Type: MoneyType

Notification schema: AnyOfferChangedNotification.json

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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

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 B2BAnyOfferChangedNotification object:

NameDescription
OfferChangeTrigger

The event that caused the notification to be sent.

Required.

Type: OfferChangeTrigger

Summary

Information about the product that had the offer change. The information in this summary applies to all conditions of the product.

Required.

Type: Summary

Offers

The top 20 competitive B2B offers for the item and condition that triggered the notification.

Required.

Type: Array of Offer

SellerId

The seller identifier for the offer.

Required.

Type: string

BuyBoxPrice

The following table shows the objects and properties of the BuyBoxPrice object.

NameDescription
LandedPrice

ListingPrice + Shipping.

Optional.

Type: MoneyType

ListingPrice

The price of the item.

Required.

Type: MoneyType

Shipping

The shipping cost.

Optional.

Type: MoneyType

OfferType

Indicates whether the offer is a B2B offer or a B2C offer. When the offer type is B2C in a quantity discount, the seller is winning the Buy Box because others do not have inventory at that quantity, not because they have a quantity discount on the ASIN.

Required.

Type: string

QuantityTier

The quantity tier for the offer.

Required.

Type: integer

DiscountType

Indicates whether the quantity tier is for Quantity Discount or Progressive Discount.

Optional.

Type: string

Condition

Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.

Required.

Type: string

SellerId

The seller identifier for the offer.

Optional.

Type: string

Points

The number of Amazon Points offered with the purchase of an item.

Optional.

Type: Points

LowestPrice

The following table shows the objects and properties of the LowestPrice type under Summary object:

NameDescription
LandedPrice

ListingPrice + Shipping.

Optional.

Type: MoneyType

ListingPrice

The price of the item.

Required.

Type: MoneyType

Shipping

The shipping cost.

Optional.

Type: MoneyType

OfferType

Indicates whether the offer is a B2B offer or a B2C offer

Required.

Type: string

QuantityTier

The quantity tier for the offer

Required.

Type: integer

DiscountType

Indicates whether the quantity tier is for Quantity Discount or Progressive Discount.

Optional.

Type: string

Condition

Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.

Required.

Type: string

FulfillmentChannel

Indicates whether the item is fulfilled by Amazon or by the seller.

Required.

Type: FulfillmentChannelType

Points

The number of Amazon Points offered with the purchase of an item.

Optional.

Type: Points

Offer

The following table shows the objects and properties of the Offer object:

NameDescription
SellerId

The seller identifier for the offer.

Required.

Type: string

SubCondition

The subcondition of the item. For example: New, Mint, Very Good, Good, Acceptable, Poor, Club, Ocode, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other.

Required.

Type: string

SellerFeedbackRating

Information about the seller's feedback, including the percentage of positive feedback, and the total count of feedback received.

Optional.

Type: SellerFeedbackRating

ShippingTime

The minimum and maximum time, in hours, that the item will likely be shipped after the order has been placed.

Required.

Type: ShippingTime

ListingPrice

The price of the item.

Required.

Type: MoneyType

Shipping

The shipping cost.

Required.

Type: MoneyType

ShipsFrom

The country from where the item is shipped.

Optional.

Type: ShipsFrom

IsFulfilledByAmazon

Indicates whether the offer is fulfilled by Amazon.

Required.

Type: boolean

IsBuyBoxWinner

Indicates whether the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime.

Optional.

Type: boolean

ConditionNotes

Information about the condition of the item.

Optional.

Type: string

PrimeInformation

Amazon Prime information.

Optional.

Type: PrimeInformation

IsFeaturedMerchant

Indicates whether the seller of the item is eligible to win the Buy Box.

Optional.

Type: boolean

Points

The number of Amazon Points offered with the purchase of an item.

Optional.

Type: Points

QuantityDiscountPrice

Contains pricing information that includes special pricing when buying in bulk.

Optional.

Type: Array of QuantityDiscountPrice

OfferChangeTrigger

The following table shows the properties of the OfferChangeTrigger object:

NameDescription
MarketplaceId

The Amazon store identifier of the item that had an offer change.

Required.

Type: string

ASIN

The ASIN for the item that had an offer change.

Required.

Type: string

ItemCondition

The condition of the item that had an offer change. For example, if a used offer changes, the array of offers in the Offers object will be only used items. The Summary object provides a summary for the other conditions that can be used for repricing.

Required.

Type: string

TimeOfOfferChange

The update time for the offer that caused this notification.

Required.

Type: string

OfferCount

The following table shows the objects and properties of the OfferCount type:

NameDescription
Condition

Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club.

Required.

Type: string

FulfillmentChannel

Indicates whether the item is fulfilled by Amazon or by the seller.

Required.

Type: FulfillmentChannelType

OfferCount

The total number of offers for the specified condition and fulfillment channel.

Type: integer

Points

The following table shows the properties of the Points object:

NameDescription
PointsNumber

The number of Amazon Points offered with the purchase of an item.

Required.

Type: integer

PrimeInformation

The following table shows the properties of the PrimeInformation object:

NameDescription
IsNationalPrime

Indicates whether the offer is an Amazon Prime offer throughout the entire Amazon store where it is listed.

Required.

Type: boolean

IsPrime

Indicates whether the offer is an Amazon Prime offer.

Required.

Type: boolean

QuantityDiscountPrice

The following table shows the properties of the QuantityDiscountPrice object:

NameDescription
QuantityTier

Indicates at what quantity this price becomes active.

Required.

Type: integer

QuantityDiscountType

Indicates the type of quantity discount this price applies to.

Required.

Type: string

ListingPrice

The price at this quantity tier.

Required.

Type: MoneyType

SellerFeedbackRating

The following table shows the properties of the SellerFeedbackRating object:

NameDescription
SellerPositiveFeedbackRating

The percentage of positive feedback for the seller in the past 365 days.

Optional.

Type: integer

FeedbackCount

The count of feedback received about the seller.

Required.

Type: integer

ShippingTime

The following table shows the properties of the ShippingTime object:

NameDescription
MinimumHours

The minimum time, in hours, that the item will likely be shipped after the order has been placed.

Optional.

Type: integer

MaximumHours

The maximum time, in hours, that the item will likely be shipped after the order has been placed.

Optional.

Type: integer

AvailableDate

The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping.

Optional.

Type: string

AvailabilityType

Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping.

Optional.

Type: string

ShipsFrom

The following table shows the properties of the ShipsFrom object:

NameDescription
Country

The ISO 3166-1 alpha-2 code for the country from where the item is shipped.

Optional.

Type: string

State

The two-letter postal abbreviation for the state from where the item is shipped.

Optional.

Type: string

Summary

The following table shows the objects and properties of the Summary object:

NameDescription
NumberOfOffers

A list that contains the total number of B2B offers for the item for the given conditions and fulfillment channels.

Required.

Type: Array of OfferCount

LowestPrices

A list that contains the lowest prices of the item for the given conditions, fulfillment channels, quantity tiers, and discount types.

The seven pre-defined quantity tiers for discount type “Quantity Discounts” are 2, 3, 5, 10, 20, 30 and 50.

Required.

Type: Array of LowestPrice

BuyBoxPrices

A list that contains the Buy Box price of the item for the given conditions, quantity tiers, and discount types.

Up to the first 50 quantity tiers are shown.

Optional.

Type: Array of BuyBoxPrice

BuyBoxEligibleOffers

A list that contains the total number of B2B offers that are eligible for the Buy Box for the given conditions and fulfillment channels.

Required.

Type: Array of OfferCount

Notification schema: B2bAnyOfferChangedNotification.json

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"
            },
            "Points": {
              "PointsNumber": 100
            }
          },
          {
            "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"
            },
            "Points": {
              "PointsNumber": 100
            },
            "SellerId": "A2VUIDM8BZ902A"
          },
          {
            "Condition": "new",
            "OfferType": "B2B",
            "QuantityTier": 20,
            "DiscountType": "QUANTITY_DISCOUNT",
            "ListingPrice": {
              "Amount": 8000,
              "CurrencyCode": "USD"
            },
            "SellerId": "A2VUIDM8BZ902A"
          },
          {
            "Condition": "new",
            "OfferType": "B2B",
            "QuantityTier": 30,
            "DiscountType": "QUANTITY_DISCOUNT",
            "ListingPrice": {
              "Amount": 7800,
              "CurrencyCode": "USD"
            },
            "SellerId": "A2VUIDM8BZ902A"
          }
        ]
      },
      "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"
          },
          "Points": {
            "PointsNumber": 50
          },
          "QuantityDiscountPrice": [
            {
              "QuantityTier": 5,
              "QuantityDiscountType": "QUANTITY_DISCOUNT",
              "ListingPrice": {
                "CurrencyCode": "USD",
                "Amount": 8183.00
              }
            }
          ],
          "Shipping": {
            "Amount": 4.49,
            "CurrencyCode": "USD"
          },
          "ShipsFrom": {
            "Country": "US",
            "State": "WA"
          },
          "IsFulfilledByAmazon": false,
          "IsBuyBoxWinner": true,
          "ConditionNotes": "New in box",
          "PrimeInformation": {
            "IsPrime": true,
            "IsNationalPrime": true
          },
          "IsFeaturedMerchant": true
        }
      ]
    }
  }
}

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 store.

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.

NameDescriptionRequired
MarketplaceIdthe Amazon store that the item is listed in.

Type: string

Yes
BrandNameThe brand name of the item.

Type: string

Yes
AsinThe 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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

DetailPageTrafficEventNotifications

The following table shows the objects and properties of the DetailPageTrafficEventNotifications object:

NameDescriptionRequiredType
detailPageTrafficEventNotificationsA list of hourly grain traffic metrics by ASIN.YesArray of DetailPageTrafficEventNotification

DetailPageTrafficEventNotification

NameDescriptionRequiredType
accountIdThe merchant customer ID or vendor group ID of the partner account this notification is sent to.YesString
marketplaceIdThe Amazon store identifier of the traffic data.YesString
startTimeThe start of the date-time range of the traffic data ISO 8601 format in UTC time.YesString
endTimeThe end of the date-time range of the traffic data in ISO 8601 format in UTC time.YesString
asinThe Amazon Standard Identification Number of the product.YesString
glanceViewsThe number of customer views of the product detail page for this ASIN.YesInteger

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

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 Amazon stores in a particular region.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

FBAInventoryAvailabilityChangeNotification

The following table shows the objects and properties of the FBAInventoryAvailabilityChangeNotification object:

NameDescription
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 Amazon store.

Type: Array of FulfillmentInventoryDetails

FulfillmentInventoryDetails

The following table describes the objects and properties of a FulfillmentInventoryDetails object:

NameDescription
MarketplaceId

The Amazon store 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

Stores

A list of seller-enrolled stores that apply to this seller SKU.

Type: Array of string

FulfillmentInventory

The following table describes the objects and properties of a FulfillmentInventory object:

NameDescription
InboundQuantityBreakdown

Details of the affected item's inbound units, which are either still in WORKING status or on the way to be received in Amazon warehouses.

Type: InboundQuantityBreakdown

Fulfillable

The number of units of the affected item that can be used to fulfill orders in the given Amazon store.

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.

Type: ReservedQuantityBreakdown

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

The following table describes the objects and properties of a InboundQuantityBreakdown object:

NameDescription
Working

The number of units of the affected item that currently reside in a WORKING status shipment.

Type: int

Shipped

The number of units of the affected item that currently reside in a SHIPPED, IN_TRANSIT, DELIVERED or CHECKED_IN status shipment.

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

The following table describes the objects and properties of a ReservedQuantityBreakdown object:

NameDescription
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
        },
        "Stores": [
          "Low-Cost Store"
        ]
      },
      {
        "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
        },
        "Stores": [
          "Low-Cost Store"
        ]
      }
    ]
  },
  "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"
  }
}

EXTERNAL_FULFILLMENT_SHIPMENT_STATUS_CHANGE

Sellers can subscribe to this notification.

The EXTERNAL_FULFILLMENT_SHIPMENT_STATUS_CHANGE notification is sent whenever there is a change in the order status for a warehouse integration order. Possible status values are:

  • ACCEPTED
  • CONFIRMED
  • PACKAGE_CREATED
  • PICKUP_SLOT_RETRIEVED
  • INVOICE_GENERATED
  • SHIPLABEL_GENERATED
  • SHIPPED
  • DELIVERED
  • CANCELLED
📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

The EXTERNAL_FULFILLMENT_SHIPMENT_STATUS_CHANGE notification with PayloadVersion = 1.0 includes the following properties in the Payload object:

NameDescriptionType
externalFulfillmentShipmentNotificationInformation about the shipment, including the merchant, location, and shipment IDs, as well as the channel name and shipment status.object

Notification schema: ExternalFulfillmentShipmentStatusChangeNotification.json

Notification Example:

{
  "notificationVersion": "1.0",
  "notificationType": "EXTERNAL_FULFILLMENT_SHIPMENT_STATUS_CHANGE",
  "payloadVersion": "1.0",
  "eventTime": "2024-01-22T13:32:15.686Z",
  "payload": {
    "externalFulfillmentShipmentNotification": {
      "merchantId": "ABCDEFGHIJKL",
      "locationId": "ec4621aa-76a7-4e5f-b158-4c8b0ac87",
      "shipmentId": "U3CgWfn",
      "channelName": "FBA",
      "shipmentStatus": "CONFIRMED"
    }
  },
  "notificationMetadata": {
    "applicationId": "amzn1.sp.solution.9531e-5d47-45e5-aa9a-11dcd3b00cf",
    "subscriptionId": "d2d37640-e1f-46b-ad4-71a5e5520f",
    "publishTime": "2024-01-22T13:32:17.197Z",
    "notificationId": "b7f4884b-a046-43ca-8cb4-fb0f106321"
  }
}

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 Amazon Brazil store.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

FBAOutboundShipmentStatusNotification

The following table shows the objects and properties of the FBAOutboundShipmentStatusNotification object:

NameDescription
SellerId

The seller identifier.

Type: string

AmazonOrderId

The Amazon-defined order identifier.

Type: string

AmazonShipmentId

The Amazon-defined shipment identifier.

Type: string

ShipmentStatus

The shipment status. ShipmentStatus values: Created, Cancelled.

Type: string

Notification schema: FBAOutboundShipmentStatusNotification.json

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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

FeeDetail

The following table shows the objects and properties of a FeeDetail object:

NameDescriptionRequiredValue
FeeTypeThe type of fees charged.Yes

Allowed Fee types: ReferralFee, VariableClosingFee, PerItemFee, FBAFees, FBAPickAndPack, FBAWeightHandling, FBAOrderHandling, FBADeliveryServicesFee.

Type: string

FeeAmountThe fee amount corresponding to the fee type.YesType: MoneyType
FeePromotionThe fee promotion amount corresponding to the fee type.NoType: MoneyType
TaxAmountThe tax calculated over fee that would be charged to the seller.NoType: MoneyType
FinalFeeThe final fee that would be charged to the seller.Yes

The FeeAmount minus the FeePromotion.

Type: MoneyType

IncludedFeesA structured list of FeeDetail that contains the itemization of a specific fee type.NoType: Array of FeeDetail

FeesEstimate

The following table shows the objects and properties of the FeesEstimate object:

NameDescriptionRequiredValue
TimeOfFeesEstimatedThe date time when the fees were estimated.YesType: string
TotalFeesEstimateThe total amount of fees if the price is lowered to or below the price threshold.YesType: MoneyType
FeeDetailsAn itemization of the TotalFeesEstimate.YesType: Array of FeeDetail

FeePromotionNotification

Each FeePromotionNotification object is made up of the following data objects:

NameDescriptionRequiredValue
FeePromotionTypeThe type of promotion.Yes

Values: Pricing, SelectionASIN, or SelectionCategory. Additional types may become available in the future.

Type: string

FeePromotionTypeDescriptionProvides more details on the purpose of a promotion.No

A friendly, localized string description. Useful for integrators to display on a UI.

Type: string

MarketplaceIdThe promotion applies to this marketplaceId.YesType: string
MerchantIdThe promotion applies to this merchantId.YesType: string
IdentifiersA list of items to which this promotion applies.YesType: Array of Identifier
PromotionActiveTimeRangeThe range of time when this promotion is active.YesType: PromotionActiveTimeRange
PromotionInformationAn object containing additional details about the promotion. A fee estimate is included if applicable.YesType: PromotionInformation

Identifier

The following table describes the objects and properties of an object from the Identifiers array:

NameDescriptionRequiredValue
IdentifierTypeThe selling partner (merchant) identifier type for which this promotion will apply to.Yes

For example: ASIN, SKU, Browse node, Brand.

Type: string

IdentifierValuesThe 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 IndentifierValue

IdentifierValue

A description of identifier values to which this promotion applies.

NameDescriptionRequiredValue
IdentifierValueIdThe actual browse node ID, actual ASIN/SKU, or brand value.YesType: string
IdentifierValueFriendlyNameThe selling partner (merchant) identifier values to which this promotion will apply.NoOnly relevant/populated for things like browse nodes. For example, this would be a browse node's friendly name.

Type: string

PromotionInformation

The following table shows the objects and properties of the PromotionInformation object:

NameDescriptionRequiredValue
FeeTypeThe fee type which is being discounted in this promotion.Yes

Allowed Fee types: ReferralFee, VariableClosingFee, PerItemFee, FBAFees, FBAPickAndPack, FBAWeightHandling, FBAOrderHandling, FBADeliveryServicesFee.

Type: string

FeeDiscountTypeThe type of promotion you will be receiving for your fees.Yes

Either Fixed, Discount, or Percentage points off.

Type: string

PriceThresholdThe qualifying threshold offer price, or less, that must be met for the promotion to apply.NoType: MoneyType
FeeDiscountMonetaryAmountThe amount you will receive off of your fees if the FeeDiscountType involves a monetary amount.No

If the FeeDiscountType involves a monetary amount, this value will be populated.

Type: MoneyType

FeeDiscountValueThe percentage discount of your fees if the FeeDiscountType involves a non-monetary amount.No

If the FeeDiscountType involves a non-monetary amount, this value will be populated.

Type: number

FeesEstimateThe fee estimate for this promotion, if it is available. The estimate assumes that all condition required for the promotion have been met.NoType: FeesEstimate

PromotionActiveTimeRange

The following table shows the properties of the PromotionActiveTimeRange object:

NameDescriptionRequiredValue
EffectiveFromDateDate (inclusive) when the promotion becomes active.YesType: string
EffectiveThroughDateDate (exclusive) when the promotion has ended.YesType: 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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

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.

NameDescriptionTypeRequired
accountIdThe merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the feed was submitted.stringYes
sellerIdThe 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.stringNo
feedIdThe identifier for the feed.stringYes
feedTypeThe feed type. For more information, refer to feedType values.stringYes
processingStatusThe processing status of the feed.stringYes
resultFeedDocumentIdThe identifier for the feed document. This identifier is unique only in combination with a seller ID.stringNo

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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

FulfillmentOrderStatusNotification

The following table shows the objects and properties of the FulfillmentOrderStatusNotification object:

NameDescription
EventType

Indicates whether the notification contains order, shipment, or return information.

EventType values:

Order - This notification contains information about a fulfillment order.

Shipment - This notification contains information about a fulfillment shipment. For more information, refer to the FulfillmentShipment object.

Return - This notification contains information about a fulfillment return.

Required

Type: string

SellerId

The identifier of the seller.

Type: string

StatusUpdatedDateTime

The date and time when the status was last updated. In ISO 8601 format.

Required

Type: string

SellerFulfillmentOrderId

The fulfillment order identifier that you created and submitted using the CreateFulfillmentOrder operation.

Required

Type: string

FulfillmentOrderStatus

The current status of the fulfillment order.


FulfillmentOrderStatus values:

  • Received - The fulfillment order was received and validated. Validation includes determining that the destination address is valid and that Amazon's records indicate that the seller has enough sellable (undamaged) inventory to fulfill the order. The seller can cancel a fulfillment order that has a status of Received.

  • Invalid - The fulfillment order was received but could not be validated. The reasons for this include an invalid destination address or Amazon's records indicating that the seller does not have enough sellable inventory to fulfill the order. When this happens, the fulfillment order is invalid and no items in the order will ship.

  • Planning - The fulfillment order has been sent to Amazon's fulfillment network to begin shipment planning, but no unit in any shipment has been picked from inventory yet. The seller can cancel a fulfillment order that has a status of Planning.

  • Processing - The process of picking units from inventory has begun on at least one shipment in the fulfillment order. The seller cannot cancel a fulfillment order that has a status of Processing.

  • Cancelled - The fulfillment order has been cancelled by the seller.

  • Complete - All item quantities in the fulfillment order have been fulfilled.

  • CompletePartialled - Some item quantities in the fulfillment order were fulfilled; the rest were either cancelled or unfulfillable.

  • Unfulfillable - No item quantities in the fulfillment order could be fulfilled because the Amazon fulfillment center workers found no inventory for those items or found no inventory that was in sellable (undamaged) condition.

Required


Type: string

FulfillmentShipment

Delivery and item information for a shipment in a fulfillment order.

Optional. Returned only when EventType is Shipment.

Type: FulfillmentShipment

FulfillmentReturnItem

Information about an item that was returned to an Amazon fulfillment center.

Optional. Returned only when EventType is Return.

Type: FulfillmentReturnItem

FulfillmentReturnItem

The following table shows the objects and properties of the FulfillmentReturnItem object:

NameDescription
ReceivedDateTime

The date and time when the returned item was received by the Amazon fulfillment center. In ISO 8601 date time format.

Required

Type: string

ReturnedQuantity

The quantity that was returned.

Required

Type: integer

SellerSKU

The seller SKU of the item.

Required

Type: string

FulfillmentShipment

The following table shows the objects and properties of the FulfillmentShipment object:

NameDescription
FulfillmentShipmentStatus

The current status of the shipment.


FulfillmentShipmentStatus values:

  • Pending - The process of picking units from inventory has begun.

  • Shipped - All packages in the shipment have left the fulfillment center.

  • CancelledByFulfiller - The Amazon fulfillment center could not fulfill the shipment as planned. This might be because the inventory was not at the expected location in the fulfillment center. After cancelling the fulfillment order, Amazon immediately creates a new fulfillment shipment and again attempts to fulfill the order.

  • CancelledBySeller - The shipment was cancelled using the CancelFulfillmentOrder operation.

Required


Type: string

AmazonShipmentId

A shipment identifier assigned by Amazon.

Required

Type: string

EstimatedArrivalDateTime

The estimated arrival time of the shipment, in ISO 8601 date time format. Note that this value can change over time. If a shipment includes more than one package, EstimatedArrivalDateTime applies to all of the packages in the shipment. If the shipment has been cancelled, EstimatedArrivalDateTime is not returned.

Required

Type: string

FulfillmentShipmentPackages

Contains all the packages in the fulfillment shipment.

Optional

Type: Array of FulfillmentShipmentPackage

FulfillmentShipmentPackage

The following table shows the objects and properties of the FulfillmentShipmentPackage object:

NameDescription
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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

ItemInventoryEventChangeNotifications

NameDescriptionRequiredType
itemInventoryEventChangeNotificationsA list of hourly grain inventory metrics by ASIN.YesArray of ItemInventoryEventChangeNotification

ItemInventoryEventChangeNotification

NameDescriptionRequiredType
accountIdThe merchant customer ID or vendor group ID of the partner account this notification is sent to.YesString
marketplaceIdThe Amazon store identifier of the inventory data.YesString
startTimeThe start of the date-time range of the inventory data ISO 8601 format in UTC time.YesString
endTimeThe end of the date-time range of the inventory data in ISO 8601 format in UTC time.YesString
asinThe Amazon Standard Identification Number of the product.YesString
highlyAvailableInventoryThe 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).YesInteger

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": {
   "itemInventoryEventChanges": [
     {
       "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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

ItemSalesEventNotifications

NameDescriptionRequiredType
itemSalesEventChangeNotificationsA list of hourly grain sales metrics by ASIN.YesArray of ItemSalesEventChangeNotification

ItemSalesEventChangeNotification

NameDescriptionRequiredType
accountIdThe merchant customer ID or vendor group ID of the partner account this notification is sent to.YesString
marketplaceIdThe Amazon store identifier of the sales data.YesString
currencyCodeThe currency code of any monetary amounts in ISO 4217 format.YesString
startTimeThe start of the date-time range of the sales data in ISO 8601 format in UTC time.YesString
endTimeThe end of the date-time range of the sales data in ISO 8601 format in UTC time.YesString
asinThe Amazon Standard Identification Number of the product.YesString
orderedUnitsThe number of units ordered by Amazon customers in the specified time frame. This number can be negative if there are more cancellations than orders.YesInteger
orderedRevenueThe ordered product sales in the specified time frame. Adjustments are made for cancellations.YesNumber

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": {
    "itemSalesEventChanges": [
      {
        "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

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 store.

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.

ObjectDescription
MarketplaceIdthe Amazon store that the item is listed in.
AsinThe ASIN of the item.
PreviousProductTypeThe previous product type.
CurrentProductTypeThe 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

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 store.

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.

NameDescriptionTypeRequired
SellerIDSelling partner identifier, such as a selling partner (merchant) account, of the affected listings item.stringYes
MarketplaceIdAmazon store identifier of the affected listings item.stringNo
AsinThe Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item.stringNo
SkuIdentifier of the affected listings item.stringYes
CreatedDateTimestamp of when the listings item was created, formatted as ISO 8601 date-time.stringNo
StatusList 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 ListingsItemStatusYes

ListingsItemStatus

This table shows the possible values for ListingsItemStatus:

NameDescription
BUYABLEIndicates the listings item is available for purchase on the Amazon retail website for the corresponding Amazon store. When provided, the listings item is buyable. When omitted, the listings item is non-buyable.
DISCOVERABLEIndicates the associated Amazon catalog item (ASIN) is discoverable in search results on the Amazon retail website for the corresponding Amazon store. When provided, the listings item is discoverable. When omitted, the listings item is non-discoverable.
DELETEDWhen 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

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 store.

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.

❗️

Important

You must subscribe or migrate to the newer version "2023-12-13". The "1.0" version will be deprecated soon.

For updates and defects, refer to the LISTINGS_ITEM_ISSUES_CHANGE page.

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.

NameDescriptionTypeRequired
SellerIdSelling partner identifier, such as a selling partner (merchant) account or vendor code, of the affected listings item.stringYes
MarketplaceIdAmazon store identifier of the affected listings item.stringNo
AsinThe Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item.stringNo
SkuIdentifier of the affected listings item.stringYes
SeveritiesList 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 IssueSeverityYes
EnforcementActionsList of enforcement actions taken by Amazon for the issues associated with the affected listings item. Current possible values:
  • LISTING_SUPPRESSED - This enforcement takes down the current listing item's buyability.

  • ATTRIBUTE_SUPPRESSED - An attribute's value on the listing item is invalid, which causes it to be rejected by Amazon.

  • CATALOG_ITEM_REMOVED - This catalog item is inactive on Amazon, and all offers against it in the applicable Amazon store are non-buyable.

  • SEARCH_SUPPRESSED - This value indicates that the catalog item is hidden from search results.

Array of stringNo

IssueSeverity

This table shows the possible values for IssueSeverity:

NameDescription
ERRORWhen provided, at least one issue with ERROR severity has occurred preventing the submission from processing, such as validation error.
WARNINGWhen provided, at least one issue with WARNING severity has occurred that should be reviewed, but has not prevented the submission from processing.
NONEWhen 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"
  }
}

[Deprecated soon]
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.

NameDescriptionTypeRequired
SellerIdSelling partner identifier, such as a selling partner (merchant) account or vendor code, of the affected listings item.stringYes
MarketplaceIdAmazon store identifier of the affected listings item.stringNo
AsinThe Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item.stringNo
SkuIdentifier of the affected listings item.stringYes
SeveritiesList 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 IssueSeverityYes
EnforcementActionsList of enforcement actions taken by Amazon for the issues associated with the affected listings item.Array of IssueEnforcementActionsNo

IssueSeverity

This table shows the possible values for IssueSeverity:

NameDescription
ERRORWhen provided, at least one issue with ERROR severity has occurred preventing the submission from processing, such as a validation error.
WARNINGWhen provided, at least one issue with WARNING severity has occurred that should be reviewed, but has not prevented the submission from processing.
NONEWhen provided, there are no defined issues affecting the listings item. However, there may be other problems with the listing.

IssueEnforcementActions

This table shows the possible values for IssueEnforcementActions:

NameDescription
SEARCH_SUPPRESSEDWhen 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

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.

NameDescriptionTypeRequired
SellerIdThe Merchant Token of the selling partner who owns the listings item.stringYes
FulfillmentChannelCodeThe Fulfillment channel code representing the MFN (seller-fulfilled) fulfillment program, network, or channel where the quantity is applicable.stringYes
SkuA selling partner provided identifier for an Amazon listings item.stringYes
QuantityThe number of units available at Amazon.integerYes

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

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 eventFilterType: "eventFilterType": "ORDER_CHANGE".

This notification also supports filterExpression for CEL-based filtering. You cannot use eventFilter and filterExpression together. For more information, refer to Filter notification subscriptions.

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.

NameDescriptionTypeRequired
NotificationLevelThe notification level of the current notification.stringYes
SellerIdThe selling partner identifier.stringYes
AmazonOrderIdAn Amazon-defined order identifier in 3-7-7 format.stringYes
OrderChangeTypeThe type of order change that triggered the notification to be sent. Possible values are:
  • BuyerRequestedChange
  • DeliveryTipChange
  • OrderStatusChange
stringYes
OrderChangeTriggerDetails about what caused this ORDER_CHANGE notification to be sent.OrderChangeReasonYes
SummaryInformation about the order and order items that had the change.OrderChangeSummaryYes

OrderChangeReason

NameDescriptionTypeRequired
TimeOfOrderChangeThe time of the change that caused this notification, in ISO 8601 date/time format. Will be null when there is no related timestamp.stringYes
ChangeReasonThe reason this ORDER_CHANGE notification was sent.stringYes

OrderChangeSummary

NameDescriptionTypeRequired
MarketplaceIDThe Amazon store identifier of the order.stringYes
OrderStatusThe current order status. The possible values are UpComing, Pending, Unshipped, PartiallyShipped, PendingAvailability, Canceled, InvoiceUnconfirmed, Shipped, and Unfulfillable.stringYes
PurchaseDateThe purchase date of the order, in ISO 8601 date/time format. It will be null when there is no related information.stringYes
DestinationPostalCodeThe destination postal code. It will be null when there is no related information.stringYes
FulfillmentTypeFulfillment type of the affected order, MFN or AFN.stringYes
OrderTypeThe type of the order.stringYes
NumberOfItemsShippedThe number of items shipped.integerNo
NumberOfItemsUnshippedThe number of items unshipped.integerNo
EarliestDeliveryDateThe 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.stringNo
LatestDeliveryDateThe 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.stringNo
EarliestShipDateThe start of the time period during which you committed to ship the order, in ISO 8601 date/time format.stringNo
LatestShipDateThe end of the time period during which you committed to ship the order, in ISO 8601 date/time format.stringNo
CancelNotifyDateThe end of the time period during which you must notify the seller of possible cancellation, in ISO 8601 date/time format.stringNo
OrderProgramsThe order programs in which this order participates.array of stringNo
ShippingProgramsThe shipping programs in which this order participates.array of stringNo
EasyShipShipmentStatusThe status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.stringNo
ElectronicInvoiceStatusThe status of the electronic invoice.stringNo
OrderItemsInformation 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 OrderItemYes

OrderItem

NameDescriptionTypeRequired
OrderItemIdThe Amazon-defined order item identifier.stringYes
SellerSKUThe seller-specific SKU for an item.stringYes
SupplySourceIdThe unique identifier of the supply source. Will be null when there is no related information.stringYes
OrderItemStatusThe current status of the order item. This field Will have a non-null value when items' statuses are different.stringNo
QuantityThe number of items in the order.integerYes
QuantityShippedThe number of items shipped.integerNo
IsBuyerRequestedCancelTrue when the buyer has requested cancelation.booleanNo
ItemEarliestDeliveryDateThe start of the time period during which you have committed to fulfill the order.stringNo
ItemLatestDeliveryDateThe end of the time period during which you have committed to fulfill the order.stringNo

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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

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.

NameDescription
issueTypeThe issue type for the notification.

Required.

Type: string

sellerIdThe seller identifier for the offer.

Required.

Type: string

offerChangeTriggerThe event that caused the notification to be sent.

Required.

Type: offerChangeTrigger

merchantOfferOffer details of the selling partner (merchant) receiving the notification.

Required.

Type: merchantOffer

summaryInformation about the item that had the offer change. The information in this summary applies to all conditions of the product.

Required.

Type: summary

buyBoxPrice

The following table shows the objects and properties of the buyBoxPrice object:

NameDescription
condition

Indicates the condition of the item.

Required.

Type: string

landedPrice

The listingPrice plus shipping.

Required.

Type: moneyType

listingPrice

The price of the item.

Required.

Type: moneyType

shipping

The shipping cost.

Required.

Type: moneyType

points

The number of Amazon Points offered with the purchase of an item.

Optional.

Type: points

merchantOffer

The following table shows the objects and properties of the merchantOffer object:

NameDescription
conditionIndicates the condition of the item.

Required.

Type: string

fulfillmentTypeIndicates whether the item is fulfilled by Amazon or by the seller.

Required.

Type: string

landedPriceThe listingPrice plus shipping.

Required.

Type: moneyType

listingPriceThe price of the item.

Required.

Type: moneyType

shippingThe shipping cost.

Required.

Type: string

pointsThe number of Amazon Points offered with the purchase of an item.

Optional.

Note: The Points object is only returned in Japan (JP).

Type: points

offerChangeTrigger

The following table shows the objects and properties of the offerChangeTrigger object:

NameDescription
marketplaceIdThe Amazon store identifier of the item that had an offer change.

Required.

Type: string

asinThe ASIN for the item that had an offer change.

Required.

Type: string

itemConditionThe condition of the item that had an offer change.

Required.

Type: string

timeOfOfferChangeThe update time for the offer that caused this notification.

Optional.

Type: string

offerCount

The following table shows the objects and properties of the offerCount object:

NameDescription
condition

Indicates the condition of the item.

Required.

Type: string

fulfillmentType

Indicates whether the item is fulfilled by Amazon or by the seller.

Required.

Type: string

offerCount

The total number of offers for the specified condition and fulfillment channel.

Required.

Type: integer

points

The following table shows the objects and properties of the points object:

NameDescription
pointsNumber

The number of Amazon Points offered with the purchase of an item.

Required.

Type: integer

referencePrice

The following table shows the objects and properties of the referencePrice object:

NameDescription
averageSellingPrice

The average selling price of the item.

Optional.

Type: moneyType

competitivePriceThreshold

The competitive price threshold from external competitors of Amazon.

Optional.

Type: moneyType

retailOfferPrice

The 14 day maximum of retail offer price.

Optional.

Type: moneyType

msrpPrice

The manufacturer suggested retail price for the ASIN.

Optional.

Type: moneyType

salesRank

The following table shows the objects and properties of the salesRank object:

NameDescription
productCategoryId

The product category for the rank.

Required.

Type: string

rank

The sales rank of the ASIN.

Required.

Type: integer

summary

The following table shows the objects and properties of the summary object:

NameDescription
numberOfOffers

A list that contains the total number of offers for the item for the given conditions and fulfillment channels.

Required.

Type: array of offerCount

buyBoxEligibleOffers

A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels.

Required.

Type: array of offerCount

buyBoxPrices

A list that contains the Buy Box price of the item for the given conditions.

Optional.

Type: array of buyBoxPrice

salesRankings

A list that contains the sales rankings of the ASIN in various product categories.

Optional.

Type: array of salesRank

referencePrice

A set of reference prices for the given ASIN.

Required.

Type: referencePrice

Notification schema: PricingHealthNotification.json

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

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 an Amazon store, 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.

NameDescriptionTypeRequired
AccountIdThe selling partner identifier, such as a selling partner (merchant) account or vendor group ID.stringYes
MarketplaceIdAmazon store identifier of the affected product type or product type version.stringNo
ProductTypeVersionVersion of the newly released Amazon product type definition.stringYes
NewProductTypesList of product types launched in an Amazon store.Array of stringNo

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

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.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

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.

NameDescriptionTypeRequired
accountIdThe merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the report was submitted.stringYes
sellerIdThe 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.stringNo
reportIdThe identifier of the report.stringYes
reportTypeThe report type. For more information, refer to reportType values.stringYes
processingStatusThe processing status of the report.stringYes
reportDocumentIdThe identifier for the report document. This identifier is unique only in combination with a seller ID.stringNo

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"
  }
}

SHIPMENT_TRACKING_MILESTONE_CHANGED

Sellers and vendors can subscribe to this notification.

The SHIPMENT_TRACKING_MILESTONE_CHANGED notification is sent when a tracking milestone changes for the subscribed shipment identifier.

This notification requires the following eventFilter value: trackingIdentifier. Refer to Subscribe to shipment tracking notifications for more information.

Payload schema: Version 2026-01-30

Workflow (select one):

The SHIPMENT_TRACKING_MILESTONE_CHANGED notification with PayloadVersion=2026-01-30 includes the following properties in the shipmentTrackingMilestoneChangedNotification object:

NameDescription
trackingDetailCurrent and historical tracking information for the shipment.

Required.

Type: TrackingDetail

TrackingDetail

The following table shows the properties of the TrackingDetail object:

NameDescription
identifierThe tracking identifier used to look up this shipment (for example, id, acsin, or containerNumber).

Required.

Type: TrackingIdentifier

trackingUrlThe URL to view the shipment's tracking information.

Optional.

Type: string

trackingEstimatesA list of time-based estimated intervals for the shipment, such as estimated delivery date.

Optional.

Type: Array of TrackingEstimate

latestMilestoneThe most recent milestone event for the shipment.

Optional.

Type: TrackingMilestone

milestoneHistoryA chronological list of all milestone events for the shipment, from most recent to oldest.

Required.

Type: Array of TrackingMilestone

TrackingIdentifier

The following table shows the properties of the TrackingIdentifier object:

NameDescription
idA unique identifier generated by Amazon for the shipment tracking request.

Optional.

Type: string

acsinThe Air Cargo Shipment Identification Number.

Optional.

Type: string

aftnThe Amazon Fulfillment Tracking Number.

Optional.

Type: string

containerNumberThe container number provided by the Logistics Service Provider.

Optional.

Type: string

houseBillOfLadingNumberThe House Bill of Lading (HBL) number.

Optional.

Type: string

carrierTrackingThe carrier-assigned tracking information.

Optional.

Type: CarrierTracking

CarrierTracking

The following table shows the properties of the CarrierTracking object:

NameDescription
trackingNumberThe tracking number assigned by the carrier.

Required.

Type: string

carrierCodeThe carrier code associated with the carrier tracking number.

Optional.

Type: string

TrackingEstimate

The following table shows the properties of the TrackingEstimate object:

NameDescription
typeThe type of estimate. For example, ESTIMATED_DELIVERY_DATE or ESTIMATED_TIME_OF_DEPARTURE.

Required.

Type: string

estimatedIntervalThe estimated time window for this event, represented as a start and end time in UTC RFC 3339 date-time format.

Required.

Type: BoundedInterval

lastUpdatedTimeThe timestamp when this estimate was last modified, in UTC RFC 3339 date-time format.

Required.

Type: string

BoundedInterval

The following table shows the properties of the BoundedInterval object:

NameDescription
startTimeThe inclusive start of the interval, in UTC RFC 3339 date-time format.

Required.

Type: string

endTimeThe inclusive end of the interval, in UTC RFC 3339 date-time format. Must not precede startTime.

Required.

Type: string

TrackingMilestone

The following table shows the properties of the TrackingMilestone object:

NameDescription
statusThe milestone's status details.

Required.

Type: TrackingMilestoneStatus

locationThe location where this milestone occurred, if available. Contains an address with city, region, and country code.

Optional.

Type: TrackingMilestoneLocation

occurredAtThe timestamp when this milestone occurred, in UTC RFC 3339 date-time format.

Required.

Type: string

TrackingMilestoneStatus

The following table shows the properties of the TrackingMilestoneStatus object:

NameDescription
codeA status code that identifies the milestone event (for example, DELIVERED, CUSTOMS_CLEARED, DEPARTED).

Required.

Type: string

subCodeStatus subcode that provides additional details about the milestone status. Valid values vary by milestone (for example, a DELIVERED milestone might include a subCode for the delivery location).

Optional.

Type: string

descriptionA human-readable explanation of the milestone event.

Required.

Type: string

TrackingMilestoneLocation

The following table shows the properties of the TrackingMilestoneLocation object:

NameDescription
addressThe physical address where the milestone occurred.

Optional.

Type: TrackingMilestoneAddress

TrackingMilestoneAddress

The following table shows the properties of the TrackingMilestoneAddress object:

NameDescription
cityThe city where the milestone occurred.

Optional.

Type: string

regionThe state or region where the milestone occurred.

Optional.

Type: string

countryCodeThe two-character country code in ISO 3166-1 alpha-2 format (for example, US).

Optional.

Type: string

Notification schema: ShipmentTrackingMilestoneChangedNotification.json

Notification example:

{
  "notificationVersion": "1.0",
  "notificationType": "SHIPMENT_TRACKING_MILESTONE_CHANGED",
  "payloadVersion": "2026-01-30",
  "eventTime": "2025-08-08T12:45:48.501Z",
  "notificationMetadata": {
    "applicationId": "amzn1.sellerapps.app.g2134566-aaec-55a6-b123-bcb752069ba4",
    "subscriptionId": "7b28cc50-95c8-4641-add7-10af4b1fecd8",
    "publishTime": "2025-08-08T12:47:50.501Z",
    "notificationId": "6712e8e5-b365-4cb1-9fd8-be9dfc6d5bda"
  },
  "payload": {
    "shipmentTrackingMilestoneChangedNotification": {
      "trackingDetail": {
        "identifier": {
          "aftn": "AFTN987654321"
        },
        "latestMilestone": {
          "status": {
            "code": "DELIVERED",
            "subCode": "PORCH",
            "description": "Shipment delivered to porch"
          },
          "location": {
            "address": {
              "city": "Austin",
              "region": "Texas",
              "countryCode": "US"
            }
          },
          "occurredAt": "2026-06-14T01:26:56Z"
        },
        "milestoneHistory": [
          {
            "status": {
              "code": "DELIVERED",
              "subCode": "PORCH",
              "description": "Shipment delivered to porch"
            },
            "location": {
              "address": {
                "city": "Austin",
                "region": "Texas",
                "countryCode": "US"
              }
            },
            "occurredAt": "2026-06-14T01:26:56Z"
          },
          {
            "status": {
              "code": "OUT_FOR_DELIVERY",
              "description": "Shipment is out for delivery"
            },
            "location": {
              "address": {
                "city": "Buda",
                "region": "Texas",
                "countryCode": "US"
              }
            },
            "occurredAt": "2026-06-13T16:20:51Z"
          },
          {
            "status": {
              "code": "SHIPPED",
              "description": "Shipment has departed origin"
            },
            "occurredAt": "2026-06-13T05:21:43Z"
          },
          {
            "status": {
              "code": "CARRIER_ASSIGNED",
              "description": "Carrier was assigned"
            },
            "occurredAt": "2026-06-13T04:41:37Z"
          },
          {
            "status": {
              "code": "ORDER_PREPARING",
              "description": "Order is preparing to ship"
            },
            "occurredAt": "2026-06-12T19:43:40Z"
          }
        ],
        "trackingEstimates": [
          {
            "type": "ESTIMATED_DELIVERY_DATE",
            "estimatedInterval": {
              "startTime": "2026-06-14T03:00:00Z",
              "endTime": "2026-06-14T03:00:00Z"
            },
            "lastUpdatedTime": "2026-06-13T05:21:43Z"
          }
        ],
        "trackingUrl": "https://www.swiship.com/track?id=AFTN987654321"
      }
    }
  }
}

TRANSACTION_UPDATE

Sellers can subscribe to this notification.

The TRANSACTION_UPDATE notification is sent whenever there is a new transaction posted to the seller's account.

📘

Note

This notification supports filterExpression for CEL-based filtering. For more information, refer to Filter notification subscriptions.

Payload schema: Version 1.0

Workflow: Amazon Simple Queue Service workflow

The TRANSACTION_UPDATE notification with payloadVersion=1.0 includes the following properties in the TransactionUpdateNotification payload object:

NameDescriptionType
SellingPartnerMetadataMetadata that describes the seller.SellingPartnerMetadata
RelatedIdentifiersIdentifiers related to the transaction, such as order and shipment IDs.< RelatedIdentifier > array
TransactionTypeThe type of transaction.string
PostedDateThe date and time when the transaction was posted.Date
TotalAmountThe total amount of money in the transaction.Currency

SellingPartnerMetadata

NameDescriptionType
SellingPartnerIdA unique seller identifier.string
AccountTypeThe type of account in the transaction.string
MarketplaceIdThe identifier of the Amazon store where the transaction occurred.string

RelatedIdentifier

NameDescriptionType
RelatedIdentifierNameAn enumerated set of related business identifier names.string
RelatedIdentifierValueCorresponding value of RelatedIdentifierNamestring

Currency

NameDescriptionType
CurrencyAmountThe monetary value.int
CurrencyCodeThe three-digit currency code in ISO 4217 format.string

Notification schema: TransactionUpdateNotification.json

Notification example:

{
  "NotificationVersion": "1.0",
  "NotificationType": "TRANSACTION_UPDATE",
  "PayloadVersion": "1.0",
  "EventTime": "2023-07-14T03:35:13.214Z",
  "NotificationMetadata": {
    "ApplicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
    "SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
    "PublishTime": "2020-07-14T03:35:13.214Z",
    "NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
  },
  "Payload": {
    "TransactionUpdateNotification": {
      "SellingPartnerMetadata": {
        "SellingPartnerId": "A3TH9S8BH6GOGM",
        "MarketplaceId": "ATIV93840DER",
        "AccountType": "PAYABLE"
      },
      "RelatedIdentifiers": [
        {
          "RelatedIdentifierName": "OrderId",
          "RelatedIdentifierValue": "8129762527551"
        }
      ],
      "TransactionType": "Shipment",
      "PostedDate": "2020-07-14T03:35:13.214Z",
      "TotalAmount": {
        "CurrencyAmount": 10,
        "CurrencyCode": "USD"
      }
    }
  }
}

Common types

Contains common types that are used by all notifications that are contained in the Notification payload objects.

FulfillmentChannelType

Indicates whether the item is fulfilled by Amazon or by the seller.

Type: string

FulfillmentChannelType values:

  • Amazon

  • Merchant

moneyType

Currency type and amount.

The following table shows the properties of the MoneyType object:

NameDescription
amount

The currency amount.

Type: number

currencyCode

Three-digit currency code. In ISO 4217 format.

Type: string

MoneyType

Currency type and amount.

The following table shows the properties of the MoneyType object:

NameDescription
Amount

The currency amount.

Type: number

CurrencyCode

Three-digit currency code. In ISO 4217 format.

Type: string


Did this page help you?