Variable pricingHealthNotificationConst

Type declaration

• Readonly$ref: "#/definitions/notificationResponse"

• Readonlydefinitions: {
      averageSellingPrice: {
          $ref: "#/definitions/moneyType";
          description: "The average selling price of the item";
      };
      buyBoxPrice: {
          properties: {
              condition: { $ref: "#/definitions/condition" };
              landedPrice: { $ref: "#/definitions/landedPrice" };
              listingPrice: { $ref: "#/definitions/listingPrice" };
              points: { $ref: "#/definitions/points" };
              shipping: { $ref: "#/definitions/shipping" };
          };
          required: readonly [
              "condition",
              "landedPrice",
              "shipping",
              "listingPrice",
          ];
          type: "object";
      };
      competitivePriceThreshold: {
          $ref: "#/definitions/moneyType";
          description: "The competitive price threshold from external competitors of Amazon";
      };
      condition: {
          description: "Indicates the condition of the item";
          type: "string";
      };
      fulfillmentType: {
          description: "Indicates whether the item is fulfilled by Amazon or by the seller";
          enum: readonly ["AFN", "MFN"];
          type: "string";
      };
      landedPrice: {
          $ref: "#/definitions/moneyType";
          description: "ListingPrice + Shipping";
      };
      listingPrice: {
          $ref: "#/definitions/moneyType";
          description: "The price of the item";
      };
      merchantOffer: {
          description: "Offer details of the merchant receiving the notification";
          properties: {
              condition: { $ref: "#/definitions/condition" };
              fulfillmentType: { $ref: "#/definitions/fulfillmentType" };
              landedPrice: { $ref: "#/definitions/landedPrice" };
              listingPrice: { $ref: "#/definitions/listingPrice" };
              points: { $ref: "#/definitions/points" };
              shipping: { $ref: "#/definitions/shipping" };
          };
          required: readonly [
              "condition",
              "fulfillmentType",
              "landedPrice",
              "shipping",
              "listingPrice",
          ];
          type: "object";
      };
      moneyType: {
          properties: {
              amount: { type: "number" };
              currencyCode: { type: "string" };
          };
          required: readonly ["amount", "currencyCode"];
          type: "object";
      };
      msrpPrice: {
          $ref: "#/definitions/moneyType";
          description: "The manufacturer suggested retail price for the ASIN";
      };
      notificationMetadata: {
          properties: {
              applicationId: {
                  description: "The identifier for the application that uses the notifications";
                  type: "string";
              };
              notificationId: {
                  description: "A unique identifier for this notification instance";
                  type: "string";
              };
              publishTime: {
                  description: "The date and time (in UTC) that the notification was sent";
                  type: "string";
              };
              subscriptionId: {
                  description: "A unique identifier for the subscription which resulted in this notification";
                  type: "string";
              };
          };
          required: readonly [
              "applicationId",
              "subscriptionId",
              "publishTime",
              "notificationId",
          ];
          type: "object";
      };
      notificationResponse: {
          properties: {
              eventTime: {
                  description: "The date and time (in UTC) that the event which triggered the notification occurred";
                  type: "string";
              };
              notificationMetadata: { $ref: "#/definitions/notificationMetadata" };
              notificationType: {
                  description: "The notification type. Combined with payload version controls the structure of payload object";
                  type: "string";
              };
              notificationVersion: {
                  description: "The notification version. This controls the structure of the notification";
                  type: "string";
              };
              payload: { $ref: "#/definitions/payload" };
              payloadVersion: {
                  description: "The payload version. Combined with notification type controls the structure of payload";
                  type: "string";
              };
          };
          required: readonly [
              "notificationVersion",
              "notificationType",
              "payloadVersion",
              "eventTime",
              "payload",
              "notificationMetadata",
          ];
          type: "object";
      };
      offerChangeTrigger: {
          description: "The event that caused the notification to be sent";
          properties: {
              asin: {
                  description: "The asin for the item that had an offer change";
                  type: "string";
              };
              itemCondition: {
                  description: "The condition of the item that had an offer change";
                  type: "string";
              };
              marketplaceId: {
                  description: "The marketplace identifier of the item that had an offer change";
                  type: "string";
              };
              timeOfOfferChange: {
                  description: "The update time for the offer that caused this notification";
                  type: "string";
              };
          };
          required: readonly [
              "marketplaceId",
              "asin",
              "itemCondition",
              "timeOfOfferChange",
          ];
          type: "object";
      };
      offerCount: {
          properties: {
              condition: { $ref: "#/definitions/condition" };
              fulfillmentType: { $ref: "#/definitions/fulfillmentType" };
              offerCount: {
                  description: "The total number of offers for the specified condition and fulfillment channel";
                  type: "integer";
              };
          };
          required: readonly ["condition", "fulfillmentType", "offerCount"];
          type: "object";
      };
      payload: {
          properties: {
              issueType: {
                  description: "The issue type for the notification";
                  type: "string";
              };
              merchantOffer: { $ref: "#/definitions/merchantOffer" };
              offerChangeTrigger: { $ref: "#/definitions/offerChangeTrigger" };
              sellerId: {
                  description: "The seller identifier for the offer";
                  type: "string";
              };
              summary: { $ref: "#/definitions/summary" };
          };
          required: readonly [
              "issueType",
              "sellerId",
              "offerChangeTrigger",
              "merchantOffer",
              "summary",
          ];
          type: "object";
      };
      points: {
          description: "The number of Amazon Points offered with the purchase of an item";
          properties: {
              pointsNumber: {
                  description: "The number of Amazon Points offered with the purchase of an item";
                  type: "integer";
              };
          };
          required: readonly ["pointsNumber"];
          type: "object";
      };
      referencePrice: {
          description: "A set of reference prices for the given ASIN";
          properties: {
              averageSellingPrice: { $ref: "#/definitions/averageSellingPrice" };
              competitivePriceThreshold: {
                  $ref: "#/definitions/competitivePriceThreshold";
              };
              msrpPrice: { $ref: "#/definitions/msrpPrice" };
              retailOfferPrice: { $ref: "#/definitions/retailOfferPrice" };
          };
          type: "object";
      };
      retailOfferPrice: {
          $ref: "#/definitions/moneyType";
          description: "The 14 day maximum of retail offer price";
      };
      salesRank: {
          properties: {
              productCategoryId: {
                  description: "The product category for the rank";
                  type: "string";
              };
              rank: { description: "The sales rank of the ASIN"; type: "integer" };
          };
          required: readonly ["productCategoryId", "rank"];
          type: "object";
      };
      shipping: {
          $ref: "#/definitions/moneyType";
          description: "The shipping cost";
      };
      summary: {
          properties: {
              buyBoxEligibleOffers: {
                  additionalItems: true;
                  description: "A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels";
                  items: readonly [{ $ref: "#/definitions/offerCount" }];
                  type: "array";
              };
              buyBoxPrices: {
                  additionalItems: true;
                  description: "A list that contains the Buy Box price of the item for the given conditions";
                  items: readonly [{ $ref: "#/definitions/buyBoxPrice" }];
                  type: "array";
              };
              numberOfOffers: {
                  additionalItems: true;
                  description: "A list that contains the total number of offers for the item for the given conditions and fulfillment channels";
                  items: readonly [{ $ref: "#/definitions/offerCount" }];
                  type: "array";
              };
              referencePrice: { $ref: "#/definitions/referencePrice" };
              salesRankings: {
                  additionalItems: true;
                  description: "A list that contains the sales rankings of the asin in various product categories";
                  items: readonly [{ $ref: "#/definitions/salesRank" }];
                  type: "array";
              };
          };
          required: readonly [
              "numberOfOffers",
              "buyBoxEligibleOffers",
              "referencePrice",
          ];
          type: "object";
      };
  }

