@sp-api-sdk/schemas
Version:
Selling Parner API additional schema types
397 lines (396 loc) • 17.8 kB
TypeScript
import { type FromSchema } from 'json-schema-to-ts';
export declare const pricingHealthNotification: {
readonly type: "object";
readonly description: "The notification response schema that comprises the entire JSON document for PRICING_HEALTH notification";
readonly examples: readonly [{
readonly notificationVersion: "1.0";
readonly notificationType: "PRICING_HEALTH";
readonly payloadVersion: "1.0";
readonly eventTime: "2020-09-23T21:30:13.713Z";
readonly payload: {
readonly issueType: "BuyBoxDisqualification";
readonly sellerId: "A3EZFOFNDPFB8R";
readonly offerChangeTrigger: {
readonly marketplaceId: "ATVPDKIKX0DER";
readonly asin: "B007IBIWZY";
readonly itemCondition: "new";
readonly timeOfOfferChange: "2020-09-23T21:30:13.409Z";
};
readonly merchantOffer: {
readonly condition: "new";
readonly fulfillmentType: "MFN";
readonly listingPrice: {
readonly amount: 8184.23;
readonly currencyCode: "USD";
};
readonly shipping: {
readonly amount: 4.49;
readonly currencyCode: "USD";
};
readonly landedPrice: {
readonly amount: 8188.72;
readonly currencyCode: "USD";
};
readonly points: {
readonly pointsNumber: 34343;
};
};
readonly summary: {
readonly numberOfOffers: readonly [{
readonly condition: "new";
readonly fulfillmentType: "MFN";
readonly offerCount: 3;
}];
readonly buyBoxEligibleOffers: readonly [{
readonly condition: "new";
readonly fulfillmentType: "MFN";
readonly offerCount: 3;
}];
readonly buyBoxPrices: readonly [{
readonly condition: "new";
readonly listingPrice: {
readonly amount: 8184.23;
readonly currencyCode: "USD";
};
readonly shipping: {
readonly amount: 4.49;
readonly currencyCode: "USD";
};
readonly landedPrice: {
readonly amount: 8188.72;
readonly currencyCode: "USD";
};
readonly points: {
readonly pointsNumber: 34343;
};
}];
readonly salesRankings: readonly [{
readonly productCategoryId: "lawn_and_garden_display_on_website";
readonly rank: 4013;
}, {
readonly productCategoryId: "home_garden_display_on_website";
readonly rank: 17316;
}];
readonly referencePrice: {
readonly averageSellingPrice: {
readonly amount: 7500;
readonly currencyCode: "USD";
};
readonly competitivePriceThreshold: {
readonly amount: 8000;
readonly currencyCode: "USD";
};
readonly msrpPrice: {
readonly amount: 7900;
readonly currencyCode: "USD";
};
readonly retailOfferPrice: {
readonly amount: 8000;
readonly currencyCode: "USD";
};
};
};
};
readonly notificationMetadata: {
readonly applicationId: "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a";
readonly subscriptionId: "e3a059ca-677a-442a-8d39-05b2848971b6";
readonly publishTime: "2020-09-23T21:30:16.903Z";
readonly notificationId: "23ae41cd-3537-4676-af46-6ee9abf8802e";
};
}];
readonly $ref: "#/definitions/notificationResponse";
readonly definitions: {
readonly offerChangeTrigger: {
readonly type: "object";
readonly description: "The event that caused the notification to be sent";
readonly required: readonly ["marketplaceId", "asin", "itemCondition", "timeOfOfferChange"];
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: "Indicates the condition of the item";
};
readonly fulfillmentType: {
readonly type: "string";
readonly description: "Indicates whether the item is fulfilled by Amazon or by the seller";
readonly enum: readonly ["AFN", "MFN"];
};
readonly offerCount: {
readonly type: "object";
readonly required: readonly ["condition", "fulfillmentType", "offerCount"];
readonly properties: {
readonly condition: {
readonly $ref: "#/definitions/condition";
};
readonly fulfillmentType: {
readonly $ref: "#/definitions/fulfillmentType";
};
readonly offerCount: {
readonly type: "integer";
readonly description: "The total number of offers for the specified condition and fulfillment channel";
};
};
};
readonly moneyType: {
readonly type: "object";
readonly required: readonly ["amount", "currencyCode"];
readonly properties: {
readonly amount: {
readonly type: "number";
};
readonly currencyCode: {
readonly type: "string";
};
};
};
readonly landedPrice: {
readonly $ref: "#/definitions/moneyType";
readonly description: "ListingPrice + Shipping";
};
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 points: {
readonly type: "object";
readonly description: "The number of Amazon Points offered with the purchase of an item";
readonly required: readonly ["pointsNumber"];
readonly properties: {
readonly pointsNumber: {
readonly type: "integer";
readonly description: "The number of Amazon Points offered with the purchase of an item";
};
};
};
readonly merchantOffer: {
readonly type: "object";
readonly description: "Offer details of the merchant receiving the notification";
readonly required: readonly ["condition", "fulfillmentType", "landedPrice", "shipping", "listingPrice"];
readonly properties: {
readonly condition: {
readonly $ref: "#/definitions/condition";
};
readonly fulfillmentType: {
readonly $ref: "#/definitions/fulfillmentType";
};
readonly landedPrice: {
readonly $ref: "#/definitions/landedPrice";
};
readonly listingPrice: {
readonly $ref: "#/definitions/listingPrice";
};
readonly shipping: {
readonly $ref: "#/definitions/shipping";
};
readonly points: {
readonly $ref: "#/definitions/points";
};
};
};
readonly buyBoxPrice: {
readonly type: "object";
readonly required: readonly ["condition", "landedPrice", "shipping", "listingPrice"];
readonly properties: {
readonly condition: {
readonly $ref: "#/definitions/condition";
};
readonly landedPrice: {
readonly $ref: "#/definitions/landedPrice";
};
readonly listingPrice: {
readonly $ref: "#/definitions/listingPrice";
};
readonly shipping: {
readonly $ref: "#/definitions/shipping";
};
readonly points: {
readonly $ref: "#/definitions/points";
};
};
};
readonly salesRank: {
readonly type: "object";
readonly required: readonly ["productCategoryId", "rank"];
readonly properties: {
readonly productCategoryId: {
readonly type: "string";
readonly description: "The product category for the rank";
};
readonly rank: {
readonly type: "integer";
readonly description: "The sales rank of the ASIN";
};
};
};
readonly averageSellingPrice: {
readonly $ref: "#/definitions/moneyType";
readonly description: "The average selling price of the item";
};
readonly competitivePriceThreshold: {
readonly $ref: "#/definitions/moneyType";
readonly description: "The competitive price threshold from external competitors of Amazon";
};
readonly retailOfferPrice: {
readonly $ref: "#/definitions/moneyType";
readonly description: "The 14 day maximum of retail offer price";
};
readonly msrpPrice: {
readonly $ref: "#/definitions/moneyType";
readonly description: "The manufacturer suggested retail price for the ASIN";
};
readonly referencePrice: {
readonly type: "object";
readonly description: "A set of reference prices for the given ASIN";
readonly properties: {
readonly averageSellingPrice: {
readonly $ref: "#/definitions/averageSellingPrice";
};
readonly competitivePriceThreshold: {
readonly $ref: "#/definitions/competitivePriceThreshold";
};
readonly retailOfferPrice: {
readonly $ref: "#/definitions/retailOfferPrice";
};
readonly msrpPrice: {
readonly $ref: "#/definitions/msrpPrice";
};
};
};
readonly summary: {
readonly type: "object";
readonly required: readonly ["numberOfOffers", "buyBoxEligibleOffers", "referencePrice"];
readonly properties: {
readonly numberOfOffers: {
readonly type: "array";
readonly description: "A list that contains the total number of 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 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 buyBoxPrices: {
readonly type: "array";
readonly description: "A list that contains the Buy Box price of the item for the given conditions";
readonly additionalItems: true;
readonly items: readonly [{
readonly $ref: "#/definitions/buyBoxPrice";
}];
};
readonly salesRankings: {
readonly type: "array";
readonly description: "A list that contains the sales rankings of the asin in various product categories";
readonly additionalItems: true;
readonly items: readonly [{
readonly $ref: "#/definitions/salesRank";
}];
};
readonly referencePrice: {
readonly $ref: "#/definitions/referencePrice";
};
};
};
readonly payload: {
readonly type: "object";
readonly required: readonly ["issueType", "sellerId", "offerChangeTrigger", "merchantOffer", "summary"];
readonly properties: {
readonly sellerId: {
readonly type: "string";
readonly description: "The seller identifier for the offer";
};
readonly issueType: {
readonly type: "string";
readonly description: "The issue type for the notification";
};
readonly offerChangeTrigger: {
readonly $ref: "#/definitions/offerChangeTrigger";
};
readonly merchantOffer: {
readonly $ref: "#/definitions/merchantOffer";
};
readonly summary: {
readonly $ref: "#/definitions/summary";
};
};
};
readonly notificationMetadata: {
readonly type: "object";
readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"];
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 UTC) that the notification was sent";
};
readonly notificationId: {
readonly type: "string";
readonly description: "A unique identifier for this notification instance";
};
};
};
readonly notificationResponse: {
readonly type: "object";
readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"];
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 payload version controls the structure of payload object";
};
readonly payloadVersion: {
readonly type: "string";
readonly description: "The payload version. Combined with notification type controls the structure of payload";
};
readonly eventTime: {
readonly type: "string";
readonly description: "The date and time (in UTC) that the event which triggered the notification occurred";
};
readonly payload: {
readonly $ref: "#/definitions/payload";
};
readonly notificationMetadata: {
readonly $ref: "#/definitions/notificationMetadata";
};
};
};
};
};
export type PricingHealthNotification = FromSchema<typeof pricingHealthNotification>;