b2bAnyOfferChangedNotification: {
    "#ref": "#/definitions/notificationResponse";
    definitions: {
        b2bAnyOfferChangedNotification: {
            additionalProperties: true;
            properties: {
                offerChangeTrigger: { $ref: "#/definitions/offerChangeTrigger" };
                offers: {
                    additionalItems: true;
                    description: "The top 20 competitive B2B offers for the item and condition that triggered the notification.";
                    items: readonly [{ $ref: "#/definitions/offer" }];
                    type: "array";
                };
                sellerId: {
                    description: "The seller identifier for the offer.";
                    type: "string";
                };
                summary: { $ref: "#/definitions/summary" };
            };
            required: readonly [
                "sellerId",
                "offerChangeTrigger",
                "summary",
                "offers",
            ];
            type: "object";
        };
        buyBoxPrice: {
            additionalProperties: true;
            properties: {
                condition: { $ref: "#/definitions/condition" };
                discountType: { $ref: "#/definitions/discountType" };
                landedPrice: { $ref: "#/definitions/landedPrice" };
                listingPrice: { $ref: "#/definitions/listingPrice" };
                offerType: { $ref: "#/definitions/offerType" };
                quantityTier: { $ref: "#/definitions/quantityTier" };
                sellerId: {
                    description: "The seller identifier for the offer.";
                    type: "string";
                };
                shipping: { $ref: "#/definitions/shipping" };
            };
            required: readonly [
                "condition",
                "offerType",
                "quantityTier",
                "listingPrice",
            ];
            type: "object";
        };
        condition: { description: "The condition of the item."; type: "string" };
        discountType: {
            description: "Indicates whether the quantity tier is for Quantity Discount or Progressive Discount.";
            type: "string";
        };
        fulfillmentChannel: {
            description: "Indicates whether the item is fulfilled by Amazon or by the seller.";
            type: "string";
        };
        landedPrice: {
            $ref: "#/definitions/moneyType";
            description: "The price of the item plus the shipping cost.";
        };
        listingPrice: {
            $ref: "#/definitions/moneyType";
            description: "The price of the item.";
        };
        lowestPrice: {
            additionalProperties: true;
            properties: {
                condition: { $ref: "#/definitions/condition" };
                discountType: { $ref: "#/definitions/discountType" };
                fulfillmentChannel: { $ref: "#/definitions/fulfillmentChannel" };
                landedPrice: { $ref: "#/definitions/landedPrice" };
                listingPrice: { $ref: "#/definitions/listingPrice" };
                offerType: { $ref: "#/definitions/offerType" };
                quantityTier: { $ref: "#/definitions/quantityTier" };
                shipping: { $ref: "#/definitions/shipping" };
            };
            required: readonly [
                "condition",
                "fulfillmentChannel",
                "offerType",
                "quantityTier",
                "listingPrice",
            ];
            type: "object";
        };
        moneyType: {
            additionalProperties: true;
            properties: {
                amount: { type: "number" };
                currencyCode: { type: "string" };
            };
            required: readonly ["amount", "currencyCode"];
            type: "object";
        };
        notificationMetadata: {
            additionalProperties: true;
            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 ISO 8601 format in UTC time 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: {
            additionalProperties: true;
            properties: {
                eventTime: {
                    description: "The date and time in ISO 8601 format in UTC time that the event which triggered the notification occurred.";
                    type: "string";
                };
                notificationMetadata: { $ref: "#/definitions/notificationMetadata" };
                notificationType: {
                    description: "The notification type. Combined with the payload version this controls the structure of the 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 the notification type this controls the structure of the payload object.";
                    type: "string";
                };
            };
            required: readonly [
                "notificationVersion",
                "notificationType",
                "payloadVersion",
                "eventTime",
                "notificationMetadata",
                "payload",
            ];
            type: "object";
        };
        offer: {
            additionalProperties: true;
            properties: {
                conditionNotes: {
                    description: "Information about the condition of the item.";
                    type: "string";
                };
                isBuyBoxWinner: {
                    description: "True when 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.";
                    type: "boolean";
                };
                isFeaturedMerchant: {
                    description: "True when the seller of the item is eligible to win the Buy Box.";
                    type: "boolean";
                };
                isFulfilledByAmazon: {
                    description: "True when fulfilled by Amazon.";
                    type: "boolean";
                };
                listingPrice: { $ref: "#/definitions/listingPrice" };
                quantityDiscountPrice: {
                    description: "Contains a list of pricing information that includes special pricing when buying in bulk.";
                    items: { $ref: "#/definitions/QuantityDiscountPriceType" };
                    type: "array";
                };
                sellerFeedbackRating: { $ref: "#/definitions/sellerFeedbackRating" };
                sellerId: {
                    description: "The seller identifier for the offer.";
                    type: "string";
                };
                shipping: { $ref: "#/definitions/shipping" };
                shippingTime: { $ref: "#/definitions/shippingTime" };
                shipsFrom: { $ref: "#/definitions/shipsFrom" };
                subCondition: {
                    description: "The subcondition of the item.";
                    type: "string";
                };
            };
            required: readonly [
                "sellerId",
                "subCondition",
                "shippingTime",
                "listingPrice",
                "shipping",
                "isFulfilledByAmazon",
            ];
            type: "object";
        };
        offerChangeTrigger: {
            additionalProperties: true;
            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: {
            additionalProperties: true;
            properties: {
                condition: { $ref: "#/definitions/condition" };
                fulfillmentChannel: { $ref: "#/definitions/fulfillmentChannel" };
                offerCount: {
                    description: "The total number of offers for the specified condition and fulfillment channel.";
                    type: "integer";
                };
            };
            required: readonly ["condition", "fulfillmentChannel", "offerCount"];
            type: "object";
        };
        offerType: {
            description: "Indicates whether the offer is a B2B offer or a B2C offer.";
            type: "string";
        };
        payload: {
            additionalProperties: true;
            properties: {
                b2bAnyOfferChangedNotification: {
                    $ref: "#/definitions/b2bAnyOfferChangedNotification";
                };
            };
            required: readonly ["b2bAnyOfferChangedNotification"];
            type: "object";
        };
        primeInformation: {
            additionalProperties: true;
            properties: {
                isOfferNationalPrime: {
                    description: "Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed.";
                    type: "boolean";
                };
                isOfferPrime: {
                    description: "Indicates whether the offer is an Amazon Prime offer.";
                    type: "boolean";
                };
            };
            required: readonly ["isOfferPrime", "isOfferNationalPrime"];
            type: "object";
        };
        QuantityDiscountPriceType: {
            description: "Contains pricing information that includes special pricing when buying in bulk.";
            properties: {
                listingPrice: {
                    $ref: "#/definitions/MoneyType";
                    description: "The price at this quantity tier.";
                };
                quantityDiscountType: {
                    $ref: "#/definitions/QuantityDiscountType";
                    description: "Indicates the type of quantity discount this price applies to.";
                };
                quantityTier: {
                    description: "Indicates at what quantity this price becomes active.";
                    format: "int32";
                    type: "integer";
                };
            };
            required: readonly [
                "listingPrice",
                "quantityDiscountType",
                "quantityTier",
            ];
            type: "object";
        };
        QuantityDiscountType: {
            enum: readonly ["QUANTITY_DISCOUNT"];
            type: "string";
            "x-docgen-enum-table-extension": readonly [
                { description: "A Quantity Discount."; value: "QUANTITY_DISCOUNT" },
            ];
        };
        quantityTier: {
            description: "The quantity tier for the offer";
            type: "integer";
        };
        sellerFeedbackRating: {
            additionalProperties: true;
            properties: {
                feedbackCount: {
                    description: "The count of feedback received about the seller.";
                    type: "integer";
                };
                sellerPositiveFeedbackRating: {
                    description: "The percentage of positive feedback for the seller in the past 365 days.";
                    type: "number";
                };
            };
            required: readonly ["feedbackCount", "sellerPositiveFeedbackRating"];
            type: "object";
        };
        shipping: {
            $ref: "#/definitions/moneyType";
            description: "The shipping cost.";
        };
        shippingTime: {
            additionalProperties: true;
            properties: {
                availabilityType: {
                    description: "Indicates whether the item is available for shipping now, or on a known or unknown date in the future.";
                    type: "string";
                };
                availableDate: {
                    description: "The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping.";
                    type: "string";
                };
                maximumHours: {
                    description: "The maximum time, in hours, that the item will likely be shipped after the order has been placed.";
                    type: "integer";
                };
                minimumHours: {
                    description: "The minimum time, in hours, that the item will likely be shipped after the order has been placed.";
                    type: "integer";
                };
            };
            type: "object";
        };
        shipsFrom: {
            additionalProperties: true;
            properties: { country: { type: "string" } };
            required: readonly ["country"];
            type: "object";
        };
        summary: {
            additionalProperties: true;
            properties: {
                buyBoxEligibleOffers: {
                    additionalItems: true;
                    description: "A list that contains the total number of B2B 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, quantity tiers, and discount types.";
                    items: readonly [{ $ref: "#/definitions/buyBoxPrice" }];
                    type: "array";
                };
                lowestPrices: {
                    additionalItems: true;
                    description: "A list that contains the lowest prices of the item for the given conditions, fulfillment channels, quantity tiers, and discount types.";
                    items: readonly [{ $ref: "#/definitions/lowestPrice" }];
                    type: "array";
                };
                numberOfOffers: {
                    additionalItems: true;
                    description: "A list that contains the total number of B2B offers for the item for the given conditions and fulfillment channels.";
                    items: readonly [{ $ref: "#/definitions/offerCount" }];
                    type: "array";
                };
            };
            required: readonly [
                "numberOfOffers",
                "buyBoxEligibleOffers",
                "lowestPrices",
                "buyBoxPrices",
            ];
            type: "object";
        };
    };
    description: "The notification response schema that comprises the entire JSON document for B2B_ANY_OFFER_CHANGED notification.";
    type: "object";
} = ...

Type declaration

  • Readonly#ref: "#/definitions/notificationResponse"
  • Readonlydefinitions: {
        b2bAnyOfferChangedNotification: {
            additionalProperties: true;
            properties: {
                offerChangeTrigger: { $ref: "#/definitions/offerChangeTrigger" };
                offers: {
                    additionalItems: true;
                    description: "The top 20 competitive B2B offers for the item and condition that triggered the notification.";
                    items: readonly [{ $ref: "#/definitions/offer" }];
                    type: "array";
                };
                sellerId: {
                    description: "The seller identifier for the offer.";
                    type: "string";
                };
                summary: { $ref: "#/definitions/summary" };
            };
            required: readonly ["sellerId", "offerChangeTrigger", "summary", "offers"];
            type: "object";
        };
        buyBoxPrice: {
            additionalProperties: true;
            properties: {
                condition: { $ref: "#/definitions/condition" };
                discountType: { $ref: "#/definitions/discountType" };
                landedPrice: { $ref: "#/definitions/landedPrice" };
                listingPrice: { $ref: "#/definitions/listingPrice" };
                offerType: { $ref: "#/definitions/offerType" };
                quantityTier: { $ref: "#/definitions/quantityTier" };
                sellerId: {
                    description: "The seller identifier for the offer.";
                    type: "string";
                };
                shipping: { $ref: "#/definitions/shipping" };
            };
            required: readonly [
                "condition",
                "offerType",
                "quantityTier",
                "listingPrice",
            ];
            type: "object";
        };
        condition: { description: "The condition of the item."; type: "string" };
        discountType: {
            description: "Indicates whether the quantity tier is for Quantity Discount or Progressive Discount.";
            type: "string";
        };
        fulfillmentChannel: {
            description: "Indicates whether the item is fulfilled by Amazon or by the seller.";
            type: "string";
        };
        landedPrice: {
            $ref: "#/definitions/moneyType";
            description: "The price of the item plus the shipping cost.";
        };
        listingPrice: {
            $ref: "#/definitions/moneyType";
            description: "The price of the item.";
        };
        lowestPrice: {
            additionalProperties: true;
            properties: {
                condition: { $ref: "#/definitions/condition" };
                discountType: { $ref: "#/definitions/discountType" };
                fulfillmentChannel: { $ref: "#/definitions/fulfillmentChannel" };
                landedPrice: { $ref: "#/definitions/landedPrice" };
                listingPrice: { $ref: "#/definitions/listingPrice" };
                offerType: { $ref: "#/definitions/offerType" };
                quantityTier: { $ref: "#/definitions/quantityTier" };
                shipping: { $ref: "#/definitions/shipping" };
            };
            required: readonly [
                "condition",
                "fulfillmentChannel",
                "offerType",
                "quantityTier",
                "listingPrice",
            ];
            type: "object";
        };
        moneyType: {
            additionalProperties: true;
            properties: {
                amount: { type: "number" };
                currencyCode: { type: "string" };
            };
            required: readonly ["amount", "currencyCode"];
            type: "object";
        };
        notificationMetadata: {
            additionalProperties: true;
            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 ISO 8601 format in UTC time 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: {
            additionalProperties: true;
            properties: {
                eventTime: {
                    description: "The date and time in ISO 8601 format in UTC time that the event which triggered the notification occurred.";
                    type: "string";
                };
                notificationMetadata: { $ref: "#/definitions/notificationMetadata" };
                notificationType: {
                    description: "The notification type. Combined with the payload version this controls the structure of the 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 the notification type this controls the structure of the payload object.";
                    type: "string";
                };
            };
            required: readonly [
                "notificationVersion",
                "notificationType",
                "payloadVersion",
                "eventTime",
                "notificationMetadata",
                "payload",
            ];
            type: "object";
        };
        offer: {
            additionalProperties: true;
            properties: {
                conditionNotes: {
                    description: "Information about the condition of the item.";
                    type: "string";
                };
                isBuyBoxWinner: {
                    description: "True when 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.";
                    type: "boolean";
                };
                isFeaturedMerchant: {
                    description: "True when the seller of the item is eligible to win the Buy Box.";
                    type: "boolean";
                };
                isFulfilledByAmazon: {
                    description: "True when fulfilled by Amazon.";
                    type: "boolean";
                };
                listingPrice: { $ref: "#/definitions/listingPrice" };
                quantityDiscountPrice: {
                    description: "Contains a list of pricing information that includes special pricing when buying in bulk.";
                    items: { $ref: "#/definitions/QuantityDiscountPriceType" };
                    type: "array";
                };
                sellerFeedbackRating: { $ref: "#/definitions/sellerFeedbackRating" };
                sellerId: {
                    description: "The seller identifier for the offer.";
                    type: "string";
                };
                shipping: { $ref: "#/definitions/shipping" };
                shippingTime: { $ref: "#/definitions/shippingTime" };
                shipsFrom: { $ref: "#/definitions/shipsFrom" };
                subCondition: {
                    description: "The subcondition of the item.";
                    type: "string";
                };
            };
            required: readonly [
                "sellerId",
                "subCondition",
                "shippingTime",
                "listingPrice",
                "shipping",
                "isFulfilledByAmazon",
            ];
            type: "object";
        };
        offerChangeTrigger: {
            additionalProperties: true;
            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: {
            additionalProperties: true;
            properties: {
                condition: { $ref: "#/definitions/condition" };
                fulfillmentChannel: { $ref: "#/definitions/fulfillmentChannel" };
                offerCount: {
                    description: "The total number of offers for the specified condition and fulfillment channel.";
                    type: "integer";
                };
            };
            required: readonly ["condition", "fulfillmentChannel", "offerCount"];
            type: "object";
        };
        offerType: {
            description: "Indicates whether the offer is a B2B offer or a B2C offer.";
            type: "string";
        };
        payload: {
            additionalProperties: true;
            properties: {
                b2bAnyOfferChangedNotification: {
                    $ref: "#/definitions/b2bAnyOfferChangedNotification";
                };
            };
            required: readonly ["b2bAnyOfferChangedNotification"];
            type: "object";
        };
        primeInformation: {
            additionalProperties: true;
            properties: {
                isOfferNationalPrime: {
                    description: "Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed.";
                    type: "boolean";
                };
                isOfferPrime: {
                    description: "Indicates whether the offer is an Amazon Prime offer.";
                    type: "boolean";
                };
            };
            required: readonly ["isOfferPrime", "isOfferNationalPrime"];
            type: "object";
        };
        QuantityDiscountPriceType: {
            description: "Contains pricing information that includes special pricing when buying in bulk.";
            properties: {
                listingPrice: {
                    $ref: "#/definitions/MoneyType";
                    description: "The price at this quantity tier.";
                };
                quantityDiscountType: {
                    $ref: "#/definitions/QuantityDiscountType";
                    description: "Indicates the type of quantity discount this price applies to.";
                };
                quantityTier: {
                    description: "Indicates at what quantity this price becomes active.";
                    format: "int32";
                    type: "integer";
                };
            };
            required: readonly [
                "listingPrice",
                "quantityDiscountType",
                "quantityTier",
            ];
            type: "object";
        };
        QuantityDiscountType: {
            enum: readonly ["QUANTITY_DISCOUNT"];
            type: "string";
            "x-docgen-enum-table-extension": readonly [
                { description: "A Quantity Discount."; value: "QUANTITY_DISCOUNT" },
            ];
        };
        quantityTier: {
            description: "The quantity tier for the offer";
            type: "integer";
        };
        sellerFeedbackRating: {
            additionalProperties: true;
            properties: {
                feedbackCount: {
                    description: "The count of feedback received about the seller.";
                    type: "integer";
                };
                sellerPositiveFeedbackRating: {
                    description: "The percentage of positive feedback for the seller in the past 365 days.";
                    type: "number";
                };
            };
            required: readonly ["feedbackCount", "sellerPositiveFeedbackRating"];
            type: "object";
        };
        shipping: {
            $ref: "#/definitions/moneyType";
            description: "The shipping cost.";
        };
        shippingTime: {
            additionalProperties: true;
            properties: {
                availabilityType: {
                    description: "Indicates whether the item is available for shipping now, or on a known or unknown date in the future.";
                    type: "string";
                };
                availableDate: {
                    description: "The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping.";
                    type: "string";
                };
                maximumHours: {
                    description: "The maximum time, in hours, that the item will likely be shipped after the order has been placed.";
                    type: "integer";
                };
                minimumHours: {
                    description: "The minimum time, in hours, that the item will likely be shipped after the order has been placed.";
                    type: "integer";
                };
            };
            type: "object";
        };
        shipsFrom: {
            additionalProperties: true;
            properties: { country: { type: "string" } };
            required: readonly ["country"];
            type: "object";
        };
        summary: {
            additionalProperties: true;
            properties: {
                buyBoxEligibleOffers: {
                    additionalItems: true;
                    description: "A list that contains the total number of B2B 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, quantity tiers, and discount types.";
                    items: readonly [{ $ref: "#/definitions/buyBoxPrice" }];
                    type: "array";
                };
                lowestPrices: {
                    additionalItems: true;
                    description: "A list that contains the lowest prices of the item for the given conditions, fulfillment channels, quantity tiers, and discount types.";
                    items: readonly [{ $ref: "#/definitions/lowestPrice" }];
                    type: "array";
                };
                numberOfOffers: {
                    additionalItems: true;
                    description: "A list that contains the total number of B2B offers for the item for the given conditions and fulfillment channels.";
                    items: readonly [{ $ref: "#/definitions/offerCount" }];
                    type: "array";
                };
            };
            required: readonly [
                "numberOfOffers",
                "buyBoxEligibleOffers",
                "lowestPrices",
                "buyBoxPrices",
            ];
            type: "object";
        };
    }
  • Readonlydescription: "The notification response schema that comprises the entire JSON document for B2B_ANY_OFFER_CHANGED notification."
  • Readonlytype: "object"