• Readonlydescription: "The notification response schema that comprises the entire JSON document for PRICING_HEALTH notification"

• Readonlyexamples: readonly [
      {
          eventTime: "2020-09-23T21:30:13.713Z";
          notificationMetadata: {
              applicationId: "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a";
              notificationId: "23ae41cd-3537-4676-af46-6ee9abf8802e";
              publishTime: "2020-09-23T21:30:16.903Z";
              subscriptionId: "e3a059ca-677a-442a-8d39-05b2848971b6";
          };
          notificationType: "PRICING_HEALTH";
          notificationVersion: "1.0";
          payload: {
              issueType: "BuyBoxDisqualification";
              merchantOffer: {
                  condition: "new";
                  fulfillmentType: "MFN";
                  landedPrice: { amount: 8188.72; currencyCode: "USD" };
                  listingPrice: { amount: 8184.23; currencyCode: "USD" };
                  points: { pointsNumber: 34343 };
                  shipping: { amount: 4.49; currencyCode: "USD" };
              };
              offerChangeTrigger: {
                  asin: "B007IBIWZY";
                  itemCondition: "new";
                  marketplaceId: "ATVPDKIKX0DER";
                  timeOfOfferChange: "2020-09-23T21:30:13.409Z";
              };
              sellerId: "A3EZFOFNDPFB8R";
              summary: {
                  buyBoxEligibleOffers: readonly [
                      { condition: "new"; fulfillmentType: "MFN"; offerCount: 3 },
                  ];
                  buyBoxPrices: readonly [
                      {
                          condition: "new";
                          landedPrice: { amount: 8188.72; currencyCode: "USD" };
                          listingPrice: { amount: 8184.23; currencyCode: "USD" };
                          points: { pointsNumber: 34343 };
                          shipping: { amount: 4.49; currencyCode: "USD" };
                      },
                  ];
                  numberOfOffers: readonly [
                      { condition: "new"; fulfillmentType: "MFN"; offerCount: 3 },
                  ];
                  referencePrice: {
                      averageSellingPrice: { amount: 7500; currencyCode: "USD" };
                      competitivePriceThreshold: { amount: 8000; currencyCode: "USD" };
                      msrpPrice: { amount: 7900; currencyCode: "USD" };
                      retailOfferPrice: { amount: 8000; currencyCode: "USD" };
                  };
                  salesRankings: readonly [
                      {
                          productCategoryId: "lawn_and_garden_display_on_website";
                          rank: 4013;
                      },
                      { productCategoryId: "home_garden_display_on_website"; rank: 17316 },
                  ];
              };
          };
          payloadVersion: "1.0";
      },
  ]

• Readonlytype: "object"