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