import { FromSchema } from "json-schema-to-ts"; //#endregion //#region src/feeds/listings-feed-message-schema-v-2.d.ts declare const listingsFeedMessageSchemaV2: { readonly $comment: "JSON Schema describing the document format for JSON Selling Partner Listings Message (v2)."; readonly title: "Selling Partner Listings Message (v2)"; readonly properties: { readonly messageId: { readonly title: "Message Identifier"; readonly description: "Identifier for the message that is unique within this feed submission. Response messages are correlated to this identifier."; readonly examples: readonly [1]; readonly minimum: 1; readonly type: "integer"; }; readonly sku: { readonly title: "SKU (Stock Keeping Unit)"; readonly description: "Selling Partner SKU (stock keeping unit) identifier for the listing. SKU uniquely identifies a listing for a Selling Partner."; readonly examples: readonly ["ABC123"]; readonly minLength: 1; readonly type: "string"; }; readonly operationType: { readonly title: "Operation Type"; readonly description: "Type of operation to perform for the listings data submission in this message. \"UPDATE\" indicates the full set of item attributes are provided and any existing attributes data will be replaced with the provided attributes. \"PARTIAL_UPDATE\" indicates only the provided item attributes will be updated with the provided attribute data. \"PATCH\" indicates the provided JSON Patch operations will be used to update the applicable attributes. \"DELETE\" indicates the listings item will be deleted."; readonly enum: readonly ["UPDATE", "PARTIAL_UPDATE", "PATCH", "DELETE"]; readonly type: "string"; }; readonly productType: { readonly title: "Amazon Product Type"; readonly description: "Amazon product type of the listings data submission in this message."; readonly examples: readonly ["LUGGAGE", "SHOES"]; readonly minLength: 1; readonly type: "string"; }; readonly requirements: { readonly title: "Requirements"; readonly description: "Name of the requirements type for the listings data submission in this message. \"LISTING\" indicates requirements inclusive of product facts and sales terms. \"LISTING_PRODUCT_ONLY\" indicates requirements inclusive of product facts only. \"LISTING_OFFER_ONLY\" indicates requirements inclusive of sales terms only."; readonly default: "LISTING"; readonly enum: readonly ["LISTING", "LISTING_PRODUCT_ONLY", "LISTING_OFFER_ONLY"]; readonly type: "string"; }; readonly attributes: { readonly title: "Listings Item Attributes"; readonly description: "Attributes data for the listings data submission."; readonly additionalProperties: true; readonly minProperties: 1; readonly type: "object"; }; readonly patches: { readonly title: "Listings Item JSON Patch Operations"; readonly description: "Attributes data in the form of JSON Patch operations to update or delete."; readonly minItems: 1; readonly items: { readonly description: "Individual JSON Patch operation."; readonly properties: { readonly op: { readonly description: "Type of JSON Patch operation. Supported JSON Patch operations include add, replace, merge, and delete. See https://tools.ietf.org/html/rfc6902."; readonly example: "replace"; readonly enum: readonly ["add", "replace", "merge", "delete"]; readonly type: "string"; }; readonly path: { readonly description: "JSON Pointer path of the attribute to patch. See https://tools.ietf.org/html/rfc6902."; readonly example: "/attributes/fulfillment_availability"; readonly type: "string"; }; readonly value: { readonly description: "JSON value to add, replace, or delete."; readonly example: readonly [{ readonly fulfillment_channel_code: "DEFAULT"; readonly quantity: 10; }]; readonly type: "array"; readonly items: { readonly type: "object"; readonly additionalProperties: true; }; }; }; readonly required: readonly ["op", "path"]; readonly type: "object"; }; readonly type: "array"; }; }; readonly required: readonly ["messageId", "sku", "operationType"]; readonly oneOf: readonly [{ readonly $comment: "\"UPDATE\" operations require a \"productType\" and \"attributes\"; \"patches\" are not applicable to \"UPDATE\" operations."; readonly properties: { readonly operationType: { readonly const: "UPDATE"; readonly type: "string"; }; readonly patches: false; }; readonly required: readonly ["productType", "attributes"]; }, { readonly $comment: "\"requirements\", \"attributes\", \"productType\", and \"patches\" are not applicable to \"DELETE\" operations."; readonly properties: { readonly operationType: { readonly const: "DELETE"; readonly type: "string"; }; readonly requirements: false; readonly attributes: false; readonly productType: false; readonly patches: false; }; }, { readonly $comment: "\"PARTIAL_UPDATE\" operations require a \"productType\" and \"attributes\"; \"requirements\" and \"patches\" are not applicable to \"PARTIAL_UPDATE\" operations."; readonly properties: { readonly operationType: { readonly const: "PARTIAL_UPDATE"; readonly type: "string"; }; readonly requirements: false; readonly patches: false; }; readonly required: readonly ["productType", "attributes"]; }, { readonly $comment: "\"PATCH\" operations require a \"productType\" and \"patches\"; \"requirements\" and \"attributes\" are not applicable to \"PATCH\" operations."; readonly properties: { readonly operationType: { readonly const: "PATCH"; readonly type: "string"; }; readonly requirements: false; readonly attributes: false; }; readonly required: readonly ["productType", "patches"]; }]; readonly type: "object"; }; type ListingsFeedMessageSchemaV2 = FromSchema; //#endregion //#region src/feeds/listings-feed-processing-report-schema-v-2.d.ts declare const listingsFeedProcessingReportSchemaV2: { readonly $comment: "JSON Schema describing the document format for JSON Selling Partner Listings Feeds Processing Report (v2)."; readonly title: "Selling Partner JSON Listings Feed Processing Report (v2)"; readonly properties: { readonly header: { readonly title: "Processing Report Header"; readonly description: "Header information about the feed submission."; readonly properties: { readonly sellerId: { readonly title: "Selling Partner Identifier"; readonly description: "Identifier for the Selling Partner, such as the Merchant Account or Vendor Code."; readonly type: "string"; }; readonly version: { readonly title: "Feed Version"; readonly description: "Version of the JSON Selling Partner Listings Feeds specification used for the feed submission."; readonly const: "2.0"; readonly type: "string"; }; readonly feedId: { readonly title: "Feed Identifier"; readonly description: "The identifier for the feed. This identifier is unique only in combination with a seller ID."; readonly type: "string"; }; readonly report: { readonly title: "Report"; readonly description: "The report information for the feed submission."; readonly properties: { readonly includedData: { readonly title: "Included Data"; readonly description: "When \"includedData\" elements are in the feed submission, the processing report that generates for the feed submission includes the listings items output from the Selling Partner Listings Items API with the \"includedData\" elements from the request. The report includes issues that prevent the acceptance of messages regardless of the \"includedData\" elements in the feed request."; readonly type: "array"; readonly minItems: 1; readonly items: { readonly type: "string"; readonly enum: readonly ["summaries", "attributes", "issues", "offers", "fulfillmentAvailability", "procurement", "relationships", "productTypes"]; }; }; readonly apiVersion: { readonly title: "Selling Partner Listings Items API Version"; readonly description: "The version of the Selling Partner Listings Items API to use to retrieve the listing items."; readonly type: "string"; readonly enum: readonly ["2021-08-01"]; }; }; readonly required: readonly ["includedData", "apiVersion"]; readonly type: "object"; }; }; readonly required: readonly ["sellerId", "version", "feedId"]; readonly type: "object"; }; readonly issues: { readonly title: "Issues Encountered Processing Messages"; readonly description: "Issues containing message processing information for the Selling Partner."; readonly minItems: 0; readonly items: { readonly title: "Issue"; readonly description: "Issue containing message processing information corresponding to an individual listings data submission."; readonly properties: { readonly messageId: { readonly title: "Message Identifier"; readonly description: "Identifier for the message that is unique within this feed submission. Correlated to Identifiers provided in the submitted feed. Not provided if the error is not related to a message (e.g. feed formatting issue)."; readonly examples: readonly [1]; readonly minimum: 1; readonly type: "integer"; }; readonly sku: { readonly title: "SKU (Stock Keeping Unit)"; readonly description: "Selling Partner SKU (stock keeping unit) identifier for the listing. SKU uniquely identifies a listing for a Selling Partner."; readonly examples: readonly ["ABC123"]; readonly minLength: 1; readonly type: "string"; }; readonly code: { readonly title: "Error Code"; readonly description: "An Optional error code that maps to documentation."; readonly examples: readonly ["ABC123"]; readonly minLength: 1; readonly type: "string"; }; readonly severity: { readonly title: "Error Severity"; readonly description: "The severity of the issue."; readonly enum: readonly ["ERROR", "WARNING", "INFO"]; readonly type: "string"; }; readonly message: { readonly title: "Localized Error Message"; readonly description: "Localized Error Message Associated with the issue encountered."; readonly examples: readonly ["'[batteries_required]' is required but not supplied."]; readonly minLength: 1; readonly type: "string"; }; readonly attributeName: { readonly description: "Name of the attribute associated with the issue, if applicable."; readonly examples: readonly ["item_type_name"]; readonly type: "string"; }; }; readonly required: readonly ["severity", "message"]; readonly type: "object"; }; readonly type: "array"; }; readonly summary: { readonly title: "Processing Report Summary"; readonly description: "Aggregate counts of errors, warnings, and statuses related to the acceptance of feed messages. When requested, Item Summary includes aggregate counts of items, errors, and warnings related to the listing items created or updated by this feed submission."; readonly properties: { readonly errors: { readonly title: "Errors"; readonly description: "Number of errors encountered processing the feed."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly warnings: { readonly title: "Warnings"; readonly description: "Number of warnings encountered processing the feed."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly messagesProcessed: { readonly title: "Messages Processed"; readonly description: "Number of messages processed."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly messagesAccepted: { readonly title: "Messages Accepted"; readonly description: "Number of messages that were accepted, the associated updates are being applied."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly messagesInvalid: { readonly title: "Messages Invalid"; readonly description: "Number of messages that were invalid, the associated updates will not be applied."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly itemSummary: { readonly title: "Item Summary"; readonly description: "Aggregate counts of items, errors, and warnings related to the listing items created or updated by this feed submission and included in the Items section of this report."; readonly type: "object"; readonly properties: { readonly items: { readonly title: "Items"; readonly description: "Number of listing items created or updated by this feed submission and included in the Items section of this report."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly errors: { readonly title: "Errors"; readonly description: "Number of errors across all listing items created or updated by this feed submission."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; readonly warnings: { readonly title: "Warnings"; readonly description: "Number of warnings across all listing items created or updated by this feed submission."; readonly examples: readonly [1]; readonly minimum: 0; readonly type: "integer"; }; }; readonly required: readonly ["items", "errors", "warnings"]; }; }; readonly required: readonly ["errors", "warnings", "messagesProcessed", "messagesAccepted", "messagesInvalid"]; readonly type: "object"; }; readonly items: { readonly title: "Listings Items"; readonly description: "A set of listings items and their specific data sets that originates from the feed request’s \"includedData\" header parameter."; readonly type: "array"; readonly items: { readonly title: "Item"; readonly description: "A listings item."; readonly additionalProperties: true; readonly minProperties: 1; readonly type: "object"; }; }; }; readonly required: readonly ["header", "issues", "summary"]; readonly type: "object"; }; type ListingsFeedProcessingReportSchemaV2 = FromSchema; //#endregion //#region src/feeds/listings-feed-schema-v-2.d.ts declare const listingsFeedSchemaV2: { readonly $comment: "JSON Schema describing the document format for JSON Selling Partner Listings Feeds (v2)."; readonly title: "Selling Partner Listings Feed (v2)"; readonly properties: { readonly header: { readonly title: "Feed Header"; readonly description: "Header information about the feed submission."; readonly properties: { readonly sellerId: { readonly title: "Selling Partner Identifier"; readonly description: "Identifier for the Selling Partner, such as the Merchant Account or Vendor Code."; readonly type: "string"; }; readonly version: { readonly title: "Feed Version"; readonly description: "Version of the JSON Selling Partner Listings Feeds specification used for the feed submission."; readonly const: "2.0"; readonly type: "string"; }; readonly issueLocale: { readonly title: "Issue Locale"; readonly description: "Locale for issue localization. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale."; readonly type: "string"; }; readonly report: { readonly title: "Report"; readonly description: "The report information for the feed submission."; readonly properties: { readonly includedData: { readonly title: "Included Data"; readonly description: "When \"includedData\" elements are in the feed submission, the processing report that generates for the feed submission includes the listings items output from the Selling Partner Listings Items API with the \"includedData\" elements from the request. The report includes issues that prevent the acceptance of messages regardless of the \"includedData\" elements in the feed request."; readonly type: "array"; readonly minItems: 1; readonly items: { readonly type: "string"; readonly enum: readonly ["summaries", "attributes", "issues", "offers", "fulfillmentAvailability", "procurement", "relationships", "productTypes"]; }; }; readonly apiVersion: { readonly title: "Selling Partner Listings Items API Version"; readonly description: "The version of the Selling Partner Listings Items API to use to retrieve the listing items."; readonly type: "string"; readonly enum: readonly ["2021-08-01"]; }; }; readonly required: readonly ["includedData", "apiVersion"]; readonly type: "object"; }; }; readonly required: readonly ["sellerId", "version"]; readonly type: "object"; }; readonly messages: { readonly title: "Feed Messages"; readonly description: "Messages containing listings data submissions for the Selling Partner."; readonly minItems: 1; readonly maxItems: 25000; readonly items: { readonly title: "Feed Message"; readonly description: "Message containing an individual listings data submission."; readonly properties: { readonly messageId: { readonly title: "Message Identifier"; readonly description: "Identifier for the message that is unique within this feed submission. Response messages are correlated to this identifier."; readonly examples: readonly [1]; readonly minimum: 1; readonly type: "integer"; readonly maximum: 2147483647; }; readonly sku: { readonly title: "SKU (Stock Keeping Unit)"; readonly description: "Selling Partner SKU (stock keeping unit) identifier for the listing. SKU uniquely identifies a listing for a Selling Partner."; readonly examples: readonly ["ABC123"]; readonly minLength: 1; readonly type: "string"; }; readonly operationType: { readonly title: "Operation Type"; readonly description: "Type of operation to perform for the listings data submission in this message. \"UPDATE\" indicates the full set of item attributes are provided and any existing attributes data will be replaced with the provided attributes. \"PARTIAL_UPDATE\" indicates only the provided item attributes will be updated with the provided attribute data. \"PATCH\" indicates the provided JSON Patch operations will be used to update the applicable attributes. \"DELETE\" indicates the listings item will be deleted. \"PARTIAL_UPDATE\" is equivalent to using \"PATCH\" with the \"replace\" op."; readonly enum: readonly ["UPDATE", "PARTIAL_UPDATE", "PATCH", "DELETE"]; readonly type: "string"; }; readonly productType: { readonly title: "Amazon Product Type"; readonly description: "Amazon product type of the listings data submission in this message."; readonly examples: readonly ["LUGGAGE", "SHOES"]; readonly minLength: 1; readonly type: "string"; }; readonly requirements: { readonly title: "Requirements"; readonly description: "Name of the requirements type for the listings data submission in this message. \"LISTING\" indicates requirements inclusive of product facts and sales terms. \"LISTING_PRODUCT_ONLY\" indicates requirements inclusive of product facts only. \"LISTING_OFFER_ONLY\" indicates requirements inclusive of sales terms only."; readonly default: "LISTING"; readonly enum: readonly ["LISTING", "LISTING_PRODUCT_ONLY", "LISTING_OFFER_ONLY"]; readonly type: "string"; }; readonly attributes: { readonly title: "Listings Item Attributes"; readonly description: "Attributes data for the listings data submission."; readonly additionalProperties: true; readonly minProperties: 1; readonly type: "object"; }; readonly patches: { readonly title: "Listings Item JSON Patch Operations"; readonly description: "Attributes data in the form of JSON Patch operations to update or delete."; readonly minItems: 1; readonly items: { readonly description: "Individual JSON Patch operation."; readonly properties: { readonly op: { readonly description: "Type of JSON Patch operation. Supported JSON Patch operations include add, replace, merge, and delete. See https://tools.ietf.org/html/rfc6902."; readonly example: "replace"; readonly enum: readonly ["add", "replace", "merge", "delete"]; readonly type: "string"; }; readonly path: { readonly description: "JSON Pointer path of the attribute to patch. See https://tools.ietf.org/html/rfc6902."; readonly example: "/attributes/fulfillment_availability"; readonly type: "string"; }; readonly value: { readonly description: "JSON value to add, replace, or delete."; readonly example: readonly [{ readonly fulfillment_channel_code: "DEFAULT"; readonly quantity: 10; }]; readonly type: "array"; readonly items: { readonly type: "object"; readonly additionalProperties: true; }; }; }; readonly required: readonly ["op", "path"]; readonly type: "object"; }; readonly type: "array"; }; }; readonly required: readonly ["messageId", "sku", "operationType"]; readonly oneOf: readonly [{ readonly $comment: "\"UPDATE\" operations require a \"productType\" and \"attributes\"; \"patches\" are not applicable to \"UPDATE\" operations."; readonly properties: { readonly operationType: { readonly const: "UPDATE"; readonly type: "string"; }; readonly patches: false; }; readonly required: readonly ["productType", "attributes"]; }, { readonly $comment: "\"requirements\", \"attributes\", \"productType\", and \"patches\" are not applicable to \"DELETE\" operations."; readonly properties: { readonly operationType: { readonly const: "DELETE"; readonly type: "string"; }; readonly requirements: false; readonly attributes: false; readonly productType: false; readonly patches: false; }; }, { readonly $comment: "\"PARTIAL_UPDATE\" operations require a \"productType\" and \"attributes\"; \"requirements\" and \"patches\" are not applicable to \"PARTIAL_UPDATE\" operations."; readonly properties: { readonly operationType: { readonly const: "PARTIAL_UPDATE"; readonly type: "string"; }; readonly requirements: false; readonly patches: false; }; readonly required: readonly ["productType", "attributes"]; }, { readonly $comment: "\"PATCH\" operations require a \"productType\" and \"patches\"; \"requirements\" and \"attributes\" are not applicable to \"PATCH\" operations."; readonly properties: { readonly operationType: { readonly const: "PATCH"; readonly type: "string"; }; readonly requirements: false; readonly attributes: false; }; readonly required: readonly ["productType", "patches"]; }]; readonly type: "object"; }; readonly type: "array"; }; }; readonly required: readonly ["header", "messages"]; readonly type: "object"; }; type ListingsFeedSchemaV2 = FromSchema; declare namespace index_d_exports { export { ListingsFeedMessageSchemaV2, ListingsFeedProcessingReportSchemaV2, ListingsFeedSchemaV2, listingsFeedMessageSchemaV2, listingsFeedProcessingReportSchemaV2, listingsFeedSchemaV2 }; } //#endregion //#region src/notifications/any-offer-changed-notification.d.ts declare const anyOfferChangedNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "ANY_OFFER_CHANGED"; readonly PayloadVersion: "1.0"; readonly EventTime: "2020-07-13T19:42:04.284Z"; readonly NotificationMetadata: { readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; readonly Payload: { readonly AnyOfferChangedNotification: { readonly SellerId: "A3TH9S8BH6GOGM"; readonly OfferChangeTrigger: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ASIN: "123"; readonly ItemCondition: "New"; readonly TimeOfOfferChange: "2020-07-13T19:42:04.284Z"; readonly OfferChangeType: "Internal"; }; readonly Summary: { readonly NumberOfOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 10; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 21; }]; readonly LowestPrices: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly BuyBoxPrices: readonly [{ readonly Condition: "new"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly ListPrice: { readonly Amount: 55; readonly CurrencyCode: "USD"; }; readonly MinimumAdvertisedPrice: { readonly Amount: 66; readonly CurrencyCode: "USD"; }; readonly SuggestedLowerPricePlusShipping: { readonly Amount: 77; readonly CurrencyCode: "USD"; }; readonly TotalBuyBoxEligibleOffers: 100; readonly SalesRankings: readonly [{ readonly ProductCategoryId: "1243"; readonly Rank: 1; }, { readonly ProductCategoryId: "1234"; readonly Rank: 2; }]; readonly NumberOfBuyBoxEligibleOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 23; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 54; }]; readonly CompetitivePriceThreshold: { readonly Amount: 22; readonly CurrencyCode: "USD"; }; }; readonly Offers: readonly [{ readonly SellerId: "111"; readonly SubCondition: "New"; readonly SellerFeedbackRating: { readonly FeedbackCount: 9; readonly SellerPositiveFeedbackRating: 10; }; readonly ShippingTime: { readonly MinimumHours: 10; readonly MaximumHours: 30; readonly AvailabilityType: "available"; readonly AvailableDate: "2020-07-13T19:42:04.284Z"; }; readonly ListingPrice: { readonly Amount: 23; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 33333; }; readonly Shipping: { readonly Amount: 110; readonly CurrencyCode: "USD"; }; readonly ShipsFrom: { readonly Country: "USA"; readonly State: "MI"; }; readonly IsFulfilledByAmazon: true; readonly PrimeInformation: { readonly IsOfferPrime: true; readonly IsOfferNationalPrime: false; }; readonly IsExpeditedShippingAvailable: true; readonly IsFeaturedMerchant: true; readonly ShipsDomestically: true; readonly ShipsInternationally: true; }]; }; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "NotificationMetadata", "Payload"]; readonly additionalProperties: true; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The Notification type schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ANY_OFFER_CHANGED"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly additionalProperties: true; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly AnyOfferChangedNotification: { readonly SellerId: "A3TH9S8BH6GOGM"; readonly OfferChangeTrigger: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ASIN: "123"; readonly ItemCondition: "New"; readonly TimeOfOfferChange: "2020-07-13T19:42:04.284Z"; readonly OfferChangeType: "Internal"; }; readonly Summary: { readonly NumberOfOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 10; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 21; }]; readonly LowestPrices: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly BuyBoxPrices: readonly [{ readonly Condition: "new"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly ListPrice: { readonly Amount: 55; readonly CurrencyCode: "USD"; }; readonly MinimumAdvertisedPrice: { readonly Amount: 66; readonly CurrencyCode: "USD"; }; readonly SuggestedLowerPricePlusShipping: { readonly Amount: 77; readonly CurrencyCode: "USD"; }; readonly TotalBuyBoxEligibleOffers: 100; readonly SalesRankings: readonly [{ readonly ProductCategoryId: "1243"; readonly Rank: 1; }, { readonly ProductCategoryId: "1234"; readonly Rank: 2; }]; readonly NumberOfBuyBoxEligibleOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 23; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 54; }]; readonly CompetitivePriceThreshold: { readonly Amount: 22; readonly CurrencyCode: "USD"; }; }; readonly Offers: readonly [{ readonly SellerId: "111"; readonly SubCondition: "New"; readonly SellerFeedbackRating: { readonly FeedbackCount: 9; readonly SellerPositiveFeedbackRating: 10; }; readonly ShippingTime: { readonly MinimumHours: 10; readonly MaximumHours: 30; readonly AvailabilityType: "available"; readonly AvailableDate: "2020-07-13T19:42:04.284Z"; }; readonly ListingPrice: { readonly Amount: 23; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 33333; }; readonly Shipping: { readonly Amount: 110; readonly CurrencyCode: "USD"; }; readonly ShipsFrom: { readonly Country: "USA"; readonly State: "MI"; }; readonly IsFulfilledByAmazon: true; readonly PrimeInformation: { readonly IsOfferPrime: true; readonly IsOfferNationalPrime: false; }; readonly IsExpeditedShippingAvailable: true; readonly IsFeaturedMerchant: true; readonly ShipsDomestically: true; readonly ShipsInternationally: true; }]; }; }]; readonly required: readonly ["AnyOfferChangedNotification"]; readonly additionalProperties: true; readonly properties: { readonly AnyOfferChangedNotification: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification"; readonly type: "object"; readonly title: "The AnyOfferChangedNotification schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly SellerId: "A3TH9S8BH6GOGM"; readonly OfferChangeTrigger: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ASIN: "123"; readonly ItemCondition: "New"; readonly TimeOfOfferChange: "2020-07-13T19:42:04.284Z"; readonly OfferChangeType: "Internal"; }; readonly Summary: { readonly NumberOfOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 10; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 21; }]; readonly LowestPrices: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly BuyBoxPrices: readonly [{ readonly Condition: "new"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly ListPrice: { readonly Amount: 55; readonly CurrencyCode: "USD"; }; readonly MinimumAdvertisedPrice: { readonly Amount: 66; readonly CurrencyCode: "USD"; }; readonly SuggestedLowerPricePlusShipping: { readonly Amount: 77; readonly CurrencyCode: "USD"; }; readonly TotalBuyBoxEligibleOffers: 100; readonly SalesRankings: readonly [{ readonly ProductCategoryId: "1243"; readonly Rank: 1; }, { readonly ProductCategoryId: "1234"; readonly Rank: 2; }]; readonly NumberOfBuyBoxEligibleOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 23; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 54; }]; readonly CompetitivePriceThreshold: { readonly Amount: 22; readonly CurrencyCode: "USD"; }; }; readonly Offers: readonly [{ readonly SellerId: "111"; readonly SubCondition: "New"; readonly SellerFeedbackRating: { readonly FeedbackCount: 9; readonly SellerPositiveFeedbackRating: 10; }; readonly ShippingTime: { readonly MinimumHours: 10; readonly MaximumHours: 30; readonly AvailabilityType: "available"; readonly AvailableDate: "2020-07-13T19:42:04.284Z"; }; readonly ListingPrice: { readonly Amount: 23; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 33333; }; readonly Shipping: { readonly Amount: 110; readonly CurrencyCode: "USD"; }; readonly ShipsFrom: { readonly Country: "USA"; readonly State: "MI"; }; readonly IsFulfilledByAmazon: true; readonly PrimeInformation: { readonly IsOfferPrime: true; readonly IsOfferNationalPrime: false; }; readonly IsExpeditedShippingAvailable: true; readonly IsFeaturedMerchant: true; readonly ShipsDomestically: true; readonly ShipsInternationally: true; }]; }]; readonly required: readonly ["SellerId", "OfferChangeTrigger", "Summary", "Offers"]; readonly additionalProperties: true; readonly properties: { readonly SellerId: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/SellerId"; readonly type: "string"; readonly title: "The SellerId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly OfferChangeTrigger: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/OfferChangeTrigger"; readonly type: "object"; readonly title: "The OfferChangeTrigger schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ASIN: "123"; readonly ItemCondition: "New"; readonly TimeOfOfferChange: "2020-07-13T19:42:04.284Z"; readonly OfferChangeType: "Internal"; }]; readonly required: readonly ["MarketplaceId", "ASIN", "ItemCondition", "TimeOfOfferChange", "OfferChangeType"]; readonly additionalProperties: true; readonly properties: { readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/OfferChangeTrigger/properties/MarketplaceId"; readonly type: "string"; readonly title: "The MarketplaceId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly ASIN: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/OfferChangeTrigger/properties/ASIN"; readonly type: "string"; readonly title: "The ASIN schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["123"]; }; readonly ItemCondition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/OfferChangeTrigger/properties/ItemCondition"; readonly type: "string"; readonly title: "The ItemCondition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["New"]; }; readonly TimeOfOfferChange: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/OfferChangeTrigger/properties/TimeOfOfferChange"; readonly type: "string"; readonly title: "The TimeOfOfferChange schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly OfferChangeType: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/OfferChangeTrigger/properties/OfferChangeType"; readonly type: "string"; readonly title: "The OfferChangeType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Internal", "External", "FeaturedOffer"]; }; }; }; readonly Summary: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary"; readonly type: "object"; readonly title: "The Summary schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly NumberOfOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 10; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 21; }]; readonly LowestPrices: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly BuyBoxPrices: readonly [{ readonly Condition: "new"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly ListPrice: { readonly Amount: 55; readonly CurrencyCode: "USD"; }; readonly MinimumAdvertisedPrice: { readonly Amount: 66; readonly CurrencyCode: "USD"; }; readonly SuggestedLowerPricePlusShipping: { readonly Amount: 77; readonly CurrencyCode: "USD"; }; readonly TotalBuyBoxEligibleOffers: 100; readonly SalesRankings: readonly [{ readonly ProductCategoryId: "1243"; readonly Rank: 1; }, { readonly ProductCategoryId: "1234"; readonly Rank: 2; }]; readonly NumberOfBuyBoxEligibleOffers: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 23; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 54; }]; readonly CompetitivePriceThreshold: { readonly Amount: 22; readonly CurrencyCode: "USD"; }; }]; readonly required: readonly ["NumberOfOffers", "LowestPrices", "BuyBoxPrices", "ListPrice", "MinimumAdvertisedPrice", "SuggestedLowerPricePlusShipping", "TotalBuyBoxEligibleOffers", "SalesRankings", "NumberOfBuyBoxEligibleOffers", "CompetitivePriceThreshold"]; readonly additionalProperties: true; readonly properties: { readonly NumberOfOffers: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfOffers"; readonly type: "array"; readonly title: "The NumberOfOffers schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 10; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 21; }]]; readonly additionalItems: true; readonly items: { readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfOffers/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 10; }]; readonly required: readonly ["Condition", "FulfillmentChannel", "OfferCount"]; readonly additionalProperties: true; readonly properties: { readonly Condition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfOffers/items/anyOf/0/properties/Condition"; readonly type: "string"; readonly title: "The Condition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["new"]; }; readonly FulfillmentChannel: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfOffers/items/anyOf/0/properties/FulfillmentChannel"; readonly type: "string"; readonly title: "The FulfillmentChannel schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Merchant"]; }; readonly OfferCount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfOffers/items/anyOf/0/properties/OfferCount"; readonly type: "integer"; readonly title: "The OfferCount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; }; }]; readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfOffers/items"; }; }; readonly LowestPrices: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices"; readonly type: "array"; readonly title: "The LowestPrices schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]]; readonly additionalItems: true; readonly items: { readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }]; readonly required: readonly ["Condition", "FulfillmentChannel", "LandedPrice", "ListingPrice", "Shipping"]; readonly additionalProperties: true; readonly properties: { readonly Condition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/Condition"; readonly type: "string"; readonly title: "The Condition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["new"]; }; readonly FulfillmentChannel: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/FulfillmentChannel"; readonly type: "string"; readonly title: "The FulfillmentChannel schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Merchant"]; }; readonly LandedPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/LandedPrice"; readonly type: "object"; readonly title: "The LandedPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/LandedPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/LandedPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly ListingPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/ListingPrice"; readonly type: "object"; readonly title: "The ListingPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/ListingPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/ListingPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Shipping: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/Shipping"; readonly type: "object"; readonly title: "The Shipping schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 0; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/Shipping/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [0]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/0/properties/Shipping/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; }; }, { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1"; readonly type: "object"; readonly title: "The second anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly required: readonly ["Condition", "FulfillmentChannel", "LandedPrice", "ListingPrice", "Shipping", "Points"]; readonly additionalProperties: true; readonly properties: { readonly Condition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/Condition"; readonly type: "string"; readonly title: "The Condition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["new", "used"]; }; readonly FulfillmentChannel: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/FulfillmentChannel"; readonly type: "string"; readonly title: "The FulfillmentChannel schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Amazon"]; }; readonly LandedPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/LandedPrice"; readonly type: "object"; readonly title: "The LandedPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 11; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/LandedPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [11]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/LandedPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly ListingPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/ListingPrice"; readonly type: "object"; readonly title: "The ListingPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 20; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/ListingPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [20]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/ListingPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Shipping: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/Shipping"; readonly type: "object"; readonly title: "The Shipping schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 40; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/Shipping/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [40]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/Shipping/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Points: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/Points"; readonly type: "object"; readonly title: "The Points schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly PointsNumber: 34343; }]; readonly required: readonly ["PointsNumber"]; readonly additionalProperties: true; readonly properties: { readonly PointsNumber: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items/anyOf/1/properties/Points/properties/PointsNumber"; readonly type: "integer"; readonly title: "The PointsNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [34343]; }; }; }; }; }]; readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/LowestPrices/items"; }; }; readonly BuyBoxPrices: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices"; readonly type: "array"; readonly title: "The BuyBoxPrices schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly Condition: "new"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }, { readonly Condition: "used"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]]; readonly additionalItems: true; readonly items: { readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Condition: "new"; readonly LandedPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 0; readonly CurrencyCode: "USD"; }; }]; readonly required: readonly ["Condition", "LandedPrice", "ListingPrice", "Shipping"]; readonly additionalProperties: true; readonly properties: { readonly Condition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/Condition"; readonly type: "string"; readonly title: "The Condition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["new"]; }; readonly LandedPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/LandedPrice"; readonly type: "object"; readonly title: "The LandedPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/LandedPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/LandedPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly ListingPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/ListingPrice"; readonly type: "object"; readonly title: "The ListingPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/ListingPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/ListingPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Shipping: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/Shipping"; readonly type: "object"; readonly title: "The Shipping schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 0; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/Shipping/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [0]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/0/properties/Shipping/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; }; }, { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1"; readonly type: "object"; readonly title: "The second anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Condition: "used"; readonly LandedPrice: { readonly Amount: 11; readonly CurrencyCode: "USD"; }; readonly ListingPrice: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly Shipping: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 34343; }; }]; readonly required: readonly ["Condition", "LandedPrice", "ListingPrice", "Shipping", "Points"]; readonly additionalProperties: true; readonly properties: { readonly Condition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/Condition"; readonly type: "string"; readonly title: "The Condition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["new", "used"]; }; readonly LandedPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/LandedPrice"; readonly type: "object"; readonly title: "The LandedPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 11; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/LandedPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [11]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/LandedPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly ListingPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/ListingPrice"; readonly type: "object"; readonly title: "The ListingPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 20; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/ListingPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [20]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/ListingPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Shipping: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/Shipping"; readonly type: "object"; readonly title: "The Shipping schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 40; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/Shipping/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [40]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/Shipping/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Points: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/Points"; readonly type: "object"; readonly title: "The Points schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly PointsNumber: 34343; }]; readonly required: readonly ["PointsNumber"]; readonly additionalProperties: true; readonly properties: { readonly PointsNumber: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items/anyOf/1/properties/Points/properties/PointsNumber"; readonly type: "integer"; readonly title: "The PointsNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [34343]; }; }; }; }; }]; readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/BuyBoxPrices/items"; }; }; readonly ListPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/ListPrice"; readonly type: "object"; readonly title: "The ListPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 55; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/ListPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [55]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/ListPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly MinimumAdvertisedPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/MinimumAdvertisedPrice"; readonly type: "object"; readonly title: "The MinimumAdvertisedPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 66; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/MinimumAdvertisedPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [66]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/MinimumAdvertisedPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly SuggestedLowerPricePlusShipping: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SuggestedLowerPricePlusShipping"; readonly type: "object"; readonly title: "The SuggestedLowerPricePlusShipping schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 77; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SuggestedLowerPricePlusShipping/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [77]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SuggestedLowerPricePlusShipping/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly TotalBuyBoxEligibleOffers: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/TotalBuyBoxEligibleOffers"; readonly type: "integer"; readonly title: "The TotalBuyBoxEligibleOffers schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [100]; }; readonly SalesRankings: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SalesRankings"; readonly type: "array"; readonly title: "The SalesRankings schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly ProductCategoryId: "1243"; readonly Rank: 1; }, { readonly ProductCategoryId: "1234"; readonly Rank: 2; }]]; readonly additionalItems: true; readonly items: { readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SalesRankings/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ProductCategoryId: "1243"; readonly Rank: 1; }]; readonly required: readonly ["ProductCategoryId", "Rank"]; readonly additionalProperties: true; readonly properties: { readonly ProductCategoryId: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SalesRankings/items/anyOf/0/properties/ProductCategoryId"; readonly type: "string"; readonly title: "The ProductCategoryId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1243"]; }; readonly Rank: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SalesRankings/items/anyOf/0/properties/Rank"; readonly type: "integer"; readonly title: "The Rank schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [1]; }; }; }]; readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/SalesRankings/items"; }; }; readonly NumberOfBuyBoxEligibleOffers: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfBuyBoxEligibleOffers"; readonly type: "array"; readonly title: "The NumberOfBuyBoxEligibleOffers schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 23; }, { readonly Condition: "used"; readonly FulfillmentChannel: "Amazon"; readonly OfferCount: 54; }]]; readonly additionalItems: true; readonly items: { readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfBuyBoxEligibleOffers/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Condition: "new"; readonly FulfillmentChannel: "Merchant"; readonly OfferCount: 23; }]; readonly required: readonly ["Condition", "FulfillmentChannel", "OfferCount"]; readonly additionalProperties: true; readonly properties: { readonly Condition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfBuyBoxEligibleOffers/items/anyOf/0/properties/Condition"; readonly type: "string"; readonly title: "The Condition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["new"]; }; readonly FulfillmentChannel: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfBuyBoxEligibleOffers/items/anyOf/0/properties/FulfillmentChannel"; readonly type: "string"; readonly title: "The FulfillmentChannel schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Merchant"]; }; readonly OfferCount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfBuyBoxEligibleOffers/items/anyOf/0/properties/OfferCount"; readonly type: "integer"; readonly title: "The OfferCount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [23]; }; }; }]; readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/NumberOfBuyBoxEligibleOffers/items"; }; }; readonly CompetitivePriceThreshold: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/CompetitivePriceThreshold"; readonly type: "object"; readonly title: "The CompetitivePriceThreshold schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 22; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/CompetitivePriceThreshold/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [22]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Summary/properties/CompetitivePriceThreshold/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; }; }; readonly Offers: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers"; readonly type: "array"; readonly title: "The Offers schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly SellerId: "111"; readonly SubCondition: "New"; readonly SellerFeedbackRating: { readonly FeedbackCount: 9; readonly SellerPositiveFeedbackRating: 10; }; readonly ShippingTime: { readonly MinimumHours: 10; readonly MaximumHours: 30; readonly AvailabilityType: "available"; readonly AvailableDate: "2020-07-13T19:42:04.284Z"; }; readonly ListingPrice: { readonly Amount: 23; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 33333; }; readonly Shipping: { readonly Amount: 110; readonly CurrencyCode: "USD"; }; readonly ShipsFrom: { readonly Country: "USA"; readonly State: "MI"; }; readonly IsFulfilledByAmazon: true; readonly PrimeInformation: { readonly IsOfferPrime: true; readonly IsOfferNationalPrime: false; }; readonly IsExpeditedShippingAvailable: true; readonly IsFeaturedMerchant: true; readonly ShipsDomestically: true; readonly ShipsInternationally: true; }]]; readonly additionalItems: true; readonly items: { readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly SellerId: "111"; readonly SubCondition: "New"; readonly SellerFeedbackRating: { readonly FeedbackCount: 9; readonly SellerPositiveFeedbackRating: 10; }; readonly ShippingTime: { readonly MinimumHours: 10; readonly MaximumHours: 30; readonly AvailabilityType: "available"; readonly AvailableDate: "2020-07-13T19:42:04.284Z"; }; readonly ListingPrice: { readonly Amount: 23; readonly CurrencyCode: "USD"; }; readonly Points: { readonly PointsNumber: 33333; }; readonly Shipping: { readonly Amount: 110; readonly CurrencyCode: "USD"; }; readonly ShipsFrom: { readonly Country: "USA"; readonly State: "MI"; }; readonly IsFulfilledByAmazon: true; readonly PrimeInformation: { readonly IsOfferPrime: true; readonly IsOfferNationalPrime: false; }; readonly IsExpeditedShippingAvailable: true; readonly IsFeaturedMerchant: true; readonly ShipsDomestically: true; readonly ShipsInternationally: true; }]; readonly required: readonly ["SellerId", "SubCondition", "SellerFeedbackRating", "ShippingTime", "ListingPrice", "Points", "Shipping", "ShipsFrom", "IsFulfilledByAmazon", "PrimeInformation", "IsExpeditedShippingAvailable", "IsFeaturedMerchant", "ShipsDomestically", "ShipsInternationally"]; readonly additionalProperties: true; readonly properties: { readonly SellerId: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/SellerId"; readonly type: "string"; readonly title: "The SellerId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["111"]; }; readonly SubCondition: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/SubCondition"; readonly type: "string"; readonly title: "The SubCondition schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["New"]; }; readonly SellerFeedbackRating: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/SellerFeedbackRating"; readonly type: "object"; readonly title: "The SellerFeedbackRating schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FeedbackCount: 9; readonly SellerPositiveFeedbackRating: 10; }]; readonly required: readonly ["FeedbackCount", "SellerPositiveFeedbackRating"]; readonly additionalProperties: true; readonly properties: { readonly FeedbackCount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/SellerFeedbackRating/properties/FeedbackCount"; readonly type: "integer"; readonly title: "The FeedbackCount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [9]; }; readonly SellerPositiveFeedbackRating: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/SellerFeedbackRating/properties/SellerPositiveFeedbackRating"; readonly type: "integer"; readonly title: "The SellerPositiveFeedbackRating schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; }; }; readonly ShippingTime: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShippingTime"; readonly type: "object"; readonly title: "The ShippingTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly MinimumHours: 10; readonly MaximumHours: 30; readonly AvailabilityType: "available"; readonly AvailableDate: "2020-07-13T19:42:04.284Z"; }]; readonly required: readonly ["MinimumHours", "MaximumHours", "AvailabilityType", "AvailableDate"]; readonly additionalProperties: true; readonly properties: { readonly MinimumHours: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShippingTime/properties/MinimumHours"; readonly type: "integer"; readonly title: "The MinimumHours schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly MaximumHours: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShippingTime/properties/MaximumHours"; readonly type: "integer"; readonly title: "The MaximumHours schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [30]; }; readonly AvailabilityType: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShippingTime/properties/AvailabilityType"; readonly type: "string"; readonly title: "The AvailabilityType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["available"]; }; readonly AvailableDate: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShippingTime/properties/AvailableDate"; readonly type: "string"; readonly title: "The AvailableDate schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; }; }; readonly ListingPrice: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ListingPrice"; readonly type: "object"; readonly title: "The ListingPrice schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 23; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ListingPrice/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [23]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ListingPrice/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly Points: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/Points"; readonly type: "object"; readonly title: "The Points schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly PointsNumber: 33333; }]; readonly required: readonly ["PointsNumber"]; readonly additionalProperties: true; readonly properties: { readonly PointsNumber: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/Points/properties/PointsNumber"; readonly type: "integer"; readonly title: "The PointsNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [33333]; }; }; }; readonly Shipping: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/Shipping"; readonly type: "object"; readonly title: "The Shipping schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 110; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly additionalProperties: true; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/Shipping/properties/Amount"; readonly type: "number"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [110]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/Shipping/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; }; readonly ShipsFrom: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShipsFrom"; readonly type: "object"; readonly title: "The ShipsFrom schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Country: "USA"; readonly State: "MI"; }]; readonly required: readonly ["Country", "State"]; readonly additionalProperties: true; readonly properties: { readonly Country: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShipsFrom/properties/Country"; readonly type: "string"; readonly title: "The Country schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USA"]; }; readonly State: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShipsFrom/properties/State"; readonly type: "string"; readonly title: "The State schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["MI"]; }; }; }; readonly IsFulfilledByAmazon: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/IsFulfilledByAmazon"; readonly type: "boolean"; readonly title: "The IsFulfilledByAmazon schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [true]; }; readonly PrimeInformation: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/PrimeInformation"; readonly type: "object"; readonly title: "The PrimeInformation schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly IsOfferPrime: true; readonly IsOfferNationalPrime: false; }]; readonly required: readonly ["IsOfferPrime", "IsOfferNationalPrime"]; readonly additionalProperties: true; readonly properties: { readonly IsOfferPrime: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/PrimeInformation/properties/IsOfferPrime"; readonly type: "boolean"; readonly title: "The IsOfferPrime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [true]; }; readonly IsOfferNationalPrime: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/PrimeInformation/properties/IsOfferNationalPrime"; readonly type: "boolean"; readonly title: "The IsOfferNationalPrime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [false]; }; }; }; readonly IsExpeditedShippingAvailable: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/IsExpeditedShippingAvailable"; readonly type: "boolean"; readonly title: "The IsExpeditedShippingAvailable schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [true]; }; readonly IsFeaturedMerchant: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/IsFeaturedMerchant"; readonly type: "boolean"; readonly title: "The IsFeaturedMerchant schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [true]; }; readonly ShipsDomestically: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShipsDomestically"; readonly type: "boolean"; readonly title: "The ShipsDomestically schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [true]; }; readonly ShipsInternationally: { readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items/anyOf/0/properties/ShipsInternationally"; readonly type: "boolean"; readonly title: "The ShipsInternationally schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: false; readonly examples: readonly [true]; }; }; }]; readonly $id: "#/properties/Payload/properties/AnyOfferChangedNotification/properties/Offers/items"; }; }; }; }; }; }; }; }; type AnyOfferChangedNotification = FromSchema; //#endregion //#region src/notifications/b-2-b-any-offer-changed-notification.d.ts 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 UTC) 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: "Indicates 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: "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 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: "Quantity Discount"; }]; }; readonly Points: { readonly type: "object"; readonly required: readonly ["PointsNumber"]; readonly additionalProperties: true; readonly properties: { readonly PointsNumber: { readonly type: "integer"; readonly description: "The number of Amazon Points offered with the purchase of an item"; }; }; }; 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 Points: { readonly $ref: "#/definitions/Points"; }; }; }; 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 Points: { readonly $ref: "#/definitions/Points"; }; 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 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 an 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 State: { readonly type: "string"; }; }; }; readonly PrimeInformation: { readonly type: "object"; readonly required: readonly ["IsPrime", "IsNationalPrime"]; readonly additionalProperties: true; readonly properties: { readonly IsPrime: { readonly type: "boolean"; readonly description: "Indicates whether the offer is an Amazon Prime offer"; }; readonly IsNationalPrime: { 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 Points: { readonly $ref: "#/definitions/Points"; }; 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: "Indicates whether the offer is fulfilled by Amazon"; }; readonly IsBuyBoxWinner: { readonly type: "boolean"; readonly description: "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"; }; readonly ConditionNotes: { readonly type: "string"; readonly description: "Information about the condition of the item"; }; readonly PrimeInformation: { readonly $ref: "#/definitions/PrimeInformation"; }; readonly IsFeaturedMerchant: { readonly type: "boolean"; readonly description: "Indicates whether 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 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 NotificationMetadata: { readonly $ref: "#/definitions/NotificationMetadata"; }; readonly Payload: { readonly $ref: "#/definitions/Payload"; }; }; }; }; }; type B2bAnyOfferChangedNotification = FromSchema; //#endregion //#region src/notifications/branded-item-content-change-notification.d.ts declare const brandedItemContentChangeNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "BRANDED_ITEM_CONTENT_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2019-03-20T18:59:30.194Z"; readonly Payload: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly BrandName: "Great Brand"; readonly Asin: "B1234567"; readonly AttributesChanged: readonly ["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"]; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["BRANDED_ITEM_CONTENT_CHANGE"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly MarketplaceId: "ATVPDKIKX0DER"; readonly BrandName: "Great Brand"; readonly Asin: "B1234567"; readonly AttributesChanged: readonly ["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"]; }]; readonly required: readonly ["MarketplaceId", "BrandName", "Asin", "AttributesChanged"]; readonly properties: { readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/MarketplaceId"; readonly type: "string"; readonly title: "The MarketplaceId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly BrandName: { readonly $id: "#/properties/Payload/properties/BrandName"; readonly type: "string"; readonly title: "The BrandName schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Great Brand"]; }; readonly Asin: { readonly $id: "#/properties/Payload/properties/Asin"; readonly type: "string"; readonly title: "The Asin schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["B1234567"]; }; readonly AttributesChanged: { readonly $id: "#/properties/Payload/properties/AttributesChanged"; readonly type: "array"; readonly items: { readonly type: "string"; }; readonly title: "Changed item attributes"; readonly description: "The array of item attributes which changed. Possible values include bullet_point, item_name, product_description, and image-related attributes shown in the examples. NOTE: the attributes that contain the word 'image' all mean the same thing right now, which is that one or more images changed on the product detail page. In a future release we may update them to mean that individual image attribute changed, but for now if any image changes all the image attributes will be present in the notification. Attribute names, descriptions, and requirements are available in the Product Type Definitions API."; readonly examples: readonly [readonly ["bullet_point", "item_name", "product_description"], readonly ["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"]]; }; }; readonly additionalProperties: true; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["8e009934-da2c-4f9c-9bc7-93f23b7e1f60"]; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; type BrandedItemContentChangeNotification = FromSchema; //#endregion //#region src/notifications/data-kiosk-query-processing-finished-notification.d.ts declare const dataKioskQueryProcessingFinishedNotification: { readonly type: "object"; readonly title: "Data Kiosk Query Processing Finished Notification."; readonly description: "This notification is delivered when a Data Kiosk query finishes processing."; readonly examples: readonly [{ readonly notificationVersion: "2023-11-15"; readonly notificationType: "DATA_KIOSK_QUERY_PROCESSING_FINISHED"; readonly payloadVersion: "2023-11-15"; readonly eventTime: "2023-12-23T21:30:13.713Z"; readonly payload: { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly queryId: "54517018502"; readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"; readonly processingStatus: "DONE"; readonly dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; readonly pagination: { readonly nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-12-23T21:30:16.903Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly description: "The notification version."; readonly examples: readonly ["2023-11-15"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly description: "The notification type."; readonly examples: readonly ["DATA_KIOSK_QUERY_PROCESSING_FINISHED"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly description: "The payload version of the notification."; readonly examples: readonly ["2023-11-15"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly description: "The time the notification was sent in ISO 8601 format."; readonly examples: readonly ["2023-12-23T21:30:13.713Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly type: "object"; readonly description: "The Data Kiosk query processing notification payload."; readonly examples: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly queryId: "54517018502"; readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"; readonly processingStatus: "DONE"; readonly dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; readonly pagination: { readonly nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz"; }; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly queryId: "54517018502"; readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"; readonly processingStatus: "DONE"; readonly dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly queryId: "54517018502"; readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"; readonly processingStatus: "DONE"; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly queryId: "54517018502"; readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"; readonly processingStatus: "CANCELLED"; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly queryId: "54517018502"; readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"; readonly processingStatus: "FATAL"; readonly errorDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }]; readonly required: readonly ["accountId", "queryId", "query", "processingStatus"]; readonly properties: { readonly accountId: { readonly $id: "#/properties/payload/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the query was submitted."; readonly examples: readonly ["amzn1.merchant.o.A21CXK3C4ERTY8", "amzn1.vg.6213651"]; }; readonly queryId: { readonly $id: "#/properties/payload/properties/queryId"; readonly type: "string"; readonly description: "The query identifier. This identifier is unique only in combination with the `accountId`."; readonly examples: readonly ["54517018502"]; }; readonly query: { readonly $id: "#/properties/payload/properties/query"; readonly type: "string"; readonly description: "The submitted query."; readonly examples: readonly ["query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"]; }; readonly processingStatus: { readonly $id: "#/properties/payload/properties/processingStatus"; readonly type: "string"; readonly description: "The processing status of the query."; readonly examples: readonly ["CANCELLED", "DONE", "FATAL"]; readonly enum: readonly ["CANCELLED", "DONE", "FATAL"]; }; readonly dataDocumentId: { readonly $id: "#/properties/payload/properties/dataDocumentId"; readonly type: "string"; readonly description: "The data document identifier. This document identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with the `accountId`. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document's contents."; readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"]; }; readonly errorDocumentId: { readonly $id: "#/properties/payload/properties/errorDocumentId"; readonly type: "string"; readonly description: "The error document identifier. This document identifier is only present when an error occurs during query processing. This identifier is unique only in combination with the `accountId`. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document's contents."; readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"]; }; readonly pagination: { readonly $id: "#/properties/payload/properties/pagination"; readonly type: "object"; readonly description: "When a query produces results that are not included in the data document, pagination occurs. This means that results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object's `nextToken` and with `query` set to this object's `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent."; readonly examples: readonly [{ readonly nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz"; }]; readonly properties: { readonly nextToken: { readonly $id: "#/properties/payload/properties/pagination/properties/nextToken"; readonly type: "string"; readonly description: "A token that can be used to fetch the next page of results."; readonly examples: readonly ["AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz"]; }; }; }; }; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly type: "object"; readonly description: "The notification's metadata."; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-12-23T21:30:16.903Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/properties/notificationMetadata/properties/applicationId"; readonly type: "string"; readonly description: "The application identifier."; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/properties/notificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly description: "The subscription identifier."; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/properties/notificationMetadata/properties/publishTime"; readonly type: "string"; readonly description: "The time the notification was published in ISO 8601 format."; readonly examples: readonly ["2023-12-23T21:30:16.903Z"]; }; readonly notificationId: { readonly $id: "#/properties/notificationMetadata/properties/notificationId"; readonly type: "string"; readonly description: "The notification identifier."; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type DataKioskQueryProcessingFinishedNotification = FromSchema; //#endregion //#region src/notifications/detail-page-traffic-event-notification.d.ts declare const detailPageTrafficEventNotification: { readonly $id: "https://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly notificationVersion: "2020-09-04"; readonly notificationType: "DETAIL_PAGE_TRAFFIC_EVENT"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2023-02-07T16:05:32.378Z"; readonly payload: { readonly detailPageTrafficEvents: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly glanceViews: 69; }]; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly examples: readonly ["DETAIL_PAGE_TRAFFIC_EVENT"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly $ref: "#/definitions/Payload"; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly $ref: "#/definitions/NotificationMetadata"; }; }; readonly definitions: { readonly Payload: { readonly type: "object"; readonly examples: readonly [{ readonly detailPageTrafficEvents: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly glanceViews: 69; }]; }]; readonly required: readonly ["detailPageTrafficEvents"]; readonly properties: { readonly detailPageTrafficEvents: { readonly $id: "#/definitions/Payload/properties/detailPageTrafficEvents"; readonly $ref: "#/definitions/DetailPageTrafficEvents"; }; }; }; readonly DetailPageTrafficEvents: { readonly type: "array"; readonly examples: readonly [readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly glanceViews: 69; }]]; readonly items: { readonly $ref: "#/definitions/DetailPageTrafficEvent"; }; }; readonly DetailPageTrafficEvent: { readonly type: "object"; readonly examples: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }]; readonly required: readonly ["accountId", "marketplaceId", "startTime", "endTime", "asin", "glanceViews"]; readonly properties: { readonly accountId: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer ID or vendor group ID of the partner account this notification is sent to."; readonly examples: readonly ["amzn1.merchant.o.A21CXK3C4ERTY8", "amzn1.vg.6213651"]; }; readonly marketplaceId: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/marketplaceId"; readonly type: "string"; readonly description: "The marketplace identifier of the traffic data."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly startTime: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/startTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The start of the date-time range of the traffic data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T15:00:00Z"]; }; readonly endTime: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/endTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The end of the date-time range of the traffic data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T16:00:00Z"]; }; readonly asin: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/asin"; readonly type: "string"; readonly description: "The Amazon Standard Identification Number of the product."; readonly examples: readonly ["B00032HE0O"]; }; readonly glanceViews: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/glanceViews"; readonly type: "integer"; readonly description: "The number of customer views of the product detail page for this ASIN."; readonly minimum: 0; readonly examples: readonly [42]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/definitions/NotificationMetadata/properties/applicationId"; readonly type: "string"; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/definitions/NotificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/definitions/NotificationMetadata/properties/publishTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly notificationId: { readonly $id: "#/definitions/NotificationMetadata/properties/notificationId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type DetailPageTrafficEventNotification = FromSchema; //#endregion //#region src/notifications/fba-inventory-availability-change-notification.d.ts declare const fbaInventoryAvailabilityChangeNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "Notification Version"; readonly description: "The version of this notification."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "Notification Type"; readonly description: "The type of this notification"; readonly enum: readonly ["FBA_INVENTORY_AVAILABILITY_CHANGES"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "Payload Version"; readonly description: "The version of the payload."; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly format: "date-time"; readonly title: "Event Time"; readonly description: "Timestamp of the event. Formatted as ISO 8601 date-time."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "Payload"; readonly description: "The details of this notification."; readonly additionalProperties: true; readonly required: readonly ["SellerId", "FNSKU", "ASIN", "SKU", "FulfillmentInventoryByMarketplace"]; readonly examples: readonly [{ readonly SellerId: "A3TH9S8BH6GOGM"; readonly FNSKU: "X001ABCDEF"; readonly ASIN: "B00001ABCD"; readonly SKU: "SELLERSKU-1"; readonly FulfillmentInventoryByMarketplace: readonly [{ readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ItemName: "Product Title"; readonly FulfillmentInventory: { readonly InboundQuantityBreakdown: { readonly Working: 0; readonly Shipped: 5; readonly Receiving: 10; }; readonly Fulfillable: 50; readonly Unfulfillable: 0; readonly Researching: 0; readonly ReservedQuantityBreakdown: { readonly WarehouseProcessing: 5; readonly WarehouseTransfer: 15; readonly PendingCustomerOrder: 10; }; readonly FutureSupplyBuyable: 10; readonly PendingCustomerOrderInTransit: 0; }; readonly Stores: readonly ["Low-Cost Store"]; }, { readonly MarketplaceId: "A2EUQ1WTGCTBG2"; readonly ItemName: "Product Title"; readonly FulfillmentInventory: { readonly InboundQuantityBreakdown: { readonly Working: 1; readonly Shipped: 2; readonly Receiving: 3; }; readonly Fulfillable: 40; readonly Unfulfillable: 0; readonly Researching: 0; readonly ReservedQuantityBreakdown: { readonly WarehouseProcessing: 5; readonly WarehouseTransfer: 15; readonly PendingCustomerOrder: 10; }; readonly FutureSupplyBuyable: 0; readonly PendingCustomerOrderInTransit: 0; }; readonly Stores: readonly ["Low-Cost Store"]; }]; }]; readonly properties: { readonly SellerId: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/SellerId"; readonly type: "string"; readonly title: "Seller Id"; readonly description: "Selling partner identifier, such as a merchant account, for the affected inventory item."; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly FNSKU: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FNSKU"; readonly type: "string"; readonly title: "FNSKU"; readonly description: "The Fulfillment Network SKU of the affected inventory item."; readonly examples: readonly ["X001ABCDEF"]; }; readonly ASIN: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/ASIN"; readonly type: "string"; readonly title: "ASIN"; readonly description: "Amazon Standard Identification Number of the affected inventory item."; readonly examples: readonly ["B00001ABCD"]; }; readonly SKU: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/SKU"; readonly type: "string"; readonly title: "SKU"; readonly description: "Seller SKU of the affected inventory item."; readonly examples: readonly ["SELLERSKU-1"]; }; readonly FulfillmentInventoryByMarketplace: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace"; readonly type: "array"; readonly title: "Fulfillment Inventory Details By Marketplace"; readonly description: "List of Fulfillment Inventory Details for each marketplace."; readonly examples: readonly [readonly [{ readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ItemName: "Product Title"; readonly FulfillmentInventory: { readonly InboundQuantityBreakdown: { readonly Working: 0; readonly Shipped: 5; readonly Receiving: 10; }; readonly Fulfillable: 50; readonly Unfulfillable: 0; readonly Researching: 0; readonly ReservedQuantityBreakdown: { readonly WarehouseProcessing: 5; readonly WarehouseTransfer: 15; readonly PendingCustomerOrder: 10; }; readonly FutureSupplyBuyable: 10; readonly PendingCustomerOrderInTransit: 0; }; readonly Stores: readonly ["Low-Cost Store"]; }, { readonly MarketplaceId: "A2EUQ1WTGCTBG2"; readonly ItemName: "Product Title"; readonly FulfillmentInventory: { readonly InboundQuantityBreakdown: { readonly Working: 1; readonly Shipped: 2; readonly Receiving: 3; }; readonly Fulfillable: 40; readonly Unfulfillable: 0; readonly Researching: 0; readonly ReservedQuantityBreakdown: { readonly WarehouseProcessing: 5; readonly WarehouseTransfer: 15; readonly PendingCustomerOrder: 10; }; readonly FutureSupplyBuyable: 0; readonly PendingCustomerOrderInTransit: 0; }; readonly Stores: readonly ["Low-Cost Store"]; }]]; readonly items: { readonly type: "object"; readonly required: readonly ["MarketplaceId", "ItemName", "FulfillmentInventory"]; readonly additionalProperties: true; readonly properties: { readonly MarketplaceId: { readonly type: "string"; readonly title: "MarketplaceId"; readonly description: "The marketplace identifier for the destination where the affected inventory can be used to fulfill the order."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly ItemName: { readonly type: "string"; readonly title: "Item Name"; readonly description: "The product title of the affected inventory item."; readonly examples: readonly ["Product Title"]; }; readonly FulfillmentInventory: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory"; readonly type: "object"; readonly title: "Fulfillment Inventory Details"; readonly description: "Detail of the affected item's inventory availability"; readonly examples: readonly [{ readonly InboundQuantityBreakdown: { readonly Working: 0; readonly Shipped: 5; readonly Receiving: 10; }; readonly Fulfillable: 50; readonly Unfulfillable: 0; readonly Researching: 0; readonly ReservedQuantityBreakdown: { readonly WarehouseProcessing: 5; readonly WarehouseTransfer: 15; readonly PendingCustomerOrder: 10; }; readonly FutureSupplyBuyable: 10; readonly PendingCustomerOrderInTransit: 0; }]; readonly required: readonly ["InboundQuantityBreakdown", "Fulfillable", "Unfulfillable", "Researching", "ReservedQuantityBreakdown", "FutureSupplyBuyable", "PendingCustomerOrderInTransit"]; readonly properties: { readonly InboundQuantityBreakdown: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown"; readonly type: "object"; readonly title: "Inbound Quantity Breakdown"; readonly description: "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."; readonly examples: readonly [{ readonly Working: 0; readonly Shipped: 5; readonly Receiving: 10; }]; readonly required: readonly ["Working", "Shipped", "Receiving"]; readonly properties: { readonly Working: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/Working"; readonly type: "integer"; readonly title: "Working"; readonly description: "The number of units of the affected item that are currently residing in a WORKING status shipment."; readonly examples: readonly [0]; }; readonly Shipped: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/Shipped"; readonly type: "integer"; readonly title: "Shipped"; readonly description: "The number of units of the affected item that are currently residing in a SHIPPED, IN_TRANSIT, DELIVERED or CHECKED_IN status shipment."; readonly examples: readonly [0]; }; readonly Receiving: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/Receiving"; readonly type: "integer"; readonly title: "Receiving"; readonly description: "The number of units of the affected item that has arrived and are in progress to be received in Amazon warehouses."; readonly examples: readonly [0]; }; }; readonly additionalProperties: true; }; readonly Fulfillable: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/Fulfillable"; readonly type: "integer"; readonly title: "Fulfillable"; readonly description: "The number of units of the affected item that can be used to fulfill orders in the given marketplace."; readonly examples: readonly [0]; }; readonly Unfulfillable: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/Unfulfillable"; readonly type: "integer"; readonly title: "Unfulfillable"; readonly description: "The number of units of the affected item that can not be used to fulfill orders due to the item's current disposition."; readonly default: 0; readonly examples: readonly [0]; }; readonly Researching: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/Unfulfillable"; readonly type: "integer"; readonly title: "Researching"; readonly description: "The number of units of the affected item that are currently being investigated upon adjustments."; readonly default: 0; readonly examples: readonly [0]; }; readonly ReservedQuantityBreakdown: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/ReservedQuantityBreakdown"; readonly type: "object"; readonly title: "Reserved Quantity Breakdown"; readonly description: "Details of the inventory that is temporarily undergoing internal processes."; readonly examples: readonly [{ readonly WarehouseProcessing: 5; readonly WarehouseTransfer: 15; readonly PendingCustomerOrder: 10; }]; readonly required: readonly ["WarehouseProcessing", "WarehouseTransfer", "PendingCustomerOrder"]; readonly properties: { readonly WarehouseProcessing: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/WarehouseProcessing"; readonly type: "integer"; readonly title: "Warehouse Processing"; readonly description: "The number of units of the affected item that are temporarily sidelined for internal processing."; readonly default: 0; readonly examples: readonly [0]; }; readonly WarehouseTransfer: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/WarehouseTransfer"; readonly type: "integer"; readonly title: "Warehouse Transfer"; readonly description: "The number of units of the affected item that are in progress to be trans-shipped to another Amazon Warehouse location."; readonly default: 0; readonly examples: readonly [0]; }; readonly PendingCustomerOrder: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/PendingCustomerOrder"; readonly type: "integer"; readonly title: "Pending Customer Orders"; readonly description: "The number of units of the affected item that will soon be shipped out as customer order shipment."; readonly default: 0; readonly examples: readonly [0]; }; }; readonly additionalProperties: true; }; readonly FutureSupplyBuyable: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/FutureSupplyBuyable"; readonly type: "integer"; readonly title: "Future Supply Buyable"; readonly description: "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."; readonly default: 0; readonly examples: readonly [0]; }; readonly PendingCustomerOrderInTransit: { readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/PendingCustomerOrderInTransit"; readonly type: "integer"; readonly title: "Pending Customer Order In Transit"; readonly description: "The number of units that customers have purchased while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start"; readonly default: 0; readonly examples: readonly [0]; }; }; }; readonly Stores: { readonly type: "array"; readonly title: "Stores"; readonly description: "List of seller-enrolled stores for the affected inventory item."; readonly examples: readonly [readonly ["Low-Cost Store"], readonly []]; }; }; }; }; }; }; }; readonly additionalProperties: true; }; type FBAInventoryAvailabilityChangeNotification = FromSchema; //#endregion //#region src/notifications/fba-outbound-shipment-status-notification.d.ts declare const fbaOutboundShipmentStatusNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "FBA_OUTBOUND_SHIPMENT_STATUS"; readonly PayloadVersion: "1.0"; readonly EventTime: "2020-01-11T00:09:53.109Z"; readonly Payload: { readonly FBAOutboundShipmentStatusNotification: { readonly SellerId: "merchantId"; readonly AmazonOrderId: "113-2646096-4474645"; readonly AmazonShipmentId: "DrLqQwqvb"; readonly ShipmentStatus: "Created"; }; }; readonly NotificationMetadata: { readonly ApplicationId: "appId"; readonly SubscriptionId: "subId"; readonly PublishTime: "2020-01-11T00:02:50.501Z"; readonly NotificationId: "requestId"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "NotificationMetadata", "Payload"]; readonly additionalProperties: true; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; }; }; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly required: readonly ["FBAOutboundShipmentStatusNotification"]; readonly properties: { readonly FBAOutboundShipmentStatusNotification: { readonly $id: "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification"; readonly type: "object"; readonly required: readonly ["SellerId", "AmazonOrderId", "AmazonShipmentId", "ShipmentStatus"]; readonly properties: { readonly SellerId: { readonly $id: "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/SellerId"; readonly type: "string"; }; readonly AmazonOrderId: { readonly $id: "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/AmazonOrderId"; readonly type: "string"; }; readonly AmazonShipmentId: { readonly $id: "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/AmazonShipmentId"; readonly type: "string"; }; readonly ShipmentStatus: { readonly $id: "#/properties/Payload/properties/FBAOutboundShipmentStatusNotification/properties/ShipmentStatus"; readonly type: "string"; }; }; }; }; }; }; }; type FBAOutboundShipmentStatusNotification = FromSchema; //#endregion //#region src/notifications/fee-promotion-notification.d.ts declare const feePromotionNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "FEE_PROMOTION"; readonly PayloadVersion: "1.0"; readonly EventTime: "2020-07-13T19:42:04.284Z"; readonly NotificationMetadata: { readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; readonly Payload: { readonly FeePromotionNotification: { readonly MerchantId: "AJH434853485"; readonly MarketplaceId: "ATIV93840DER"; readonly FeePromotionType: "TYPE"; readonly FeePromotionTypeDescription: "Fee promotion type description"; readonly PromotionActiveTimeRange: { readonly EffectiveFromDate: "2020-07-13T19:42:04.284Z"; readonly EffectiveThroughDate: "2020-07-13T19:42:04.284Z"; }; readonly Identifiers: readonly [{ readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }, { readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }]; readonly PromotionInformation: readonly [{ readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }, { readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }]; }; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "NotificationMetadata", "Payload"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["FEE_PROMOTION"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; readonly additionalProperties: true; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FeePromotionNotification: { readonly MerchantId: "AJH434853485"; readonly MarketplaceId: "ATIV93840DER"; readonly FeePromotionType: "TYPE"; readonly FeePromotionTypeDescription: "Fee promotion type description"; readonly PromotionActiveTimeRange: { readonly EffectiveFromDate: "2020-07-13T19:42:04.284Z"; readonly EffectiveThroughDate: "2020-07-13T19:42:04.284Z"; }; readonly Identifiers: readonly [{ readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }, { readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }]; readonly PromotionInformation: readonly [{ readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }, { readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }]; }; }]; readonly required: readonly ["FeePromotionNotification"]; readonly properties: { readonly FeePromotionNotification: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification"; readonly type: "object"; readonly title: "The FeePromotionNotification schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly MerchantId: "AJH434853485"; readonly MarketplaceId: "ATIV93840DER"; readonly FeePromotionType: "TYPE"; readonly FeePromotionTypeDescription: "Fee promotion type description"; readonly PromotionActiveTimeRange: { readonly EffectiveFromDate: "2020-07-13T19:42:04.284Z"; readonly EffectiveThroughDate: "2020-07-13T19:42:04.284Z"; }; readonly Identifiers: readonly [{ readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }, { readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }]; readonly PromotionInformation: readonly [{ readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }, { readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }]; }]; readonly required: readonly ["MerchantId", "MarketplaceId", "FeePromotionType", "FeePromotionTypeDescription", "PromotionActiveTimeRange", "Identifiers", "PromotionInformation"]; readonly properties: { readonly MerchantId: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/MerchantId"; readonly type: "string"; readonly title: "The MerchantId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["AJH434853485"]; }; readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/MarketplaceId"; readonly type: "string"; readonly title: "The MarketplaceId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ATIV93840DER"]; }; readonly FeePromotionType: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/FeePromotionType"; readonly type: "string"; readonly title: "The FeePromotionType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["TYPE"]; }; readonly FeePromotionTypeDescription: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/FeePromotionTypeDescription"; readonly type: "string"; readonly title: "The FeePromotionTypeDescription schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["Fee promotion type description"]; }; readonly PromotionActiveTimeRange: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionActiveTimeRange"; readonly type: "object"; readonly title: "The PromotionActiveTimeRange schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly EffectiveFromDate: "2020-07-13T19:42:04.284Z"; readonly EffectiveThroughDate: "2020-07-13T19:42:04.284Z"; }]; readonly required: readonly ["EffectiveFromDate", "EffectiveThroughDate"]; readonly properties: { readonly EffectiveFromDate: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionActiveTimeRange/properties/EffectiveFromDate"; readonly type: "string"; readonly title: "The EffectiveFromDate schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly EffectiveThroughDate: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionActiveTimeRange/properties/EffectiveThroughDate"; readonly type: "string"; readonly title: "The EffectiveThroughDate schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; }; readonly additionalProperties: true; }; readonly Identifiers: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers"; readonly type: "array"; readonly title: "The Identifiers schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }, { readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }]]; readonly additionalItems: true; readonly items: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items"; readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly IdentifierType: "identifierType"; readonly IdentifierValues: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]; }]; readonly required: readonly ["IdentifierType", "IdentifierValues"]; readonly properties: { readonly IdentifierType: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0/properties/IdentifierType"; readonly type: "string"; readonly title: "The IdentifierType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["identifierType"]; }; readonly IdentifierValues: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0/properties/IdentifierValues"; readonly type: "array"; readonly title: "The IdentifierValues schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }, { readonly IdentifierValueId: "identifierValueId2"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName2"; }]]; readonly additionalItems: true; readonly items: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0/properties/IdentifierValues/items"; readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0/properties/IdentifierValues/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly IdentifierValueId: "identifierValueId1"; readonly IdentifierValueFriendlyName: "identifierValueFriendlyName1"; }]; readonly required: readonly ["IdentifierValueId", "IdentifierValueFriendlyName"]; readonly properties: { readonly IdentifierValueId: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0/properties/IdentifierValues/items/anyOf/0/properties/IdentifierValueId"; readonly type: "string"; readonly title: "The IdentifierValueId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["identifierValueId1"]; }; readonly IdentifierValueFriendlyName: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/Identifiers/items/anyOf/0/properties/IdentifierValues/items/anyOf/0/properties/IdentifierValueFriendlyName"; readonly type: "string"; readonly title: "The IdentifierValueFriendlyName schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["identifierValueFriendlyName1"]; }; }; readonly additionalProperties: true; }]; }; }; }; readonly additionalProperties: true; }]; }; }; readonly PromotionInformation: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation"; readonly type: "array"; readonly title: "The PromotionInformation schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }, { readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }]]; readonly additionalItems: true; readonly items: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items"; readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FeeType: "FeeType"; readonly FeeDiscountType: "FeeDiscountType"; readonly FeeDiscountValue: 10.3; readonly PriceThreshold: { readonly Amount: 60; readonly CurrencyCode: "USD"; }; readonly FeeDiscountMonetaryAmount: { readonly Amount: 70; readonly CurrencyCode: "USD"; }; readonly FeesEstimate: { readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }; }]; readonly required: readonly ["FeeType", "FeeDiscountType", "FeeDiscountValue", "PriceThreshold", "FeeDiscountMonetaryAmount", "FeesEstimate"]; readonly properties: { readonly FeeType: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeeType"; readonly type: "string"; readonly title: "The FeeType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["FeeType"]; }; readonly FeeDiscountType: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeeDiscountType"; readonly type: "string"; readonly title: "The FeeDiscountType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["FeeDiscountType"]; }; readonly FeeDiscountValue: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeeDiscountValue"; readonly type: "number"; readonly title: "The FeeDiscountValue schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10.3]; }; readonly PriceThreshold: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/PriceThreshold"; readonly type: "object"; readonly title: "The PriceThreshold schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 60; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/PriceThreshold/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [60]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/PriceThreshold/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FeeDiscountMonetaryAmount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeeDiscountMonetaryAmount"; readonly type: "object"; readonly title: "The FeeDiscountMonetaryAmount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 70; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeeDiscountMonetaryAmount/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [70]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeeDiscountMonetaryAmount/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FeesEstimate: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate"; readonly type: "object"; readonly title: "The FeesEstimate schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly TimeOfFeesEstimated: "2020-07-13T19:42:04.284Z"; readonly TotalFeesEstimate: { readonly Amount: 90; readonly CurrencyCode: "USD"; }; readonly FeeDetails: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; }]; readonly required: readonly ["TimeOfFeesEstimated", "TotalFeesEstimate", "FeeDetails"]; readonly properties: { readonly TimeOfFeesEstimated: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/TimeOfFeesEstimated"; readonly type: "string"; readonly title: "The TimeOfFeesEstimated schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly TotalFeesEstimate: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/TotalFeesEstimate"; readonly type: "object"; readonly title: "The TotalFeesEstimate schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 90; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/TotalFeesEstimate/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [90]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/TotalFeesEstimate/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FeeDetails: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails"; readonly type: "array"; readonly title: "The FeeDetails schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]]; readonly additionalItems: true; readonly items: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items"; readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; readonly IncludedFees: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; }]; readonly required: readonly ["FeeType", "FeeAmount", "TaxAmount", "FeePromotion", "FinalFee", "IncludedFees"]; readonly properties: { readonly FeeType: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeeType"; readonly type: "string"; readonly title: "The FeeType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["feeType"]; }; readonly FeeAmount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeeAmount"; readonly type: "object"; readonly title: "The FeeAmount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeeAmount/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeeAmount/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly TaxAmount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/TaxAmount"; readonly type: "object"; readonly title: "The TaxAmount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 20; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/TaxAmount/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [20]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/TaxAmount/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FeePromotion: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeePromotion"; readonly type: "object"; readonly title: "The FeePromotion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 30; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeePromotion/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [30]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FeePromotion/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FinalFee: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FinalFee"; readonly type: "object"; readonly title: "The FinalFee schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 40; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FinalFee/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [40]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/FinalFee/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly IncludedFees: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees"; readonly type: "array"; readonly title: "The IncludedFees schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }, { readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]]; readonly additionalItems: true; readonly items: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items"; readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FeeType: "feeType"; readonly FeeAmount: { readonly Amount: 10; readonly CurrencyCode: "USD"; }; readonly TaxAmount: { readonly Amount: 20; readonly CurrencyCode: "USD"; }; readonly FeePromotion: { readonly Amount: 30; readonly CurrencyCode: "USD"; }; readonly FinalFee: { readonly Amount: 40; readonly CurrencyCode: "USD"; }; }]; readonly required: readonly ["FeeType", "FeeAmount", "TaxAmount", "FeePromotion", "FinalFee"]; readonly properties: { readonly FeeType: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeeType"; readonly type: "string"; readonly title: "The FeeType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["feeType"]; }; readonly FeeAmount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeeAmount"; readonly type: "object"; readonly title: "The FeeAmount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeeAmount/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeeAmount/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly TaxAmount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/TaxAmount"; readonly type: "object"; readonly title: "The TaxAmount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 20; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/TaxAmount/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [20]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/TaxAmount/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FeePromotion: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeePromotion"; readonly type: "object"; readonly title: "The FeePromotion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 30; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeePromotion/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [30]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FeePromotion/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; readonly FinalFee: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FinalFee"; readonly type: "object"; readonly title: "The FinalFee schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly Amount: 40; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["Amount", "CurrencyCode"]; readonly properties: { readonly Amount: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FinalFee/properties/Amount"; readonly type: "integer"; readonly title: "The Amount schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [40]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/FeePromotionNotification/properties/PromotionInformation/items/anyOf/0/properties/FeesEstimate/properties/FeeDetails/items/anyOf/0/properties/IncludedFees/items/anyOf/0/properties/FinalFee/properties/CurrencyCode"; readonly type: "string"; readonly title: "The CurrencyCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["USD"]; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }]; }; }; }; readonly additionalProperties: true; }]; }; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }]; }; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; type FeePromotionNotification = FromSchema; //#endregion //#region src/notifications/feed-processing-finished-notification.d.ts declare const feedProcessingFinishedNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly notificationVersion: "2020-09-04"; readonly notificationType: "FEED_PROCESSING_FINISHED"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2020-07-13T19:42:04.284Z"; readonly payload: { readonly feedProcessingFinishedNotification: { readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly feedId: "53347018456"; readonly feedType: "POST_PRODUCT_DATA"; readonly processingStatus: "DONE"; readonly resultFeedDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }, { readonly notificationVersion: "2020-09-04"; readonly notificationType: "FEED_PROCESSING_FINISHED"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2020-07-13T19:42:04.284Z"; readonly payload: { readonly feedProcessingFinishedNotification: { readonly accountId: "amzn1.vg.6213651"; readonly feedId: "53347018456"; readonly feedType: "POST_PRODUCT_DATA"; readonly processingStatus: "DONE"; readonly resultFeedDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly description: "The version of the notification."; readonly examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly description: "The type of the notification."; readonly examples: readonly ["FEED_PROCESSING_FINISHED"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly description: "The version of the payload."; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly description: "The timestamp of the event, formatted as ISO 8601 date-time."; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly type: "object"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly feedProcessingFinishedNotification: { readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly feedId: "53347018456"; readonly feedType: "POST_PRODUCT_DATA"; readonly processingStatus: "DONE"; readonly resultFeedDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"; }; }, { readonly feedProcessingFinishedNotification: { readonly accountId: "amzn1.vg.6213651"; readonly feedId: "53347018456"; readonly feedType: "POST_PRODUCT_DATA"; readonly processingStatus: "DONE"; readonly resultFeedDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"; }; }]; readonly required: readonly ["feedProcessingFinishedNotification"]; readonly properties: { readonly feedProcessingFinishedNotification: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification"; readonly type: "object"; readonly description: "An explanation about the purpose of this instance."; readonly examples: readonly [{ readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly feedId: "53347018456"; readonly feedType: "POST_PRODUCT_DATA"; readonly processingStatus: "DONE"; readonly resultFeedDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"; }, { readonly accountId: "amzn1.vg.6213651"; readonly feedId: "53347018456"; readonly feedType: "POST_PRODUCT_DATA"; readonly processingStatus: "DONE"; readonly resultFeedDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"; }]; readonly required: readonly ["accountId", "feedId", "feedType", "processingStatus"]; readonly properties: { readonly sellerId: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification/properties/sellerId"; readonly type: "string"; readonly description: "The 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."; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly accountId: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the feed was submitted."; readonly examples: readonly ["amzn1.merchant.o.A3TH9S8BH6GOGM", "amzn1.vg.6213651"]; }; readonly feedId: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedId"; readonly type: "string"; readonly description: "The feed identifier."; readonly examples: readonly ["53347018456"]; }; readonly feedType: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification/properties/feedType"; readonly type: "string"; readonly description: "The feed type."; readonly examples: readonly ["POST_PRODUCT_DATA"]; }; readonly processingStatus: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification/properties/processingStatus"; readonly type: "string"; readonly description: "The processing status of the feed."; readonly examples: readonly ["CANCELLED", "DONE", "FATAL"]; readonly enum: readonly ["CANCELLED", "DONE", "FATAL"]; }; readonly resultFeedDocumentId: { readonly $id: "#/properties/payload/properties/feedProcessingFinishedNotification/properties/resultFeedDocumentId"; readonly type: "string"; readonly description: "The feed document identifier. This identifier is unique only in combination with a seller ID."; readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"]; }; }; }; }; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly type: "object"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/properties/notificationMetadata/properties/applicationId"; readonly type: "string"; readonly description: "The application identifier."; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746"]; }; readonly subscriptionId: { readonly $id: "#/properties/notificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly description: "The subscription identifier."; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/properties/notificationMetadata/properties/publishTime"; readonly type: "string"; readonly description: "The timestamp of when the notification was published, formatted as ISO 8601 date-time."; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly notificationId: { readonly $id: "#/properties/notificationMetadata/properties/notificationId"; readonly type: "string"; readonly description: "The notification identifier."; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type FeedProcessingFinishedNotification = FromSchema; //#endregion //#region src/notifications/fulfillment-order-status-notification.d.ts declare const fulfillmentOrderStatusNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "FULFILLMENT_ORDER_STATUS"; readonly PayloadVersion: "1.0"; readonly EventTime: "2020-07-13T19:42:04.284Z"; readonly Payload: { readonly FulfillmentOrderStatusNotification: { readonly SellerId: "A3TH9S8BH6GOGM"; readonly EventType: "TYPE3945"; readonly StatusUpdatedDateTime: "2020-07-13T19:42:04.284Z"; readonly SellerFulfillmentOrderId: "SFOID2345"; readonly FulfillmentOrderStatus: "PROCESSED"; readonly FulfillmentShipment: { readonly FulfillmentShipmentStatus: "PROCESSED"; readonly AmazonShipmentId: "ASID49535"; readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z"; readonly info: { readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }; readonly FulfillmentShipmentPackages: readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 2; readonly CarrierCode: "1-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 3; readonly CarrierCode: "3-930434"; readonly TrackingNumber: "1Z885647654573405"; }]; }; readonly FulfillmentReturnItem: { readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z"; readonly ReturnedQuantity: 12; readonly SellerSKU: "SELLERSKU9345"; }; }; }; readonly NotificationMetadata: { readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["FULFILLMENT_ORDER_STATUS"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FulfillmentOrderStatusNotification: { readonly SellerId: "A3TH9S8BH6GOGM"; readonly EventType: "TYPE3945"; readonly StatusUpdatedDateTime: "2020-07-13T19:42:04.284Z"; readonly SellerFulfillmentOrderId: "SFOID2345"; readonly FulfillmentOrderStatus: "PROCESSED"; readonly FulfillmentShipment: { readonly FulfillmentShipmentStatus: "PROCESSED"; readonly AmazonShipmentId: "ASID49535"; readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z"; readonly info: { readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }; readonly FulfillmentShipmentPackages: readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 2; readonly CarrierCode: "1-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 3; readonly CarrierCode: "3-930434"; readonly TrackingNumber: "1Z885647654573405"; }]; }; readonly FulfillmentReturnItem: { readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z"; readonly ReturnedQuantity: 12; readonly SellerSKU: "SELLERSKU9345"; }; }; }]; readonly required: readonly ["FulfillmentOrderStatusNotification"]; readonly properties: { readonly FulfillmentOrderStatusNotification: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification"; readonly type: "object"; readonly title: "The FulfillmentOrderStatusNotification schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly SellerId: "A3TH9S8BH6GOGM"; readonly EventType: "TYPE3945"; readonly StatusUpdatedDateTime: "2020-07-13T19:42:04.284Z"; readonly SellerFulfillmentOrderId: "SFOID2345"; readonly FulfillmentOrderStatus: "PROCESSED"; readonly FulfillmentShipment: { readonly FulfillmentShipmentStatus: "PROCESSED"; readonly AmazonShipmentId: "ASID49535"; readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z"; readonly info: { readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }; readonly FulfillmentShipmentPackages: readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 2; readonly CarrierCode: "1-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 3; readonly CarrierCode: "3-930434"; readonly TrackingNumber: "1Z885647654573405"; }]; }; readonly FulfillmentReturnItem: { readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z"; readonly ReturnedQuantity: 12; readonly SellerSKU: "SELLERSKU9345"; }; }]; readonly required: readonly ["SellerId", "EventType", "StatusUpdatedDateTime", "SellerFulfillmentOrderId", "FulfillmentOrderStatus", "FulfillmentShipment", "FulfillmentReturnItem"]; readonly properties: { readonly SellerId: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/SellerId"; readonly type: "string"; readonly title: "The SellerId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly EventType: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/EventType"; readonly type: "string"; readonly title: "The EventType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["TYPE3945"]; }; readonly StatusUpdatedDateTime: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/StatusUpdatedDateTime"; readonly type: "string"; readonly title: "The StatusUpdatedDateTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly SellerFulfillmentOrderId: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/SellerFulfillmentOrderId"; readonly type: "string"; readonly title: "The SellerFulfillmentOrderId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["SFOID2345"]; }; readonly FulfillmentOrderStatus: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentOrderStatus"; readonly type: "string"; readonly title: "The FulfillmentOrderStatus schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["PROCESSED"]; }; readonly FulfillmentShipment: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment"; readonly type: "object"; readonly title: "The FulfillmentShipment schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly FulfillmentShipmentStatus: "PROCESSED"; readonly AmazonShipmentId: "ASID49535"; readonly EstimatedArrivalDateTime: "2020-07-13T19:42:04.284Z"; readonly info: { readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }; readonly FulfillmentShipmentPackages: readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 2; readonly CarrierCode: "1-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 3; readonly CarrierCode: "3-930434"; readonly TrackingNumber: "1Z885647654573405"; }]; }]; readonly required: readonly ["FulfillmentShipmentStatus", "AmazonShipmentId", "EstimatedArrivalDateTime", "info", "FulfillmentShipmentPackages"]; readonly properties: { readonly FulfillmentShipmentStatus: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentStatus"; readonly type: "string"; readonly title: "The FulfillmentShipmentStatus schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["PROCESSED"]; }; readonly AmazonShipmentId: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/AmazonShipmentId"; readonly type: "string"; readonly title: "The AmazonShipmentId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ASID49535"]; }; readonly EstimatedArrivalDateTime: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/EstimatedArrivalDateTime"; readonly type: "string"; readonly title: "The EstimatedArrivalDateTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly FulfillmentShipmentPackages: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages"; readonly type: "array"; readonly title: "The FulfillmentShipmentPackages schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: readonly []; readonly examples: readonly [readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }, { readonly PackageNumber: 2; readonly CarrierCode: "1-930434"; readonly TrackingNumber: "1Z84456456573405"; }]]; readonly properties: { readonly FulfillmentShipmentPackageItem: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/properties/FulfillmentShipmentPackageItem"; readonly type: "object"; readonly title: "The info schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }]; readonly required: readonly ["PackageNumber", "CarrierCode", "TrackingNumber"]; readonly properties: { readonly PackageNumber: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/PackageNumber"; readonly type: "integer"; readonly title: "The PackageNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [1]; }; readonly CarrierCode: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/CarrierCode"; readonly type: "string"; readonly title: "The CarrierCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2-930434"]; }; readonly TrackingNumber: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/info/properties/TrackingNumber"; readonly type: "string"; readonly title: "The TrackingNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1Z84456456573405"]; }; }; readonly additionalProperties: true; }; }; readonly additionalItems: true; readonly items: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/properties/FulfillmentShipmentPackageItem"; readonly anyOf: readonly [{ readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0"; readonly type: "object"; readonly title: "The first anyOf schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly PackageNumber: 1; readonly CarrierCode: "2-930434"; readonly TrackingNumber: "1Z84456456573405"; }]; readonly required: readonly ["PackageNumber", "CarrierCode", "TrackingNumber"]; readonly properties: { readonly PackageNumber: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/PackageNumber"; readonly type: "integer"; readonly title: "The PackageNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [1]; }; readonly CarrierCode: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/CarrierCode"; readonly type: "string"; readonly title: "The CarrierCode schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2-930434"]; }; readonly TrackingNumber: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentShipment/properties/FulfillmentShipmentPackages/items/anyOf/0/properties/TrackingNumber"; readonly type: "string"; readonly title: "The TrackingNumber schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1Z84456456573405"]; }; }; readonly additionalProperties: true; }]; }; }; }; readonly additionalProperties: true; }; readonly FulfillmentReturnItem: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem"; readonly type: "object"; readonly title: "The FulfillmentReturnItem schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ReceivedDateTime: "2020-07-13T19:42:04.284Z"; readonly ReturnedQuantity: 12; readonly SellerSKU: "SELLERSKU9345"; }]; readonly required: readonly ["ReceivedDateTime", "ReturnedQuantity", "SellerSKU"]; readonly properties: { readonly ReceivedDateTime: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/ReceivedDateTime"; readonly type: "string"; readonly title: "The ReceivedDateTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly ReturnedQuantity: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/ReturnedQuantity"; readonly type: "integer"; readonly title: "The ReturnedQuantity schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: 0; readonly examples: readonly [12]; }; readonly SellerSKU: { readonly $id: "#/properties/Payload/properties/FulfillmentOrderStatusNotification/properties/FulfillmentReturnItem/properties/SellerSKU"; readonly type: "string"; readonly title: "The SellerSKU schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["SELLERSKU9345"]; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; type FulfillmentOrderStatusNotification = FromSchema; //#endregion //#region src/notifications/item-inventory-event-change-notification.d.ts declare const itemInventoryEventChangeNotification: { readonly $id: "https://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly notificationVersion: "2020-09-04"; readonly notificationType: "ITEM_INVENTORY_EVENT_CHANGE"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2023-02-07T16:05:32.378Z"; readonly payload: { readonly itemInventoryEventChanges: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly highlyAvailableInventory: 650; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly highlyAvailableInventory: 519; }]; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly examples: readonly ["ITEM_INVENTORY_EVENT_CHANGE"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly $ref: "#/definitions/Payload"; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly $ref: "#/definitions/NotificationMetadata"; }; }; readonly definitions: { readonly Payload: { readonly type: "object"; readonly examples: readonly [{ readonly itemInventoryEventChanges: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly highlyAvailableInventory: 650; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly highlyAvailableInventory: 519; }]; }]; readonly required: readonly ["itemInventoryEventChanges"]; readonly properties: { readonly itemInventoryEventChanges: { readonly $id: "#/definitions/Payload/properties/itemInventoryEventChanges"; readonly $ref: "#/definitions/ItemInventoryEventChanges"; }; }; }; readonly ItemInventoryEventChanges: { readonly type: "array"; readonly examples: readonly [readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly highlyAvailableInventory: 650; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly highlyAvailableInventory: 519; }]]; readonly items: { readonly $ref: "#/definitions/ItemInventoryEventChange"; }; }; readonly ItemInventoryEventChange: { readonly type: "object"; readonly examples: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly highlyAvailableInventory: 650; }]; readonly required: readonly ["accountId", "marketplaceId", "startTime", "endTime", "asin", "highlyAvailableInventory"]; readonly properties: { readonly accountId: { readonly $id: "#/definitions/ItemInventoryEventChange/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer ID or vendor group ID of the partner account this notification is sent to."; readonly examples: readonly ["amzn1.merchant.o.A21CXK3C4ERTY8", "amzn1.vg.6213651"]; }; readonly marketplaceId: { readonly $id: "#/definitions/ItemInventoryEventChange/properties/marketplaceId"; readonly type: "string"; readonly description: "The marketplace identifier of the inventory data."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly startTime: { readonly $id: "#/definitions/ItemInventoryEventChange/properties/startTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The start of the date-time range of the inventory data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T15:00:00Z"]; }; readonly endTime: { readonly $id: "#/definitions/ItemInventoryEventChange/properties/endTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The end of the date-time range of the inventory data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T16:00:00Z"]; }; readonly asin: { readonly $id: "#/definitions/ItemInventoryEventChange/properties/asin"; readonly type: "string"; readonly description: "The Amazon Standard Identification Number of the product."; readonly examples: readonly ["B00032HE0O"]; }; readonly highlyAvailableInventory: { readonly $id: "#/definitions/ItemInventoryEventChange/properties/highlyAvailableInventory"; readonly type: "integer"; readonly description: "The number of units available to be sold on the website, based on units in Amazon fulfillment centers that are in sellable condition, minus units in customer shopping carts or otherwise bound for other orders (for example, subscribe-and-save orders)."; readonly minimum: 0; readonly examples: readonly [650]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/definitions/NotificationMetadata/properties/applicationId"; readonly type: "string"; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/definitions/NotificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/definitions/NotificationMetadata/properties/publishTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly notificationId: { readonly $id: "#/definitions/NotificationMetadata/properties/notificationId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type ItemInventoryEventChangeNotification = FromSchema; //#endregion //#region src/notifications/item-product-type-change-notification.d.ts declare const itemProductTypeChangeNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "ITEM_PRODUCT_TYPE_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2019-03-20T18:59:30.194Z"; readonly Payload: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "B1234567"; readonly PreviousProductType: "PET_HEALTH_CARE"; readonly CurrentProductType: "PET_APPAREL"; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "0e999936-da2c-4f9c-9fc2-02b67bae5f49"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ITEM_PRODUCT_TYPE_CHANGE"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "B1234567"; readonly PreviousProductType: "PET_HEALTH_CARE"; readonly CurrentProductType: "PET_APPAREL"; }]; readonly required: readonly ["MarketplaceId", "Asin", "PreviousProductType", "CurrentProductType"]; readonly properties: { readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/MarketplaceId"; readonly type: "string"; readonly title: "The MarketplaceId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly Asin: { readonly $id: "#/properties/Payload/properties/Asin"; readonly type: "string"; readonly title: "The Asin schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["B1234567"]; }; readonly PreviousProductType: { readonly $id: "#/properties/Payload/properties/PreviousProductType"; readonly type: "string"; readonly title: "The PreviousProductType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["PET_HEALTH_CARE"]; }; readonly CurrentProductType: { readonly $id: "#/properties/Payload/properties/CurrentProductType"; readonly type: "string"; readonly title: "The CurrentProductType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["PET_APPAREL"]; }; }; readonly additionalProperties: true; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "0e999936-da2c-4f9c-9fc2-02b67bae5f49"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["0e999936-da2c-4f9c-9fc2-02b67bae5f49"]; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; type ItemProductTypeChangeNotification = FromSchema; //#endregion //#region src/notifications/item-sales-event-change-notification.d.ts declare const itemSalesEventChangeNotification: { readonly $id: "https://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly notificationVersion: "2020-09-04"; readonly notificationType: "ITEM_SALES_EVENT_CHANGE"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2023-02-07T16:05:32.378Z"; readonly payload: { readonly itemSalesEventChanges: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly orderedUnits: 9; readonly orderedRevenue: 80.91; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly orderedUnits: 5; readonly orderedRevenue: 527.6; }]; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly examples: readonly ["ITEM_SALES_EVENT_CHANGE"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly $ref: "#/definitions/Payload"; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly $ref: "#/definitions/NotificationMetadata"; }; }; readonly definitions: { readonly Payload: { readonly type: "object"; readonly examples: readonly [{ readonly itemSalesEventChanges: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly orderedUnits: 9; readonly orderedRevenue: 80.91; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly orderedUnits: 5; readonly orderedRevenue: 527.6; }]; }]; readonly required: readonly ["itemSalesEventChanges"]; readonly properties: { readonly itemSalesEventChanges: { readonly $id: "#/definitions/Payload/properties/itemSalesEventChanges"; readonly $ref: "#/definitions/ItemSalesEventChanges"; }; }; }; readonly ItemSalesEventChanges: { readonly type: "array"; readonly examples: readonly [readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly orderedUnits: 9; readonly orderedRevenue: 80.91; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly orderedUnits: 5; readonly orderedRevenue: 527.6; }]]; readonly items: { readonly $ref: "#/definitions/ItemSalesEventChange"; }; }; readonly ItemSalesEventChange: { readonly type: "object"; readonly examples: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly orderedUnits: 9; readonly orderedRevenue: 80.91; }]; readonly required: readonly ["accountId", "marketplaceId", "currencyCode", "startTime", "endTime", "asin", "orderedUnits", "orderedRevenue"]; readonly properties: { readonly accountId: { readonly $id: "#/definitions/ItemSalesEventChange/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer ID or vendor group ID of the partner account this notification is sent to."; readonly examples: readonly ["amzn1.merchant.o.A21CXK3C4ERTY8", "amzn1.vg.6213651"]; }; readonly marketplaceId: { readonly $id: "#/definitions/ItemSalesEventChange/properties/marketplaceId"; readonly type: "string"; readonly description: "The marketplace identifier of the sales data."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly currencyCode: { readonly $id: "#/definitions/ItemSalesEventChange/properties/currencyCode"; readonly type: "string"; readonly description: "The currency code of any monetary amounts in ISO 4217 format."; readonly examples: readonly ["USD"]; }; readonly startTime: { readonly $id: "#/definitions/ItemSalesEventChange/properties/startTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The start of the date-time range of the sales data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T15:00:00Z"]; }; readonly endTime: { readonly $id: "#/definitions/ItemSalesEventChange/properties/endTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The end of the date-time range of the sales data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T16:00:00Z"]; }; readonly asin: { readonly $id: "#/definitions/ItemSalesEventChange/properties/asin"; readonly type: "string"; readonly description: "The Amazon Standard Identification Number of the product."; readonly examples: readonly ["B00032HE0O"]; }; readonly orderedUnits: { readonly $id: "#/definitions/ItemSalesEventChange/properties/orderedUnits"; readonly type: "integer"; readonly description: "The number of units ordered by Amazon customers in the specified time frame. This number can be negative if there are more cancellations than orders."; readonly examples: readonly [9, -5]; }; readonly orderedRevenue: { readonly $id: "#/definitions/ItemSalesEventChange/properties/orderedRevenue"; readonly type: "number"; readonly description: "The ordered product sales in the specified time frame. Adjustments are made for cancellations."; readonly examples: readonly [80.91, -4.2]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/definitions/NotificationMetadata/properties/applicationId"; readonly type: "string"; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/definitions/NotificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/definitions/NotificationMetadata/properties/publishTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly notificationId: { readonly $id: "#/definitions/NotificationMetadata/properties/notificationId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type ItemSalesEventChangeNotification = FromSchema; //#endregion //#region src/notifications/listings-item-issues-change-notification.d.ts declare const listingsItemIssuesChangeNotification: { readonly title: "Listings Item Issues Change Notification"; readonly description: "To be delivered when issues are created, changed, or resolved for a listings item."; readonly type: "object"; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "LISTINGS_ITEM_ISSUES_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2021-02-05T18:59:30.194Z"; readonly Payload: { readonly SellerId: "AXXXXXXXXXXXXX"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "BT6RZ7JM4H"; readonly Sku: "NLS-SHOES-03"; readonly Severities: readonly ["ERROR", "WARNING"]; readonly EnforcementActions: readonly ["SEARCH_SUPPRESSED"]; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2021-02-05T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly type: "string"; readonly title: "Notification Version"; readonly description: "The version of the notification."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly type: "string"; readonly title: "Notification Type"; readonly description: "The type of the notification."; readonly enum: readonly ["LISTINGS_ITEM_ISSUES_CHANGE"]; }; readonly PayloadVersion: { readonly type: "string"; readonly title: "Payload Version"; readonly description: "The version of the payload."; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Event Time"; readonly description: "Timestamp of the event, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly type: "object"; readonly title: "Payload"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly SellerId: "A3AYAZLIQ7AX77"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "BT6RZ7JM4H"; readonly Sku: "NLS-SHOES-03"; readonly Severities: readonly ["ERROR", "WARNING"]; readonly EnforcementActions: readonly ["SEARCH_SUPPRESSED"]; }]; readonly required: readonly ["SellerId", "Sku", "Severities"]; readonly properties: { readonly SellerId: { readonly type: "string"; readonly title: "Seller ID"; readonly description: "Selling partner identifier, such as a merchant account or vendor code, of the affected listings item."; readonly examples: readonly ["AXXXXXXXXXXXXX", "TXXXX"]; }; readonly MarketplaceId: { readonly type: "string"; readonly title: "Marketplace ID"; readonly description: "Amazon marketplace identifier of the affected listings item."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly Asin: { readonly type: "string"; readonly title: "ASIN"; readonly description: "The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item."; readonly examples: readonly ["BT6RZ7JM4H"]; }; readonly Sku: { readonly type: "string"; readonly title: "SKU"; readonly description: "Identifier of the affected listings item."; readonly examples: readonly ["NLS-SHOES-03"]; }; readonly Severities: { readonly type: "array"; readonly title: "Severities"; readonly description: "Array of severities for the issues currently associated with the affected listings item. When no issues are affecting the listings item, \"NONE\" is provided instead."; readonly items: { readonly type: "string"; readonly enum: readonly ["NONE", "ERROR", "WARNING"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "NONE"; readonly description: "When provided, no issues are affecting the listings item."; }, { readonly value: "ERROR"; readonly description: "When provided, at least one issue with \"ERROR\" severity is affecting the listings item."; }, { readonly value: "WARNING"; readonly description: "When provided, at least one issue with \"WARNING\" severity is affecting the listings item."; }]; }; readonly uniqueItems: true; readonly examples: readonly [readonly ["ERROR", "WARNING"]]; }; readonly EnforcementActions: { readonly type: "array"; readonly title: "Enforcement Actions Taken"; readonly description: "Array of enforcement actions taken by Amazon for the issues associated with the affected listings item."; readonly items: { readonly type: "string"; readonly enum: readonly ["SEARCH_SUPPRESSED"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "SEARCH_SUPPRESSED"; readonly description: "When provided, the listing item is suppressed from search results caused by at least one issue currently associated with the affected listing item."; }]; }; readonly uniqueItems: true; readonly examples: readonly [readonly ["SEARCH_SUPPRESSED"]]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly title: "Notification Metadata"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly type: "string"; readonly title: "Application ID"; readonly description: "Identifies the application."; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly type: "string"; readonly title: "Subscription ID"; readonly description: "Identifies the subscription."; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Publish Time"; readonly description: "Timestamp of when the notification was published, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly type: "string"; readonly title: "Notification ID"; readonly description: "Identifies the notification."; readonly examples: readonly ["8e009934-da2c-4f9c-9bc7-93f23b7e1f60"]; }; }; }; }; }; type ListingsItemIssuesChangeNotification = FromSchema; //#endregion //#region src/notifications/listings-item-issues-change-notification-2023-12-13.d.ts declare const listingsItemIssuesChangeNotification20231213: { readonly title: "Listings Item Issues Change Notification"; readonly description: "To be delivered when issues are created, changed, or resolved for a listings item."; readonly type: "object"; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "LISTINGS_ITEM_ISSUES_CHANGE"; readonly PayloadVersion: "2023-12-13"; readonly EventTime: "2024-02-05T18:59:30.194Z"; readonly Payload: { readonly SellerId: "AXXXXXXXXXXXXX"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "BT6RZ7JM4H"; readonly Sku: "NLS-SHOES-03"; readonly Severities: readonly ["ERROR", "WARNING"]; readonly EnforcementActions: readonly ["SEARCH_SUPPRESSED", "LISTING_SUPPRESSED", "ATTRIBUTE_SUPPRESSED", "CATALOG_ITEM_REMOVED"]; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2024-02-05T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly type: "string"; readonly title: "Notification Version"; readonly description: "The version of the notification."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly type: "string"; readonly title: "Notification Type"; readonly description: "The type of the notification."; readonly enum: readonly ["LISTINGS_ITEM_ISSUES_CHANGE"]; }; readonly PayloadVersion: { readonly type: "string"; readonly title: "Payload Version"; readonly description: "The version of the payload."; readonly examples: readonly ["2023-12-13"]; }; readonly EventTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Event Time"; readonly description: "Timestamp of the event, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly type: "object"; readonly title: "Payload"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly SellerId: "A3AYAZLIQ7AX77"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "BT6RZ7JM4H"; readonly Sku: "NLS-SHOES-03"; readonly Severities: readonly ["ERROR", "WARNING"]; readonly EnforcementActions: readonly ["SEARCH_SUPPRESSED", "LISTING_SUPPRESSED", "ATTRIBUTE_SUPPRESSED", "CATALOG_ITEM_REMOVED"]; }]; readonly required: readonly ["SellerId", "Sku", "Severities"]; readonly properties: { readonly SellerId: { readonly type: "string"; readonly title: "Seller ID"; readonly description: "Selling partner identifier, such as a merchant account or vendor code, of the affected listings item."; readonly examples: readonly ["AXXXXXXXXXXXXX", "TXXXX"]; }; readonly MarketplaceId: { readonly type: "string"; readonly title: "Marketplace ID"; readonly description: "Amazon marketplace identifier of the affected listings item."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly Asin: { readonly type: "string"; readonly title: "ASIN"; readonly description: "The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item."; readonly examples: readonly ["BT6RZ7JM4H"]; }; readonly Sku: { readonly type: "string"; readonly title: "SKU"; readonly description: "Identifier of the affected listings item."; readonly examples: readonly ["NLS-SHOES-03"]; }; readonly Severities: { readonly type: "array"; readonly title: "Severities"; readonly description: "Array of severities for the issues currently associated with the affected listings item. When no issues are affecting the listings item, \"NONE\" is provided instead."; readonly items: { readonly type: "string"; readonly enum: readonly ["NONE", "ERROR", "WARNING"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "NONE"; readonly description: "When provided, no issues are affecting the listings item."; }, { readonly value: "ERROR"; readonly description: "When provided, at least one issue with \"ERROR\" severity is affecting the listings item."; }, { readonly value: "WARNING"; readonly description: "When provided, at least one issue with \"WARNING\" severity is affecting the listings item."; }]; }; readonly uniqueItems: true; readonly examples: readonly [readonly ["ERROR", "WARNING"]]; }; readonly EnforcementActions: { readonly type: "array"; readonly title: "Enforcement Actions Taken"; readonly description: "Array of enforcement actions taken by Amazon for the issues associated with the affected listings item. 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 marketplace are non-buyable. 'SEARCH_SUPPRESSED' - This value indicates that the catalog item is hidden from search results."; readonly items: { readonly type: "string"; }; readonly uniqueItems: true; readonly examples: readonly [readonly ["SEARCH_SUPPRESSED", "LISTING_SUPPRESSED", "ATTRIBUTE_SUPPRESSED", "CATALOG_ITEM_REMOVED"]]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly title: "Notification Metadata"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly type: "string"; readonly title: "Application ID"; readonly description: "Identifies the application."; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly type: "string"; readonly title: "Subscription ID"; readonly description: "Identifies the subscription."; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Publish Time"; readonly description: "Timestamp of when the notification was published, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly type: "string"; readonly title: "Notification ID"; readonly description: "Identifies the notification."; readonly examples: readonly ["8e009934-da2c-4f9c-9bc7-93f23b7e1f60"]; }; }; }; }; }; type ListingsItemIssuesChangeNotification20231213 = FromSchema; //#endregion //#region src/notifications/listings-item-mfn-quantity-change.d.ts declare const listingsItemMfnQuantityChange: { readonly title: "Listings Item MFN Quantity Change Notification"; readonly description: "To be delivered when the inventory quantity of a MFN Seller listing changes."; readonly type: "object"; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "LISTINGS_ITEM_MFN_QUANTITY_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2021-02-03T18:59:30.194Z"; readonly Payload: { readonly SellerId: "AXXXXXXXXXXXXX"; readonly FulfillmentChannelCode: "DEFAULT"; readonly Sku: "NLS-SHOES-03"; readonly Quantity: 99; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2021-02-03T18:59:30.194Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly type: "string"; readonly title: "Notification Version"; readonly description: "The version of the notification."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly type: "string"; readonly title: "Notification Type"; readonly description: "The type of the notification."; readonly enum: readonly ["LISTINGS_ITEM_MFN_QUANTITY_CHANGE"]; }; readonly PayloadVersion: { readonly type: "string"; readonly title: "Payload Version"; readonly description: "The version of the payload."; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Event Time"; readonly description: "Timestamp of the event, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly type: "object"; readonly title: "Payload"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly SellerId: "AXXXXXXXXXXXXX"; readonly FulfillmentChannelCode: "DEFAULT"; readonly Sku: "NLS-SHOES-03"; readonly Quantity: 99; }]; readonly required: readonly ["SellerId", "FulfillmentChannelCode", "Sku", "Quantity"]; readonly properties: { readonly SellerId: { readonly type: "string"; readonly title: "Seller ID"; readonly description: "Selling partner identifier, such as a merchant ID, of the affected listings item."; readonly examples: readonly ["AXXXXXXXXXXXXX"]; }; readonly FulfillmentChannelCode: { readonly type: "string"; readonly title: "Fulfillment Channel Code"; readonly description: "The Fulfillment channel code representing the MFN (seller-fulfilled) fulfillment program, network, or channel where the quantity is applicable."; readonly examples: readonly ["DEFAULT"]; }; readonly Sku: { readonly type: "string"; readonly title: "SKU"; readonly description: "A selling partner provided identifier for an Amazon listing."; readonly examples: readonly ["NLS-SHOES-03"]; }; readonly Quantity: { readonly type: "integer"; readonly title: "Quantity"; readonly description: "The available quantity for MFN (seller-fulfillment) with the fulfillment program, network, or channel."; readonly examples: readonly [99]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly title: "Notification Metadata"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly type: "string"; readonly title: "Application ID"; readonly description: "An identifier of the application."; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly type: "string"; readonly title: "Subscription ID"; readonly description: "An identifier of the subscription."; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Publish Time"; readonly description: "Timestamp of when the notification was published, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly type: "string"; readonly title: "Notification ID"; readonly description: "An identifier of the notification."; readonly examples: readonly ["8e009934-da2c-4f9c-9bc7-93f23b7e1f60"]; }; }; }; }; }; type ListingsItemMfnQuantityChange = FromSchema; //#endregion //#region src/notifications/listings-item-status-change-notification.d.ts declare const listingsItemStatusChangeNotification: { readonly title: "Listings Item Status Change Notification"; readonly description: "To be delivered when the status (e.g. buyability, discoverability) of a listings item changes."; readonly type: "object"; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "LISTINGS_ITEM_STATUS_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2021-02-03T18:59:30.194Z"; readonly Payload: { readonly SellerId: "A3AYAZLIQ7AX77"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "BT6RZ7JM4H"; readonly Sku: "NLS-SHOES-03"; readonly CreatedDate: "2021-02-03T18:50:26.196Z"; readonly Status: readonly ["BUYABLE", "DISCOVERABLE"]; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f108f511-eeac-46a6-b125-bcb752069ed0"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2021-02-03T18:59:30.194Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly type: "string"; readonly title: "Notification Version"; readonly description: "The version of the notification."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly type: "string"; readonly title: "Notification Type"; readonly description: "The type of the notification."; readonly enum: readonly ["LISTINGS_ITEM_STATUS_CHANGED"]; }; readonly PayloadVersion: { readonly type: "string"; readonly title: "Payload Version"; readonly description: "The version of the payload."; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Event Time"; readonly description: "Timestamp of the event, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly type: "object"; readonly title: "Payload"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly SellerId: "A3AYAZLIQ7AX77"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly Asin: "BT6RZ7JM4H"; readonly Sku: "NLS-SHOES-03"; readonly CreatedDate: "2021-02-03T18:50:26.196Z"; readonly Status: readonly ["BUYABLE", "DISCOVERABLE"]; }]; readonly required: readonly ["SellerId", "Sku", "Status"]; readonly properties: { readonly SellerId: { readonly type: "string"; readonly title: "Seller ID"; readonly description: "Selling partner identifier, such as a merchant account, of the affected listings item."; readonly examples: readonly ["A3AYAZLIQ7AX77"]; }; readonly MarketplaceId: { readonly type: "string"; readonly title: "Marketplace ID"; readonly description: "Amazon marketplace identifier of the affected listings item."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly Asin: { readonly type: "string"; readonly title: "ASIN"; readonly description: "The Amazon Standard Identification Number (ASIN) identifier of the catalog item associated with the listings item."; readonly examples: readonly ["BT6RZ7JM4H"]; }; readonly Sku: { readonly type: "string"; readonly title: "SKU"; readonly description: "Identifier of the affected listings item."; readonly examples: readonly ["NLS-SHOES-03"]; }; readonly CreatedDate: { readonly type: "string"; readonly format: "date-time"; readonly title: "Created Date"; readonly description: "Timestamp of when the listings item was created, formatted as ISO8601 date-time."; readonly examples: readonly ["2021-02-03T18:50:26.196Z"]; }; readonly Status: { readonly type: "array"; readonly title: "Status"; readonly description: "Array 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."; readonly items: { readonly type: "string"; readonly enum: readonly ["BUYABLE", "DISCOVERABLE", "DELETED"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "BUYABLE"; readonly description: "When provided, the listings item is buyable. When omitted, the listings item is non-buyable."; }, { readonly value: "DISCOVERABLE"; readonly description: "When provided, the listings item is discoverable. When omitted, the listings item is non-discoverable."; }, { readonly value: "DELETED"; readonly description: "When provided, the listings item is deleted. When omitted, the listings item is non-deleted."; }]; }; readonly uniqueItems: true; readonly examples: readonly [readonly ["BUYABLE", "DISCOVERABLE"]]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly title: "Notification Metadata"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly type: "string"; readonly title: "Application ID"; readonly description: "Identifies the application."; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly type: "string"; readonly title: "Subscription ID"; readonly description: "Identifies the subscription."; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly type: "string"; readonly format: "date-time"; readonly title: "Publish Time"; readonly description: "Timestamp of when the notification was published, formatted as ISO8601 date-time."; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly type: "string"; readonly title: "Notification ID"; readonly description: "Identifies the notification."; readonly examples: readonly ["8e009934-da2c-4f9c-9bc7-93f23b7e1f60"]; }; }; }; }; }; type ListingsItemStatusChangeNotification = FromSchema; //#endregion //#region src/notifications/order-change-notification.d.ts declare const orderChangeNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The notification response schema that comprises the entire JSON document for ORDER_CHANGE notification."; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "ORDER_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2020-01-11T00:09:53.109Z"; readonly Payload: { readonly OrderChangeNotification: { readonly NotificationLevel: "OrderLevel"; readonly SellerId: "A3TH9S8BH6GOGM"; readonly AmazonOrderId: "903-8868176-2219830"; readonly OrderChangeType: "BuyerRequestedChange"; readonly OrderChangeTrigger: { readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z"; readonly ChangeReason: "Buyer Requested Cancel"; }; readonly Summary: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly OrderStatus: "Unshipped"; readonly PurchaseDate: "2022-07-13T19:42:04.284Z"; readonly DestinationPostalCode: "48110"; readonly FulfillmentType: "MFN"; readonly OrderType: "StandardOrder"; readonly NumberOfItemsShipped: 0; readonly NumberOfItemsUnshipped: 10; readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z"; readonly EarliestShipDate: "2022-11-07T19:42:04.284Z"; readonly LatestShipDate: "2022-12-07T19:42:04.284Z"; readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z"; readonly OrderPrograms: readonly ["Business"]; readonly ShippingPrograms: readonly ["EasyShip"]; readonly EasyShipShipmentStatus: "Delivered"; readonly ElectronicInvoiceStatus: "NotFound"; readonly OrderItems: readonly [{ readonly OrderItemId: "OIID34853450"; readonly SellerSKU: "SellerSKUID1"; readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3"; readonly OrderItemStatus: "Unshipped"; readonly Quantity: 10; readonly QuantityShipped: 0; readonly IsBuyerRequestedCancel: true; readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z"; }]; }; }; }; readonly NotificationMetadata: { readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "The notification version."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "The type of this notification, used to differentiate different notifications. Combined with payload version controls the structure of payload object."; readonly examples: readonly ["ORDER_CHANGE"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "The payload version of the notification."; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "The time when this notification was published, presented in ISO-8601 date/time format."; readonly examples: readonly ["2020-01-11T00:09:53.109Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "The payload for this ORDER_CHANGE notification. It's unique for different event type and will provide more in-depth information about this notification."; readonly examples: readonly [{ readonly OrderChangeNotification: { readonly NotificationLevel: "OrderLevel"; readonly SellerId: "A3TH9S8BH6GOGM"; readonly AmazonOrderId: "903-8868176-2219830"; readonly OrderChangeType: "BuyerRequestedChange"; readonly OrderChangeTrigger: { readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z"; readonly ChangeReason: "Buyer Requested Cancel"; }; readonly Summary: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly OrderStatus: "Unshipped"; readonly PurchaseDate: "2022-07-13T19:42:04.284Z"; readonly DestinationPostalCode: "48110"; readonly FulfillmentType: "MFN"; readonly OrderType: "StandardOrder"; readonly NumberOfItemsShipped: 0; readonly NumberOfItemsUnshipped: 10; readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z"; readonly EarliestShipDate: "2022-11-07T19:42:04.284Z"; readonly LatestShipDate: "2022-12-07T19:42:04.284Z"; readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z"; readonly OrderPrograms: readonly ["Business"]; readonly ShippingPrograms: readonly ["EasyShip"]; readonly EasyShipShipmentStatus: "Delivered"; readonly ElectronicInvoiceStatus: "NotFound"; readonly OrderItems: readonly [{ readonly OrderItemId: "OIID34853450"; readonly SellerSKU: "SellerSKUID1"; readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3"; readonly OrderItemStatus: "Unshipped"; readonly Quantity: 10; readonly QuantityShipped: 0; readonly IsBuyerRequestedCancel: true; readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z"; }]; }; }; }]; readonly required: readonly ["OrderChangeNotification"]; readonly properties: { readonly OrderChangeNotification: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification"; readonly type: "object"; readonly title: "The OrderChangeNotification schema"; readonly description: "An explanation about the ORDER_CHANGE notification."; readonly examples: readonly [{ readonly NotificationLevel: "OrderLevel"; readonly SellerId: "A3TH9S8BH6GOGM"; readonly AmazonOrderId: "903-8868176-2219830"; readonly OrderChangeType: "BuyerRequestedChange"; readonly OrderChangeTrigger: { readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z"; readonly ChangeReason: "Buyer Requested Cancel"; }; readonly Summary: { readonly MarketplaceId: "ATVPDKIKX0DER"; readonly OrderStatus: "Unshipped"; readonly PurchaseDate: "2022-07-13T19:42:04.284Z"; readonly DestinationPostalCode: "48110"; readonly FulfillmentType: "MFN"; readonly OrderType: "StandardOrder"; readonly NumberOfItemsShipped: 0; readonly NumberOfItemsUnshipped: 10; readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z"; readonly EarliestShipDate: "2022-11-07T19:42:04.284Z"; readonly LatestShipDate: "2022-12-07T19:42:04.284Z"; readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z"; readonly OrderPrograms: readonly ["Business"]; readonly ShippingPrograms: readonly ["EasyShip"]; readonly EasyShipShipmentStatus: "Delivered"; readonly ElectronicInvoiceStatus: "NotFound"; readonly OrderItems: readonly [{ readonly OrderItemId: "OIID34853450"; readonly SellerSKU: "SellerSKUID1"; readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3"; readonly OrderItemStatus: "Unshipped"; readonly Quantity: 10; readonly QuantityShipped: 0; readonly IsBuyerRequestedCancel: true; readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z"; }]; }; }]; readonly required: readonly ["NotificationLevel", "SellerId", "AmazonOrderId", "OrderChangeType", "OrderChangeTrigger", "Summary"]; readonly properties: { readonly NotificationLevel: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/NotificationLevel"; readonly type: "string"; readonly enum: readonly ["OrderItemLevel", "OrderLevel"]; readonly title: "The NotificationLevel schema"; readonly description: "The notification level of current notification."; readonly examples: readonly ["OrderLevel"]; }; readonly SellerId: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/SellerId"; readonly type: "string"; readonly title: "The SellerId schema"; readonly description: "The selling partner identifier."; readonly examples: readonly ["AXXXXXXXXXXXXX"]; }; readonly AmazonOrderId: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/AmazonOrderId"; readonly type: "string"; readonly title: "The AmazonOrderId schema"; readonly description: "The Amazon order identifier, in 3-7-7 format."; readonly examples: readonly ["903-8868176-2219830"]; }; readonly OrderChangeType: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeType"; readonly type: "string"; readonly enum: readonly ["BuyerRequestedChange", "DeliveryTipChange", "OrderStatusChange"]; readonly title: "The OrderChangeType schema"; readonly description: "Change type of this notification. The possible values include BuyerRequestedChange, DeliveryTipChange, OrderStatusChange."; readonly examples: readonly ["BuyerRequestedChange"]; }; readonly OrderChangeTrigger: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger"; readonly type: "object"; readonly title: "The OrderChangeTrigger schema"; readonly description: "Details about what triggered this ORDER_CHANGE notification."; readonly examples: readonly [{ readonly TimeOfOrderChange: "2022-11-29T19:42:04.284Z"; readonly ChangeReason: "Buyer Requested Cancel"; }]; readonly required: readonly ["TimeOfOrderChange", "ChangeReason"]; readonly properties: { readonly TimeOfOrderChange: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger/properties/TimeOfOrderChange"; readonly type: readonly ["string", "null"]; readonly title: "The TimeOfOrderChange schema"; readonly description: "The timestamp for the change that caused this notification, presented in ISO-8601 date/time format. It will be null when there is no related timestamp."; readonly examples: readonly ["2022-11-29T19:42:04.284Z"]; }; readonly ChangeReason: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/OrderChangeTrigger/properties/ChangeReason"; readonly type: "string"; readonly title: "The ChangeReason schema"; readonly description: "The reason for this ORDER_CHANGE notification."; readonly examples: readonly ["Buyer Requested Cancel"]; }; }; }; readonly Summary: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary"; readonly type: "object"; readonly title: "The Summary schema"; readonly description: "Information about order and order items that had the change."; readonly examples: readonly [{ readonly MarketplaceId: "ATVPDKIKX0DER"; readonly OrderStatus: "Unshipped"; readonly PurchaseDate: "2022-07-13T19:42:04.284Z"; readonly DestinationPostalCode: "48110"; readonly FulfillmentType: "MFN"; readonly OrderType: "StandardOrder"; readonly NumberOfItemsShipped: 0; readonly NumberOfItemsUnshipped: 10; readonly EarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly LatestDeliveryDate: "2022-12-07T19:42:04.284Z"; readonly EarliestShipDate: "2022-11-07T19:42:04.284Z"; readonly LatestShipDate: "2022-12-07T19:42:04.284Z"; readonly CancelNotifyDate: "2022-12-07T19:42:04.284Z"; readonly OrderPrograms: readonly ["Business"]; readonly ShippingPrograms: readonly ["EasyShip"]; readonly EasyShipShipmentStatus: "Delivered"; readonly ElectronicInvoiceStatus: "NotFound"; readonly OrderItems: readonly [{ readonly OrderItemId: "OIID34853450"; readonly SellerSKU: "SellerSKUID1"; readonly OrderItemStatus: "Unshipped"; readonly Quantity: 10; readonly QuantityShipped: 0; readonly IsBuyerRequestedCancel: true; readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z"; }]; }]; readonly required: readonly ["MarketplaceId", "OrderStatus", "PurchaseDate", "DestinationPostalCode", "FulfillmentType", "OrderType", "OrderItems"]; readonly properties: { readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/MarketplaceId"; readonly type: "string"; readonly title: "The MarketplaceId schema"; readonly description: "The Amazon marketplace identifier of the order."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly OrderStatus: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderStatus"; readonly type: "string"; readonly enum: readonly ["Pending", "Unshipped", "PartiallyShipped", "Shipped", "Canceled", "Unfulfillable", "InvoiceUnconfirmed", "PendingAvailability"]; readonly title: "The OrderStatus schema"; readonly description: "The current order status."; readonly examples: readonly ["Unshipped"]; }; readonly PurchaseDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/PurchaseDate"; readonly type: readonly ["string", "null"]; readonly title: "The PurchaseDate schema"; readonly description: "The purchase date of the order, presented in ISO-8601 date/time format. It will be null when there is no related information."; readonly examples: readonly ["2022-07-13T19:42:04.284Z"]; }; readonly DestinationPostalCode: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/DestinationPostalCode"; readonly type: readonly ["string", "null"]; readonly title: "The DestinationPostalCode schema"; readonly description: "The destination postal code. It will be null when there is no related information."; readonly examples: readonly ["48110"]; }; readonly FulfillmentType: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/FulfillmentType"; readonly type: "string"; readonly enum: readonly ["AFN", "MFN"]; readonly title: "The FulfillmentType schema"; readonly description: "Fulfillment type of the affected order, MFN or AFN."; readonly examples: readonly ["MFN"]; }; readonly OrderType: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderType"; readonly type: "string"; readonly enum: readonly ["StandardOrder", "LongLeadTimeOrder", "Preorder", "BackOrder", "SourcingOnDemandOrder"]; readonly title: "The OrderType schema"; readonly description: "The type of the order."; readonly examples: readonly ["StandardOrder"]; }; readonly NumberOfItemsShipped: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/NumberOfItemsShipped"; readonly type: "integer"; readonly title: "The NumberOfItemsShipped schema"; readonly description: "The number of items shipped."; readonly examples: readonly [0]; }; readonly NumberOfItemsUnshipped: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/NumberOfItemsUnshipped"; readonly type: "integer"; readonly title: "The NumberOfItemsUnshipped schema"; readonly description: "The number of items unshipped."; readonly examples: readonly [10]; }; readonly EarliestDeliveryDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EarliestDeliveryDate"; readonly type: "string"; readonly title: "The EarliestDeliveryDate schema"; readonly description: "The start of the time period within which you have committed to fulfill the order, presented in ISO-8601 date/time format. Returned only for seller-fulfilled orders."; readonly examples: readonly ["2022-11-07T19:42:04.284Z"]; }; readonly LatestDeliveryDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/LatestDeliveryDate"; readonly type: "string"; readonly title: "The LatestDeliveryDate schema"; readonly description: "The end of the time period within which you have committed to fulfill the order, presented in ISO-8601 date/time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status."; readonly examples: readonly ["2022-12-07T19:42:04.284Z"]; }; readonly EarliestShipDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EarliestShipDate"; readonly type: "string"; readonly title: "The EarliestShipDate schema"; readonly description: "The start of the time period within which you have committed to ship the order, presented in ISO-8601 date/time format."; readonly examples: readonly ["2022-11-07T19:42:04.284Z"]; }; readonly LatestShipDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/LatestShipDate"; readonly type: "string"; readonly title: "The LatestShipDate schema"; readonly description: "The end of the time period within which you have committed to ship the order, presented in ISO-8601 date/time format."; readonly examples: readonly ["2022-12-07T19:42:04.284Z"]; }; readonly CancelNotifyDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/CancelNotifyDate"; readonly type: "string"; readonly title: "The CancelNotifyDate schema"; readonly description: "The end of the time period which you cancel notify for the order, presented in ISO-8601 date/time format."; readonly examples: readonly ["2022-12-07T19:42:04.284Z"]; }; readonly OrderPrograms: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderPrograms"; readonly type: "array"; readonly title: "The OrderPrograms schema"; readonly description: "The order programs, if any, in which this order participates."; readonly items: { readonly type: "string"; readonly enum: readonly ["Business", "Prime", "Premium", "IBA", "Replacement"]; }; readonly examples: readonly [readonly ["Business"]]; }; readonly ShippingPrograms: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/ShippingPrograms"; readonly type: "array"; readonly title: "The ShippingPrograms schema"; readonly description: "The shipping programs, if any, in which this order participates."; readonly items: { readonly type: "string"; readonly enum: readonly ["ShipDateSet", "GlobalExpress", "ISPU", "AccessPoint", "TFM", "EasyShip"]; }; readonly examples: readonly [readonly ["EasyShip"]]; }; readonly EasyShipShipmentStatus: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/EasyShipShipmentStatus"; readonly type: "string"; readonly enum: readonly ["PendingSchedule", "PendingPickUp", "PendingDropOff", "LabelCanceled", "PickedUp", "DroppedOff", "AtOriginFC", "AtDestinationFC", "Delivered", "RejectedByBuyer", "Undeliverable", "ReturningToSeller", "ReturnedToSeller", "Lost", "OutForDelivery", "Damaged"]; readonly title: "The EasyShipShipmentStatus schema"; readonly description: "The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders."; readonly examples: readonly ["Delivered"]; }; readonly ElectronicInvoiceStatus: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/ElectronicInvoiceStatus"; readonly type: "string"; readonly enum: readonly ["NotRequired", "NotFound", "Processing", "Errored", "Accepted"]; readonly title: "The ElectronicInvoiceStatus schema"; readonly description: "The status of the electronic invoice."; readonly examples: readonly ["NotFound"]; }; readonly OrderItems: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems"; readonly type: "array"; readonly title: "The OrderItems schema"; readonly description: "Information about order items included in this order. For OrderItemLevel notification, one payload include one item, while for OrderLevel notification, one payload include all items."; readonly examples: readonly [readonly [{ readonly OrderItemId: "OIID34853450"; readonly SellerSKU: "SellerSKUID1"; readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3"; readonly OrderItemStatus: "Unshipped"; readonly Quantity: 10; readonly QuantityShipped: 0; readonly IsBuyerRequestedCancel: true; readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z"; }]]; readonly items: { readonly type: "object"; readonly title: "The OrderItem schema"; readonly description: "Information about every order item."; readonly examples: readonly [{ readonly OrderItemId: "OIID34853450"; readonly SellerSKU: "SellerSKUID1"; readonly SupplySourceId: "d7679e14-031b-4ab3-a81b-ec4fc7a460b3"; readonly OrderItemStatus: "Unshipped"; readonly Quantity: 10; readonly QuantityShipped: 0; readonly IsBuyerRequestedCancel: true; readonly ItemEarliestDeliveryDate: "2022-11-07T19:42:04.284Z"; readonly ItemLatestDeliveryDate: "2022-12-07T19:42:04.284Z"; }]; readonly required: readonly ["OrderItemId", "SellerSKU", "SupplySourceId", "Quantity"]; readonly properties: { readonly OrderItemId: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/OrderItemId"; readonly type: "string"; readonly title: "The OrderItemId schema"; readonly description: "The Amazon-defined order item identifier."; readonly examples: readonly ["OIID34853450"]; }; readonly SellerSKU: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/SellerSKU"; readonly type: "string"; readonly title: "The SellerSKU schema"; readonly description: "The seller-specific SKU identifier for an item."; readonly examples: readonly ["SellerSKUID1"]; }; readonly SupplySourceId: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/SupplySourceId"; readonly type: readonly ["string", "null"]; readonly title: "The SupplySourceId schema"; readonly description: "The unique identifier of the supply source. It will be null when there is no related information."; readonly examples: readonly ["d7679e14-031b-4ab3-a81b-ec4fc7a460b3"]; }; readonly OrderItemStatus: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/OrderItemStatus"; readonly type: "string"; readonly enum: readonly ["Unshipped", "Shipped"]; readonly title: "The OrderItemStatus schema"; readonly description: "The current status of the order item. Will display it when items' status are different."; readonly examples: readonly ["Unshipped"]; }; readonly Quantity: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/Quantity"; readonly type: "integer"; readonly title: "The Quantity schema"; readonly description: "The number of items in the order."; readonly examples: readonly [10]; }; readonly QuantityShipped: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/QuantityShipped"; readonly type: "integer"; readonly title: "The QuantityShipped schema"; readonly description: "The number of items shipped."; readonly examples: readonly [0]; }; readonly IsBuyerRequestedCancel: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/IsBuyerRequestedCancel"; readonly type: "boolean"; readonly title: "The IsBuyerRequestedCancel schema"; readonly description: "Information about whether or not a buyer requested cancellation. When true, the buyer has requested cancellation."; readonly examples: readonly [true]; }; readonly ItemEarliestDeliveryDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/ItemEarliestDeliveryDate"; readonly type: "string"; readonly title: "The ItemEarliestDeliveryDate schema"; readonly description: "The start of the time period within which you have committed to fulfill the order item."; readonly examples: readonly ["2022-11-07T19:42:04.284Z"]; }; readonly ItemLatestDeliveryDate: { readonly $id: "#/properties/Payload/properties/OrderChangeNotification/properties/Summary/properties/OrderItems/ItemLatestDeliveryDate"; readonly type: "string"; readonly title: "The ItemLatestDeliveryDate schema"; readonly description: "The end of the time period within which you have committed to fulfill the order item."; readonly examples: readonly ["2022-12-07T19:42:04.284Z"]; }; }; }; }; }; }; }; }; }; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "The notification metadata."; readonly examples: readonly [{ readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2020-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "The identifier for the application that uses the notifications."; readonly examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "A unique identifier for the subscription which resulted in this notification."; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "The date and time (in UTC) that the notification was sent, presented in ISO-8601 date/time format."; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "A unique identifier for this notification instance."; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type OrderChangeNotification = FromSchema; //#endregion //#region src/notifications/pricing-health-notification.d.ts 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"; }; }; }; }; }; type PricingHealthNotification = FromSchema; //#endregion //#region src/notifications/product-type-definitions-change-notification.d.ts declare const productTypeDefinitionsChangeNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The root schema comprises the entire JSON document."; readonly default: {}; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "PRODUCT_TYPE_DEFINITIONS_CHANGE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2021-02-03T18:59:30.194Z"; readonly Payload: { readonly AccountId: "AXXXXXXXXXXX"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ProductTypeVersion: "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"; readonly NewProductTypes: readonly ["LUGGAGE", "SHOES"]; }; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2021-02-03T18:59:30.194Z"; readonly NotificationId: "0e999936-da2c-4f9c-9fc2-02b67bae5f49"; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["PRODUCT_TYPE_DEFINITIONS_CHANGE"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2019-03-20T18:59:30.194Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly AccountId: "AXXXXXXXXXXX"; readonly MarketplaceId: "ATVPDKIKX0DER"; readonly ProductTypeVersion: "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"; readonly NewProductTypes: readonly ["LUGGAGE", "SHOES"]; }, { readonly AccountId: "AXXXXXXXXXXX"; readonly ProductTypeVersion: "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"; }]; readonly required: readonly ["AccountId", "ProductTypeVersion"]; readonly properties: { readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/MarketplaceId"; readonly type: "string"; readonly title: "The MarketplaceId schema"; readonly description: "The marketplace where the Product Type Definition has changed"; readonly default: ""; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly AccountId: { readonly $id: "#/properties/Payload/properties/AccountId"; readonly type: "string"; readonly title: "The Merchant Id or Vendor Group Id."; readonly description: "The Merchant Id or Vendor Group Id related to the subscription."; readonly default: ""; readonly examples: readonly ["AXXXXXXXXXXX"]; }; readonly ProductTypeVersion: { readonly $id: "#/properties/Payload/properties/ProductTypeVersion"; readonly type: "string"; readonly title: "The version of latest Product Type Definitions"; readonly description: "Provides the latest released Product Type Definition version."; readonly default: ""; readonly examples: readonly ["Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"]; }; readonly NewProductTypes: { readonly $id: "#/properties/Payload/properties/NewProductTypes"; readonly type: "array"; readonly title: "New Product Types"; readonly description: "List of new Product Types release in the marketplace."; readonly default: ""; readonly examples: readonly [readonly ["LUGGAGE", "SHOES"]]; }; }; readonly additionalProperties: true; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: {}; readonly examples: readonly [{ readonly ApplicationId: "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"; readonly SubscriptionId: "93b098e1-c42-2f45-93a1-78910a6a8369"; readonly PublishTime: "2019-03-20T18:59:48.768Z"; readonly NotificationId: "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["93b098e1-c42-2f45-93a1-78910a6a8369"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["2019-03-20T18:59:48.768Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "An explanation about the purpose of this instance."; readonly default: ""; readonly examples: readonly ["8e009934-da2c-4f9c-9bc7-93f23b7e1f60"]; }; }; readonly additionalProperties: true; }; }; readonly additionalProperties: true; }; type ProductTypeDefinitionsChangeNotification = FromSchema; //#endregion //#region src/notifications/report-processing-finished-notification.d.ts declare const reportProcessingFinishedNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly notificationVersion: "2020-09-04"; readonly notificationType: "REPORT_PROCESSING_FINISHED"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2020-07-14T03:35:13.214Z"; readonly payload: { readonly reportProcessingFinishedNotification: { readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }, { readonly notificationVersion: "2020-09-04"; readonly notificationType: "REPORT_PROCESSING_FINISHED"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2020-07-14T03:35:13.214Z"; readonly payload: { readonly reportProcessingFinishedNotification: { readonly accountId: "amzn1.vg.6213651"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly description: "The version of the notification."; readonly examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly description: "The type of the notification."; readonly examples: readonly ["REPORT_PROCESSING_FINISHED"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly description: "The version of the payload."; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly description: "The timestamp of the event, formatted as ISO 8601 date-time."; readonly examples: readonly ["2020-07-14T03:35:13.214Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly type: "object"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly reportProcessingFinishedNotification: { readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }, { readonly reportProcessingFinishedNotification: { readonly accountId: "amzn1.vg.6213651"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }]; readonly required: readonly ["reportProcessingFinishedNotification"]; readonly properties: { readonly reportProcessingFinishedNotification: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification"; readonly type: "object"; readonly description: "An explanation about the purpose of this instance."; readonly examples: readonly [{ readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }, { readonly accountId: "amzn1.vg.6213651"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }]; readonly required: readonly ["accountId", "reportId", "reportType", "processingStatus"]; readonly properties: { readonly sellerId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/sellerId"; readonly type: "string"; readonly description: "The merchant customer identifier of the selling partner account on whose behalf the report was submitted. This field will be null when the report was submitted on behalf of a vendor group identifier."; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly accountId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the report was submitted."; readonly examples: readonly ["amzn1.merchant.o.A3TH9S8BH6GOGM", "amzn1.vg.6213651"]; }; readonly reportId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportId"; readonly type: "string"; readonly description: "The report identifier."; readonly examples: readonly ["54517018502"]; }; readonly reportType: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportType"; readonly type: "string"; readonly description: "The report type."; readonly examples: readonly ["GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"]; }; readonly processingStatus: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/processingStatus"; readonly type: "string"; readonly description: "The processing status of the report."; readonly examples: readonly ["CANCELLED", "DONE", "FATAL"]; readonly enum: readonly ["CANCELLED", "DONE", "FATAL"]; }; readonly reportDocumentId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportDocumentId"; readonly type: "string"; readonly description: "The report document identifier. This identifier is unique only in combination with a seller ID."; readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"]; }; }; }; }; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly type: "object"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/properties/notificationMetadata/properties/applicationId"; readonly type: "string"; readonly description: "The application identifier."; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/properties/notificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly description: "The subscription identifier."; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/properties/notificationMetadata/properties/publishTime"; readonly type: "string"; readonly description: "The timestamp of when the notification was published, formatted as ISO 8601 date-time."; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly notificationId: { readonly $id: "#/properties/notificationMetadata/properties/notificationId"; readonly type: "string"; readonly description: "The notification identifier."; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type ReportProcessingFinishedNotification = FromSchema; //#endregion //#region src/notifications/shipment-tracking-milestone-changed-notification.d.ts declare const shipmentTrackingMilestoneChangedNotification: { readonly title: "Shipment Tracking Milestone Change Notification Schema."; readonly description: "Notification sent when a shipment tracking milestone changes."; readonly $ref: "#/definitions/Notification"; readonly examples: readonly [{ readonly notificationVersion: "1.0"; readonly notificationType: "SHIPMENT_TRACKING_MILESTONE_CHANGED"; readonly payloadVersion: "2026-01-30"; readonly eventTime: "2025-08-08T12:45:48.501Z"; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.g2134566-aaec-55a6-b123-bcb752069ba4"; readonly subscriptionId: "7b28cc50-95c8-4641-add7-10af4b1fecd8"; readonly publishTime: "2025-08-08T12:47:50.501Z"; readonly notificationId: "6712e8e5-b365-4cb1-9fd8-be9dfc6d5bda"; }; readonly payload: { readonly shipmentTrackingMilestoneChangedNotification: { readonly trackingDetail: { readonly identifier: { readonly aftn: "AFTN987654321"; }; readonly latestMilestone: { readonly status: { readonly code: "DELIVERED"; readonly subCode: "PORCH"; readonly description: "Shipment delivered to porch"; }; readonly location: { readonly address: { readonly city: "Austin"; readonly region: "Texas"; readonly countryCode: "US"; }; }; readonly occurredAt: "2026-06-14T01:26:56Z"; }; readonly milestoneHistory: readonly [{ readonly status: { readonly code: "DELIVERED"; readonly subCode: "PORCH"; readonly description: "Shipment delivered to porch"; }; readonly location: { readonly address: { readonly city: "Austin"; readonly region: "Texas"; readonly countryCode: "US"; }; }; readonly occurredAt: "2026-06-14T01:26:56Z"; }, { readonly status: { readonly code: "OUT_FOR_DELIVERY"; readonly description: "Shipment is out for delivery"; }; readonly location: { readonly address: { readonly city: "Buda"; readonly region: "Texas"; readonly countryCode: "US"; }; }; readonly occurredAt: "2026-06-13T16:20:51Z"; }, { readonly status: { readonly code: "SHIPPED"; readonly description: "Shipment has departed origin"; }; readonly occurredAt: "2026-06-13T05:21:43Z"; }, { readonly status: { readonly code: "CARRIER_ASSIGNED"; readonly description: "Carrier was assigned"; }; readonly occurredAt: "2026-06-13T04:41:37Z"; }, { readonly status: { readonly code: "ORDER_PREPARING"; readonly description: "Order is preparing to ship"; }; readonly occurredAt: "2026-06-12T19:43:40Z"; }]; readonly trackingEstimates: readonly [{ readonly type: "ESTIMATED_DELIVERY_DATE"; readonly estimatedInterval: { readonly startTime: "2026-06-14T03:00:00Z"; readonly endTime: "2026-06-14T03:00:00Z"; }; readonly lastUpdatedTime: "2026-06-13T05:21:43Z"; }]; readonly trackingUrl: "https://www.swiship.com/track?id=AFTN987654321"; }; }; }; }]; readonly definitions: {}; }; type ShipmentTrackingMilestoneChangedNotification = FromSchema; //#endregion //#region src/notifications/transaction-update-notification.d.ts declare const transactionUpdateNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly title: "The root schema"; readonly description: "The notification response schema that comprises the entire JSON document for the notification."; readonly examples: readonly [{ readonly NotificationVersion: "1.0"; readonly NotificationType: "TRANSACTION_UPDATE"; readonly PayloadVersion: "1.0"; readonly EventTime: "2023-07-14T03:35:13.214Z"; readonly NotificationMetadata: { readonly ApplicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2023-07-14T03:35:13.214Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; readonly Payload: { readonly TransactionUpdateNotification: { readonly SellingPartnerMetadata: { readonly SellingPartnerId: "A3TH9S8BH6GOGM"; readonly MarketplaceId: "ATIV93840DER"; readonly AccountType: "PAYABLE"; }; readonly RelatedIdentifiers: readonly [{ readonly RelatedIdentifierName: "OrderId"; readonly RelatedIdentifierValue: "8129762527551"; }]; readonly TransactionType: "Shipment"; readonly PostedDate: "2023-07-14T03:35:13.214Z"; readonly TotalAmount: { readonly CurrencyAmount: 10; readonly CurrencyCode: "USD"; }; }; }; }]; readonly required: readonly ["NotificationVersion", "NotificationType", "PayloadVersion", "EventTime", "Payload", "NotificationMetadata"]; readonly properties: { readonly NotificationVersion: { readonly $id: "#/properties/NotificationVersion"; readonly type: "string"; readonly title: "The NotificationVersion schema"; readonly description: "The notification version."; readonly examples: readonly ["1.0"]; }; readonly NotificationType: { readonly $id: "#/properties/NotificationType"; readonly type: "string"; readonly title: "The NotificationType schema"; readonly description: "The type of this notification, used to differentiate different notifications. Combined with payload version controls the structure of payload object."; readonly examples: readonly ["TRANSACTION_UPDATE"]; }; readonly PayloadVersion: { readonly $id: "#/properties/PayloadVersion"; readonly type: "string"; readonly title: "The PayloadVersion schema"; readonly description: "The payload version of the notification."; readonly examples: readonly ["1.0"]; }; readonly EventTime: { readonly $id: "#/properties/EventTime"; readonly type: "string"; readonly title: "The EventTime schema"; readonly description: "The time when this notification was published, presented in ISO-8601 date/time format."; readonly examples: readonly ["2023-07-14T03:35:13.214Z"]; }; readonly Payload: { readonly $id: "#/properties/Payload"; readonly type: "object"; readonly title: "The Payload schema"; readonly description: "The payload for this TRANSACTION_UPDATE notification. It's unique for different event type and will provide more in-depth information about this notification."; readonly examples: readonly [{ readonly TransactionUpdateNotification: { readonly SellingPartnerMetadata: { readonly SellingPartnerId: "A3TH9S8BH6GOGM"; readonly MarketplaceId: "ATIV93840DER"; readonly AccountType: "PAYABLE"; }; readonly RelatedIdentifiers: readonly [{ readonly RelatedIdentifierName: "OrderId"; readonly RelatedIdentifierValue: "8129762527551"; }]; readonly TransactionType: "Shipment"; readonly PostedDate: "2023-07-14T03:35:13.214Z"; readonly TotalAmount: { readonly CurrencyAmount: 10; readonly CurrencyCode: "USD"; }; }; }]; readonly required: readonly ["TransactionUpdateNotification"]; readonly properties: { readonly TransactionUpdateNotification: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification"; readonly type: "object"; readonly title: "The TransactionUpdateNotification schema"; readonly description: "An explanation about the TRANSACTION_UPDATE notification."; readonly examples: readonly [{ readonly SellingPartnerMetadata: { readonly SellingPartnerId: "A3TH9S8BH6GOGM"; readonly MarketplaceId: "ATIV93840DER"; readonly AccountType: "PAYABLE"; }; readonly RelatedIdentifiers: readonly [{ readonly RelatedIdentifierName: "OrderId"; readonly RelatedIdentifierValue: "8129762527551"; }]; readonly TransactionType: "Shipment"; readonly PostedDate: "2023-07-14T03:35:13.214Z"; readonly TotalAmount: { readonly CurrencyAmount: 10; readonly CurrencyCode: "USD"; }; }]; readonly required: readonly ["SellingPartnerMetadata", "TransactionType", "PostedDate", "TotalAmount"]; readonly properties: { readonly SellingPartnerMetadata: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata"; readonly type: "object"; readonly description: "Metadata describing the seller."; readonly examples: readonly [{ readonly SellingPartnerId: "A3TH9S8BH6GOGM"; readonly MarketplaceId: "ATIV93840DER"; readonly AccountType: "PAYABLE"; }]; readonly required: readonly ["SellingPartnerId", "MarketplaceId", "AccountType"]; readonly properties: { readonly SellingPartnerId: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata/properties/SellingPartnerId"; readonly type: "string"; readonly description: "Unique seller identifier."; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly MarketplaceId: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata/properties/MarketplaceId"; readonly type: "string"; readonly description: "Marketplace identifier of transaction."; readonly examples: readonly ["ATIV93840DER"]; }; readonly AccountType: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/SellingPartnerMetadata/properties/AccountType"; readonly type: "string"; readonly description: "Account type of transaction."; readonly examples: readonly ["PAYABLE"]; }; }; }; readonly RelatedIdentifiers: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/RelatedIdentifiers"; readonly type: "array"; readonly description: "Related business identifiers of the transaction."; readonly examples: readonly [readonly [{ readonly RelatedIdentifierName: "OrderId"; readonly RelatedIdentifierValue: "8129762527551"; }]]; readonly items: { readonly type: "object"; readonly description: "Related business identifier of the transaction."; readonly examples: readonly [{ readonly RelatedIdentifierName: "OrderId"; readonly RelatedIdentifierValue: "8129762527551"; }]; readonly required: readonly ["RelatedIdentifierName", "RelatedIdentifierValue"]; readonly properties: { readonly RelatedIdentifierName: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/RelatedIdentifiers/RelatedIdentifierName"; readonly type: "string"; readonly description: "Enumerated set of related business identifier names."; readonly examples: readonly ["OrderId"]; }; readonly RelatedIdentifierValue: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/RelatedIdentifiers/RelatedIdentifierValue"; readonly type: "string"; readonly description: "Corresponding value of RelatedIdentifierName"; readonly examples: readonly ["8129762527551"]; }; }; }; }; readonly TransactionType: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TransactionType"; readonly type: "string"; readonly description: "Type of transaction."; readonly examples: readonly ["Shipment"]; }; readonly PostedDate: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/PostedDate"; readonly type: "string"; readonly description: "The date and time when the transaction was posted."; readonly examples: readonly ["2023-07-14T03:35:13.214Z"]; }; readonly TotalAmount: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TotalAmount"; readonly type: "object"; readonly description: "Total amount of transaction."; readonly examples: readonly [{ readonly CurrencyAmount: 10; readonly CurrencyCode: "USD"; }]; readonly required: readonly ["CurrencyAmount", "CurrencyCode"]; readonly properties: { readonly CurrencyAmount: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TotalAmount/properties/CurrencyAmount"; readonly type: "number"; readonly description: "Amount value of transaction."; readonly examples: readonly [10]; }; readonly CurrencyCode: { readonly $id: "#/properties/Payload/properties/TransactionUpdateNotification/properties/TotalAmount/properties/CurrencyCode"; readonly type: "string"; readonly description: "Currency code of transaction."; readonly examples: readonly ["USD"]; }; }; }; }; }; }; }; readonly NotificationMetadata: { readonly $id: "#/properties/NotificationMetadata"; readonly type: "object"; readonly title: "The NotificationMetadata schema"; readonly description: "The notification metadata."; readonly examples: readonly [{ readonly ApplicationId: "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly SubscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly PublishTime: "2023-07-13T19:42:04.284Z"; readonly NotificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["ApplicationId", "SubscriptionId", "PublishTime", "NotificationId"]; readonly properties: { readonly ApplicationId: { readonly $id: "#/properties/NotificationMetadata/properties/ApplicationId"; readonly type: "string"; readonly title: "The ApplicationId schema"; readonly description: "The identifier for the application that uses the notifications."; readonly examples: readonly ["app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly SubscriptionId: { readonly $id: "#/properties/NotificationMetadata/properties/SubscriptionId"; readonly type: "string"; readonly title: "The SubscriptionId schema"; readonly description: "A unique identifier for the subscription which resulted in this notification."; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly PublishTime: { readonly $id: "#/properties/NotificationMetadata/properties/PublishTime"; readonly type: "string"; readonly title: "The PublishTime schema"; readonly description: "The date and time (in UTC) that the notification was sent, presented in ISO-8601 date/time format."; readonly examples: readonly ["2023-07-14T19:42:04.284Z"]; }; readonly NotificationId: { readonly $id: "#/properties/NotificationMetadata/properties/NotificationId"; readonly type: "string"; readonly title: "The NotificationId schema"; readonly description: "A unique identifier for this notification instance."; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; type TransactionUpdateNotification = FromSchema; declare namespace index_d_exports$1 { export { AnyOfferChangedNotification, B2bAnyOfferChangedNotification, BrandedItemContentChangeNotification, DataKioskQueryProcessingFinishedNotification, DetailPageTrafficEventNotification, FBAInventoryAvailabilityChangeNotification, FBAOutboundShipmentStatusNotification, FeePromotionNotification, FeedProcessingFinishedNotification, FulfillmentOrderStatusNotification, ItemInventoryEventChangeNotification, ItemProductTypeChangeNotification, ItemSalesEventChangeNotification, ListingsItemIssuesChangeNotification, ListingsItemIssuesChangeNotification20231213, ListingsItemMfnQuantityChange, ListingsItemStatusChangeNotification, OrderChangeNotification, PricingHealthNotification, ProductTypeDefinitionsChangeNotification, ReportProcessingFinishedNotification, ShipmentTrackingMilestoneChangedNotification, TransactionUpdateNotification, anyOfferChangedNotification, b2bAnyOfferChangedNotification, brandedItemContentChangeNotification, dataKioskQueryProcessingFinishedNotification, detailPageTrafficEventNotification, fbaInventoryAvailabilityChangeNotification, fbaOutboundShipmentStatusNotification, feePromotionNotification, feedProcessingFinishedNotification, fulfillmentOrderStatusNotification, itemInventoryEventChangeNotification, itemProductTypeChangeNotification, itemSalesEventChangeNotification, listingsItemIssuesChangeNotification, listingsItemIssuesChangeNotification20231213, listingsItemMfnQuantityChange, listingsItemStatusChangeNotification, orderChangeNotification, pricingHealthNotification, productTypeDefinitionsChangeNotification, reportProcessingFinishedNotification, shipmentTrackingMilestoneChangedNotification, transactionUpdateNotification }; } //#endregion //#region src/reports/account-health-report-2020-11-18.d.ts declare const accountHealthReport20201118: { readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly definitions: { readonly DefectsCount: { readonly type: "integer"; readonly description: "The number of defects within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [27833]; }; readonly OrderCount: { readonly type: "integer"; readonly description: "The number of orders within a given reporting date range."; readonly examples: readonly [869118]; }; readonly OrderDefectRate: { readonly type: "object"; readonly description: "Seller's order defect rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }]; readonly required: readonly ["reportingDateRange", "orderCount", "orderWithDefects", "claims", "chargebacks", "negativeFeedback", "fulfillmentType", "status", "rate", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly orderCount: { readonly $ref: "#/definitions/OrderCount"; }; readonly orderWithDefects: { readonly type: "object"; readonly description: "Order defects."; readonly examples: readonly [{ readonly count: 1061; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Order defects count."; readonly type: "integer"; readonly examples: readonly [27833]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly claims: { readonly description: "Order defects due to claims"; readonly type: "object"; readonly examples: readonly [{ readonly count: 1061; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Order defects count."; readonly type: "integer"; readonly examples: readonly [27833]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly chargebacks: { readonly description: "Order defects due to chargebacks"; readonly type: "object"; readonly examples: readonly [{ readonly count: 1061; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Order defects count."; readonly type: "integer"; readonly examples: readonly [27833]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly negativeFeedback: { readonly description: "Order defects due to negative feedback"; readonly type: "object"; readonly examples: readonly [{ readonly count: 1061; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Order defects count."; readonly type: "integer"; readonly examples: readonly [27833]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; readonly Rate: { readonly type: "number"; readonly description: "Performance metric rate in percentage within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [0.005]; }; readonly ReportingDateRange: { readonly description: "ReportingDateRange with start timestamp and end timestamp defined."; readonly type: "object"; readonly examples: readonly [{ readonly reportingDateFrom: "2020-10-20T00:00Z"; readonly reportingDateTo: "2020-11-18T23:59Z"; }]; readonly required: readonly ["reportingDateTo", "reportingDateFrom"]; readonly properties: { readonly reportingDateTo: { readonly description: "Reporting end date in UTC."; readonly type: "string"; readonly examples: readonly ["2020-11-18T23:59Z"]; }; readonly reportingDateFrom: { readonly description: "Reporting start date in UTC."; readonly type: "string"; readonly examples: readonly ["2020-10-20T00:00Z"]; }; }; }; readonly Status: { readonly type: "string"; readonly description: "Listing level violations status within a given reporting date range for 1 requested marketplace. It could be GOOD or BAD or NONE."; readonly examples: readonly ["GOOD"]; readonly enum: readonly ["GOOD", "BAD", "NONE"]; }; readonly TargetValue: { readonly type: "number"; readonly description: "Performance metric target value to stay in good status."; readonly examples: readonly [0.04]; }; readonly TargetCondition: { readonly type: "string"; readonly description: "Performance metric target condition to stay in good status. Possible values are GREATER_THAN, LESS_THAN and EQUALS."; readonly examples: readonly ["EQUALS"]; readonly enum: readonly ["GREATER_THAN", "LESS_THAN", "EQUALS"]; }; readonly ListingLevelViolation: { readonly type: "object"; readonly description: "Seller's listing level violation metric within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 86; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }]; readonly required: readonly ["reportingDateRange", "defectsCount", "status", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly defectsCount: { readonly $ref: "#/definitions/DefectsCount"; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; }; readonly examples: readonly [{ readonly accountStatuses: readonly [{ readonly marketplaceId: "ATVPDKIKX0DER"; readonly status: "AT_RISK"; }, { readonly marketplaceId: "A2EUQ1WTGCTBG2"; readonly status: "NORMAL"; }, { readonly marketplaceId: "A1AM78C64UM0Y8"; readonly status: "SUSPENDED"; }]; readonly performanceMetrics: readonly [{ readonly invoiceDefectRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-21T00:00Z"; readonly reportingDateTo: "2020-10-27T23:59Z"; }; readonly orderCount: 9001; readonly invoiceDefect: { readonly count: 315; readonly status: "GOOD"; }; readonly missingInvoice: { readonly count: 214; readonly status: "NONE"; }; readonly lateInvoice: { readonly count: 101; readonly status: "NONE"; }; readonly status: "GOOD"; readonly rate: 0.03499611; readonly targetValue: 0.05; readonly targetCondition: "LESS_THAN"; }; readonly lateShipmentRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-21T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly orderCount: 870669; readonly lateShipmentCount: 27896; readonly status: "GOOD"; readonly rate: 0.03203973037; readonly targetValue: 0.04; readonly targetCondition: "LESS_THAN"; }; readonly productSafetyCustomerComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-22T00:00Z"; readonly reportingDateTo: "2020-11-17T23:59Z"; }; readonly defectsCount: 165; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly prefulfillmentCancelRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-11-12T00:00Z"; readonly reportingDateTo: "2020-11-18T23:59Z"; }; readonly orderCount: 17197; readonly cancellationCount: 551; readonly status: "GOOD"; readonly rate: 0.005; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; readonly receivedIntellectualPropertyComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 75; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly onTimeDeliveryRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly shipmentCountWithValidTracking: 808046; readonly onTimeDeliveryCount: 847987; readonly status: "GOOD"; readonly rate: 0.9529; readonly targetValue: 0.95; readonly targetCondition: "GREATER_THAN"; }; readonly unitOnTimeDeliveryRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly status: "GOOD"; readonly targetValue: 0.9; readonly targetCondition: "GREATER_THAN"; readonly unitOnTimeDeliveryCount: 146; readonly totalUnitCount: 165; readonly rate: 0.8848; }; readonly listingPolicyViolations: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 86; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly accountHealthRating: { readonly ahrStatus: "WARNED"; readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-23T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; }; readonly foodAndProductSafetyIssues: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 37; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly productAuthenticityCustomerComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-22T00:00Z"; readonly reportingDateTo: "2020-11-17T23:59Z"; }; readonly defectsCount: 212; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly marketplaceId: "ATVPDKIKX0DER"; readonly orderDefectRate: { readonly mfn: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; readonly afn: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; }; readonly documentRequest: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-11-21T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 8; readonly status: "GOOD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly validTrackingRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly shipmentCount: 878443; readonly validTrackingCount: 896462; readonly status: "GOOD"; readonly rate: 0.9529; readonly targetValue: 0.95; readonly targetCondition: "GREATER_THAN"; }; readonly productConditionCustomerComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-22T00:00Z"; readonly reportingDateTo: "2020-11-17T23:59Z"; }; readonly defectsCount: 337; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly otherPolicyViolations: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 86; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly warningState: readonly [{ readonly warningType: "spammingSellerMessaging"; readonly status: "BAD"; }]; }]; }]; readonly required: readonly ["accountStatuses", "performanceMetrics"]; readonly properties: { readonly accountStatuses: { readonly type: "array"; readonly description: "Seller's corresponding account status for each requested marketplace."; readonly additionalItems: false; readonly examples: readonly [readonly [{ readonly marketplaceId: "ATVPDKIKX0DER"; readonly status: "AT_RISK"; }, { readonly marketplaceId: "A2EUQ1WTGCTBG2"; readonly status: "NORMAL"; }, { readonly marketplaceId: "A1AM78C64UM0Y8"; readonly status: "SUSPENDED"; }]]; readonly items: { readonly type: "object"; readonly description: "Seller's corresponding account status for 1 requested marketplace."; readonly examples: readonly [{ readonly marketplaceId: "A1AM78C64UM0Y8"; readonly status: "SUSPENDED"; }]; readonly required: readonly ["marketplaceId", "status"]; readonly properties: { readonly marketplaceId: { readonly description: "A requested marketplace ID."; readonly type: "string"; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly status: { readonly description: "Seller's account status for a requested marketplace."; readonly type: "string"; readonly examples: readonly ["DEACTIVATED"]; readonly enum: readonly ["NORMAL", "AT_RISK", "DEACTIVATED"]; }; }; }; }; readonly performanceMetrics: { readonly type: "array"; readonly description: "Seller's performance metrics for requeted marketpalces."; readonly additionalItems: false; readonly examples: readonly [{ readonly invoiceDefectRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-21T00:00Z"; readonly reportingDateTo: "2020-10-27T23:59Z"; }; readonly orderCount: 9001; readonly invoiceDefect: { readonly count: 315; readonly status: "GOOD"; }; readonly missingInvoice: { readonly count: 214; readonly status: "NONE"; }; readonly lateInvoice: { readonly count: 101; readonly status: "NONE"; }; readonly status: "GOOD"; readonly rate: 0.03499611; readonly targetValue: 0.05; readonly targetCondition: "LESS_THAN"; }; readonly lateShipmentRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-21T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly orderCount: 870669; readonly lateShipmentCount: 27896; readonly status: "GOOD"; readonly rate: 0.03203973037; readonly targetValue: 0.04; readonly targetCondition: "LESS_THAN"; }; readonly productSafetyCustomerComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-22T00:00Z"; readonly reportingDateTo: "2020-11-17T23:59Z"; }; readonly defectsCount: 165; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly prefulfillmentCancelRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-11-12T00:00Z"; readonly reportingDateTo: "2020-11-18T23:59Z"; }; readonly orderCount: 17197; readonly cancellationCount: 551; readonly status: "GOOD"; readonly rate: 0.005; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; readonly receivedIntellectualPropertyComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 75; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly onTimeDeliveryRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly shipmentCountWithValidTracking: 808046; readonly onTimeDeliveryCount: 847987; readonly status: "GOOD"; readonly rate: 0.9529; readonly targetValue: 0.95; readonly targetCondition: "GREATER_THAN"; }; readonly unitOnTimeDeliveryRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly status: "GOOD"; readonly targetValue: 0.9; readonly targetCondition: "GREATER_THAN"; readonly unitOnTimeDeliveryCount: 146; readonly totalUnitCount: 165; readonly rate: 0.8848; }; readonly listingPolicyViolations: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 86; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly accountHealthRating: { readonly ahrStatus: "WARNED"; readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-23T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; }; readonly foodAndProductSafetyIssues: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 37; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly productAuthenticityCustomerComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-22T00:00Z"; readonly reportingDateTo: "2020-11-17T23:59Z"; }; readonly defectsCount: 212; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly marketplaceId: "ATVPDKIKX0DER"; readonly orderDefectRate: { readonly mfn: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; readonly afn: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; }; readonly documentRequest: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-11-21T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 8; readonly status: "GOOD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly validTrackingRate: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly shipmentCount: 878443; readonly validTrackingCount: 896462; readonly status: "GOOD"; readonly rate: 0.9529; readonly targetValue: 0.95; readonly targetCondition: "GREATER_THAN"; }; readonly productConditionCustomerComplaints: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-22T00:00Z"; readonly reportingDateTo: "2020-11-17T23:59Z"; }; readonly defectsCount: 337; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly otherPolicyViolations: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-24T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly defectsCount: 86; readonly status: "BAD"; readonly targetValue: 0; readonly targetCondition: "EQUALS"; }; readonly warningState: readonly [{ readonly warningType: "spammingSellerMessaging"; readonly status: "BAD"; }]; }]; readonly items: { readonly type: "object"; readonly description: "Report data for the program."; readonly required: readonly ["marketplaceId", "invoiceDefectRate", "lateShipmentRate", "orderDefectRate", "onTimeDeliveryRate", "unitOnTimeDeliveryRate", "validTrackingRate", "preFulfillmentCancellationRate", "warningStates", "accountHealthRating", "listingPolicyViolations", "productAuthenticityCustomerComplaints", "productConditionCustomerComplaints", "productSafetyCustomerComplaints", "receivedIntellectualPropertyComplaints", "restrictedProductPolicyViolations", "suspectedIntellectualPropertyViolations", "foodAndProductSafetyIssues", "otherPolicyViolations", "documentRequests"]; readonly properties: { readonly marketplaceId: { readonly description: "A requested marketplace ID."; readonly type: "string"; }; readonly invoiceDefectRate: { readonly type: "object"; readonly description: "Seller's invoice defect rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-21T00:00Z"; readonly reportingDateTo: "2020-10-27T23:59Z"; }; readonly orderCount: 9001; readonly invoiceDefect: { readonly count: 315; readonly status: "GOOD"; }; readonly missingInvoice: { readonly count: 214; readonly status: "NONE"; }; readonly lateInvoice: { readonly count: 101; readonly status: "NONE"; }; readonly status: "GOOD"; readonly rate: 0.03499611; readonly targetValue: 0.05; readonly targetCondition: "LESS_THAN"; }]; readonly required: readonly ["reportingDateRange", "orderCount", "invoiceDefect", "missingInvoice", "lateInvoice", "status", "rate", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly orderCount: { readonly $ref: "#/definitions/OrderCount"; }; readonly invoiceDefect: { readonly description: "Total invoice defects count due to missing invoice and late invoice."; readonly type: "object"; readonly examples: readonly [{ readonly count: 315; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Invoice defects count."; readonly type: "integer"; readonly examples: readonly [315]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly missingInvoice: { readonly description: "Total missing invoice count in the time window."; readonly type: "object"; readonly examples: readonly [{ readonly count: 214; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Missing invoice defects count."; readonly type: "integer"; readonly examples: readonly [214]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly lateInvoice: { readonly description: "Total late invoice count in the time window."; readonly type: "object"; readonly examples: readonly [{ readonly count: 101; readonly status: "GOOD"; }]; readonly required: readonly ["count", "status"]; readonly properties: { readonly count: { readonly description: "Late invoice defects count."; readonly type: "integer"; readonly examples: readonly [101]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; }; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; readonly lateShipmentRate: { readonly type: "object"; readonly description: "Seller's late shipment rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-21T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; }; readonly orderCount: 870669; readonly lateShipmentCount: 27896; readonly status: "GOOD"; readonly rate: 0.03203973037; readonly targetValue: 0.04; readonly targetCondition: "LESS_THAN"; }]; readonly required: readonly ["reportingDateRange", "orderCount", "lateShipmentCount", "status", "rate", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly orderCount: { readonly $ref: "#/definitions/OrderCount"; }; readonly lateShipmentCount: { readonly type: "integer"; readonly description: "Order defects count due to late shipment."; readonly examples: readonly [27833]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; readonly orderDefectRate: { readonly type: "object"; readonly description: "Seller's MFN/AFN order defect rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly mfn: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; readonly afn: { readonly reportingDateRange: { readonly reportingDateFrom: "2020-09-06T00:00Z"; readonly reportingDateTo: "2020-11-04T23:59Z"; }; readonly orderCount: 539000; readonly orderWithDefects: { readonly count: 1078; readonly status: "GOOD"; }; readonly claims: { readonly count: 442; readonly status: "NONE"; }; readonly chargebacks: { readonly count: 15; readonly status: "NONE"; }; readonly negativeFeedback: { readonly count: 628; readonly status: "NONE"; }; readonly fulfillmentType: "mfn"; readonly status: "GOOD"; readonly rate: 0.009; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }; }]; readonly required: readonly ["mfn", "afn"]; readonly properties: { readonly mfn: { readonly $ref: "#/definitions/OrderDefectRate"; }; readonly afn: { readonly $ref: "#/definitions/OrderDefectRate"; }; }; }; readonly onTimeDeliveryRate: { readonly type: "object"; readonly description: "Seller's on-time delivery rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly shipmentCountWithValidTracking: 808046; readonly onTimeDeliveryCount: 847987; readonly status: "GOOD"; readonly rate: 0.9529; readonly targetValue: 0.95; readonly targetCondition: "GREATER_THAN"; }]; readonly required: readonly ["reportingDateRange", "shipmentCountWithValidTracking", "onTimeDeliveryCount", "status", "rate", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly shipmentCountWithValidTracking: { readonly description: "The number of shipments with valid tracking associated within a given reporting date range for 1 requested marketplace."; readonly type: "number"; readonly examples: readonly [1234]; }; readonly onTimeDeliveryCount: { readonly description: "On-time delivered shipment count within a given reporting date range for 1 requested marketplace."; readonly type: "integer"; readonly examples: readonly [1061]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; readonly unitOnTimeDeliveryRate: { readonly type: "object"; readonly description: "The seller's on-time delivery rate at a unit level within a reporting date range for one marketplace that you specify. This metric is only available in the US marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly status: "GOOD"; readonly targetValue: 0.9; readonly targetCondition: "GREATER_THAN"; readonly unitOnTimeDeliveryCount: 146; readonly totalUnitCount: 165; readonly rate: 0.8848; }]; readonly required: readonly ["reportingDateRange", "status", "targetValue", "targetCondition", "unitOnTimeDeliveryCount", "totalUnitCount", "rate"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; readonly unitOnTimeDeliveryCount: { readonly description: "The on-time delivery unit count within a reporting date range for one marketplace that you specify."; readonly type: "integer"; readonly examples: readonly [1061]; }; readonly totalUnitCount: { readonly description: "The total unit count within a reporting date range for one marketplace that you specify."; readonly type: "integer"; readonly examples: readonly [2000]; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; }; }; readonly validTrackingRate: { readonly type: "object"; readonly description: "Seller's valid tracking rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-10-11T00:00Z"; readonly reportingDateTo: "2020-11-09T23:59Z"; }; readonly shipmentCount: 878443; readonly validTrackingCount: 896462; readonly status: "GOOD"; readonly rate: 0.9529; readonly targetValue: 0.95; readonly targetCondition: "GREATER_THAN"; }]; readonly required: readonly ["reportingDateRange", "shipmentCount", "validTrackingCount", "status", "rate", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly shipmentCount: { readonly description: "The number of shipments within a given reporting date range for 1 requested marketplace."; readonly type: "integer"; readonly examples: readonly [1234]; }; readonly validTrackingCount: { readonly description: "Shipment with valid tracking count within a given reporting date range for 1 requested marketplace."; readonly type: "integer"; readonly examples: readonly [1061]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; readonly preFulfillmentCancellationRate: { readonly type: "object"; readonly description: "Seller's pre-fulfillment cancellation rate within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly reportingDateRange: { readonly reportingDateFrom: "2020-11-12T00:00Z"; readonly reportingDateTo: "2020-11-18T23:59Z"; }; readonly orderCount: 17197; readonly cancellationCount: 551; readonly status: "GOOD"; readonly rate: 0.005; readonly targetValue: 0.01; readonly targetCondition: "LESS_THAN"; }]; readonly required: readonly ["reportingDateRange", "orderCount", "cancellationCount", "status", "rate", "targetValue", "targetCondition"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly orderCount: { readonly $ref: "#/definitions/OrderCount"; }; readonly cancellationCount: { readonly type: "integer"; readonly description: "The number of seller faulted cancelled orders within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [27833]; }; readonly status: { readonly $ref: "#/definitions/Status"; }; readonly rate: { readonly $ref: "#/definitions/Rate"; }; readonly targetValue: { readonly $ref: "#/definitions/TargetValue"; }; readonly targetCondition: { readonly $ref: "#/definitions/TargetCondition"; }; }; }; readonly warningStates: { readonly type: "array"; readonly description: "A list of seller warning states for 1 requested marketplace."; readonly additionalItems: false; readonly examples: readonly [readonly [{ readonly warningType: "spammingSellerMessaging"; readonly status: "BAD"; }]]; readonly items: { readonly type: "object"; readonly description: "Seller account warning state for 1 requested marketplace."; readonly required: readonly ["warningType", "status"]; readonly properties: { readonly warningType: { readonly description: "Seller account warning type for 1 requested marketplace."; readonly type: "string"; readonly examples: readonly ["spammingSellerMessaging"]; }; readonly status: { readonly description: "Seller account warning state status for 1 requested marketplace. It could be GOOD or BAD or NONE."; readonly type: "string"; readonly examples: readonly ["BAD"]; readonly enum: readonly ["GOOD", "BAD", "NONE"]; }; }; }; }; readonly accountHealthRating: { readonly type: "object"; readonly description: "Seller's account health rating within a given reporting date range for 1 requested marketplace."; readonly examples: readonly [{ readonly ahrStatus: "WARNED"; readonly reportingDateRange: { readonly reportingDateFrom: "2020-05-23T00:00Z"; readonly reportingDateTo: "2020-11-19T23:59Z"; readonly dateOffset: { readonly duration: 181; readonly offset: 0; }; }; }]; readonly required: readonly ["ahrStatus", "reportingDateRange"]; readonly properties: { readonly reportingDateRange: { readonly $ref: "#/definitions/ReportingDateRange"; }; readonly accountHealthRatingStatus: { readonly type: "string"; readonly description: "Seller's overall Account Health Rating status within a given reporting date range for 1 requested marketplace. It could be GREAT or WARNED"; readonly examples: readonly ["WARNED"]; readonly enum: readonly ["GREAT", "WARNED"]; }; }; }; readonly listingPolicyViolations: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly productAuthenticityCustomerComplaints: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly productConditionCustomerComplaints: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly productSafetyCustomerComplaints: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly receivedIntellectualPropertyComplaints: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly restrictedProductPolicyViolations: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly suspectedIntellectualPropertyViolations: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly foodAndProductSafetyIssues: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly otherPolicyViolations: { readonly $ref: "#/definitions/ListingLevelViolation"; }; readonly documentRequests: { readonly $ref: "#/definitions/ListingLevelViolation"; }; }; }; }; }; }; type AccountHealthReport20201118 = FromSchema; //#endregion //#region src/reports/b-2-b-product-opportunities-not-yet-on-amazon-report-2020-11-19.d.ts declare const b2bProductOpportunitiesNotYetOnAmazonReport20201119: { readonly type: "object"; readonly description: "Provides B2B product recommendations based on predicted incremental units sold, unmet buyer demand, and other factors for products not yet listed on Amazon. The recommendations are personalized to the seller based on past sales activity."; readonly examples: readonly [{ readonly recommendations: readonly [{ readonly itemName: "Exclusive Home Cabana Indoor/Outdoor Grommet Top Curtain Panel Pair"; readonly brand: "EXCLUSIVE HOME"; readonly category: "Furniture"; readonly ean: "6424721049560"; readonly initialB2bBuyerRequestedDate: "2020-11-14 00:00:00"; }]; }]; readonly required: readonly ["recommendations"]; readonly properties: { readonly recommendations: { readonly type: "array"; readonly description: "A list of B2B product opportunity recommendation objects."; readonly additionalItems: true; readonly items: { readonly type: "object"; readonly description: "The recommendation result object."; readonly required: readonly []; readonly properties: { readonly itemName: { readonly type: "string"; readonly description: "The title of the product."; }; readonly brand: { readonly type: "string"; readonly description: "The brand name of the product."; }; readonly category: { readonly type: "string"; readonly description: "The primary product category."; }; readonly initialB2bBuyerIndustry: { readonly type: "string"; readonly description: "The industry of the first customer who requested the product."; }; readonly partNumber: { readonly type: "string"; readonly description: "The Manufacturer Part Number (MPN) of the product."; }; readonly ean: { readonly type: "string"; readonly description: "The European Article Number (EAN) of the product."; }; readonly upc: { readonly type: "string"; readonly description: "The Universal Product Code (UPC) of the product."; }; readonly modelNumber: { readonly type: "string"; readonly description: "The Model Number of the product."; }; readonly isbn: { readonly type: "string"; readonly description: "The International Standard Book Number (ISBN) of the product."; }; readonly initialB2bBuyerRequestedDate: { readonly type: "string"; readonly description: "The date the product may not be on Amazon as the result of the customer request."; }; }; }; }; }; }; type B2bProductOpportunitiesNotYetOnAmazonReport20201119 = FromSchema; //#endregion //#region src/reports/b-2-b-product-opportunities-recommended-for-you-report-2020-11-19.d.ts declare const b2bProductOpportunitiesRecommendedForYouReport20201119: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly description: "Provides B2B product recommendations based on predicted incremental units sold, unmet buyer demand, low offer count, and other factors for products already offered on Amazon. The recommendations are personalized to the Seller based on past sales activity."; readonly examples: readonly [{ readonly recommendations: readonly [{ readonly asin: "B001F0R1FG"; readonly itemName: "HP 05A | CE505A | Toner Cartridge | Black"; readonly link: "https://www.amazon.com/dp/B001F0R1FG/ref_=mbop"; readonly brand: "HP"; readonly category: "Office Products"; readonly subCategory: "0375 Toner"; readonly lowestPriceInTheLastWeek: { readonly amount: 43.95; readonly currencyCode: "USD"; }; readonly hasFBAOffer: true; readonly offerCount: 50; readonly hasAmazonOffer: true; readonly hasOfferWithVatInvoiceGeneration: false; readonly reviewCount: 439; readonly b2bSalesRank: 2158; readonly b2bSalesRankGrowth: "LOW"; readonly pageViews: "MEDIUM"; readonly partNumber: "CE505A"; readonly ean: "3663361254702"; readonly upc: "701748596694"; readonly modelNumber: "CE505A"; readonly isBrandYouOffer: true; readonly isCategoryYouOffer: true; readonly productPerformance: "TIER_1"; readonly isProductOnAmazon: false; }]; }, { readonly recommendations: readonly [{ readonly asin: "B07F77R77F"; readonly itemName: "Nitras Motion TEX VIZ Veste Softshell Haute visibilité | Veste de Travail avec Bordure réfléchissante 3M | Coupe-Vent | XXL"; readonly link: "https://www.amazon.fr/dp/B07F77R77F/ref_=mbop"; readonly brand: "NITRAS"; readonly category: "Apparel"; readonly subCategory: "1950 Men's Other"; readonly lowestPriceInTheLastWeek: { readonly amount: 59.98; readonly currencyCode: "EUR"; }; readonly hasFBAOffer: true; readonly offerCount: 1; readonly hasAmazonOffer: false; readonly hasOfferWithVatInvoiceGeneration: false; readonly reviewCount: 5; readonly b2bSalesRank: 1156; readonly b2bSalesRankGrowth: "LOW"; readonly pageViews: "HIGH"; readonly partNumber: "7171-2XL"; readonly ean: "4061553011352"; readonly modelNumber: "7171_XXL"; readonly isBrandYouOffer: false; readonly isCategoryYouOffer: true; readonly productPerformance: "TIER_3"; readonly isProductOnAmazon: false; }]; }, { readonly recommendations: readonly [{ readonly asin: "B08DYCHX68"; readonly itemName: "無印良品 公園の時計 大 ヌメ革 腕時計 MJ-PCWB2 ソーラー充電 公園の時計大"; readonly link: "https://www.amazon.co.jp/dp/B08DYCHX68/ref_=mbop"; readonly brand: "ノーブランド品"; readonly category: "Toys"; readonly subCategory: "0600 Hobbies"; readonly lowestPriceInTheLastWeek: { readonly amount: 13803; readonly currencyCode: "JPY"; }; readonly hasFBAOffer: false; readonly offerCount: 139; readonly hasAmazonOffer: false; readonly hasOfferWithVatInvoiceGeneration: false; readonly reviewCount: 0; readonly b2bSalesRank: 499; readonly b2bSalesRankGrowth: "LOW"; readonly pageViews: "HIGH"; readonly partNumber: "7171-2XL"; readonly ean: "4061553011352"; readonly modelNumber: "7171_XXL"; readonly isBrandYouOffer: true; readonly isCategoryYouOffer: true; readonly productPerformance: "TIER_3"; readonly isProductOnAmazon: false; }]; }, { readonly recommendations: readonly [{ readonly asin: "B07NYFV364"; readonly itemName: "HandPro Black Nitrile Powder free hand gloves 1 Box (Medium)"; readonly link: "https://www.amazon.in/dp/B07NYFV364/ref_=mbop"; readonly brand: "HandPRO"; readonly category: "Biss"; readonly subCategory: "3100 Professional Medical"; readonly lowestPriceInTheLastWeek: { readonly amount: 699; readonly currencyCode: "INR"; }; readonly hasFBAOffer: false; readonly offerCount: 1; readonly hasAmazonOffer: false; readonly hasOfferWithVatInvoiceGeneration: false; readonly reviewCount: 13; readonly b2bSalesRank: 53; readonly b2bSalesRankGrowth: "HIGH"; readonly pageViews: "MEDIUM"; readonly isBrandYouOffer: true; readonly isCategoryYouOffer: true; readonly productPerformance: "TIER_1"; readonly isProductOnAmazon: false; }]; }]; readonly required: readonly ["recommendations"]; readonly properties: { readonly recommendations: { readonly type: "array"; readonly description: "A list of B2B product opportunity recommendation objects."; readonly additionalItems: true; readonly items: { readonly type: "object"; readonly description: "The recommendation result object."; readonly required: readonly ["asin"]; readonly properties: { readonly asin: { readonly type: "string"; readonly description: "The Amazon Standard Identification Number (ASIN)."; }; readonly itemName: { readonly type: "string"; readonly description: "The title of the product."; }; readonly link: { readonly type: "string"; readonly description: "A hyperlink to the Amazon product detail page."; }; readonly brand: { readonly type: "string"; readonly description: "The brand name of the product."; }; readonly category: { readonly type: "string"; readonly description: "The primary product category (For example, Office Products)."; }; readonly subCategory: { readonly type: "string"; readonly description: "The secondary product category (For example, Computer Monitors)."; }; readonly lowestPriceInTheLastWeek: { readonly type: "object"; readonly description: "The lowest priced offer on the product in the last week."; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The currency amount."; }; readonly currencyCode: { readonly description: "Three-digit currency code. In ISO 4217 format."; readonly type: "string"; }; }; }; readonly hasFBAOffer: { readonly type: "boolean"; readonly description: "A 'true' means at least one Fulfillment by Amazon (FBA) offer exists on the product. A 'false' means there are no FBA offers for the product."; }; readonly offerCount: { readonly type: "integer"; readonly description: "The total number of active offers on the product (including Amazon Retail)."; }; readonly hasAmazonOffer: { readonly type: "boolean"; readonly description: "A 'true' means that an active Amazon (retail) offer exists on the product. A 'false' means there are no active Amazon offers for the product."; }; readonly hasOfferWithVatInvoiceGeneration: { readonly type: "boolean"; readonly description: "This field will be equal to 'true' only if it has at least one offer from a seller who has adopted an automated solution for VAT invoice generation. This type of offer will guarantee that the buyer will have access to a downloadable VAT invoice."; }; readonly reviewCount: { readonly type: "integer"; readonly description: "The total number of customer reviews for the product."; }; readonly b2bSalesRank: { readonly type: "integer"; readonly description: "The sales rank of the product, at the Category level, based only on Amazon Business customer purchases."; }; readonly b2bSalesRankGrowth: { readonly type: "string"; readonly description: "A general measure of how much the business sales rank has grown (relative to other products in the category) over the past 30 days displayed as 'HIGH', 'MEDIUM', or 'LOW'."; readonly enum: readonly ["HIGH", "MEDIUM", "LOW"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "HIGH"; readonly description: "'HIGH' means that the product’s business sales rank has grown over 33% from the previous month."; }, { readonly value: "MEDIUM"; readonly description: "'MEDIUM' means that it has grown from 0% to 33%."; }, { readonly value: "LOW"; readonly description: "'LOW' means that the Business Sales Rank has decreased (growth less than 0%)."; }]; }; readonly pageViews: { readonly type: "string"; readonly description: "A general measure of how many times the product has been viewed in the past 30 days displayed as 'HIGH', 'MEDIUM', or 'LOW'."; readonly enum: readonly ["HIGH", "MEDIUM", "LOW"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "HIGH"; readonly description: "'HIGH' means that the product is in the top 40% of the product’s category."; }, { readonly value: "MEDIUM"; readonly description: "'MEDIUM' means the product is in the next 40%."; }, { readonly value: "LOW"; readonly description: "'LOW' means that the product is in the bottom 20% of its category."; }]; }; readonly partNumber: { readonly type: "string"; readonly description: "The Manufacturer Part Number (MPN) of the product."; }; readonly ean: { readonly type: "string"; readonly description: "The European Article Number (EAN) of the product."; }; readonly upc: { readonly type: "string"; readonly description: "The Universal Product Code (UPC) of the product."; }; readonly modelNumber: { readonly type: "string"; readonly description: "The Model Number of the product."; }; readonly isbn: { readonly type: "string"; readonly description: "The International Standard Book Number (ISBN) of the product."; }; readonly isBrandYouOffer: { readonly type: "boolean"; readonly description: "A 'true' means that the product shares a brand with at least one of your active offers. A 'false' means the product does not share a brand with any of your active offers."; }; readonly isCategoryYouOffer: { readonly type: "boolean"; readonly description: "A 'true' means the product shares a category with at least one of your active offers. A 'false' means the product does not share a category with any of your active offers."; }; readonly productPerformance: { readonly type: "string"; readonly description: "A general measure of product sales to Amazon Business customers over the past 30 days displayed as 'TIER_1', 'TIER_2', and 'TIER_3' where 'TIER_1' is best performing and 'TIER_3' is least performing. Product performance is based on the business sales rank."; readonly enum: readonly ["TIER_1", "TIER_2", "TIER_3"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "TIER_1"; readonly description: "If the product has a business sales rank under 10,000, it is considered 'TIER_1'."; }, { readonly value: "TIER_2"; readonly description: "If a product has a business sales rank between 10,000 and 20,000, then the product is considered 'TIER_2'."; }, { readonly value: "TIER_3"; readonly description: "If the product has a business sales rank over 20,000, it is considered 'TIER_3'."; }]; }; readonly isProductOnAmazon: { readonly type: "boolean"; readonly description: "A 'true' means the product is listed on Amazon. A 'false' means the product is not listed on Amazon."; }; }; }; }; }; }; type B2bProductOpportunitiesRecommendedForYouReport20201119 = FromSchema; //#endregion //#region src/reports/end-user-data-report.d.ts declare const endUserDataReport: { readonly type: "object"; readonly description: "Provides end user (customer) data to IE, ES, FR, BE, NL, DE, IT, SE, and PL selling partners. The data contains customer personal data that includes contact information, page view (glance view), and order data for customers that elect to share this data with specific sellers. The customer data is accessible across various reporting periods (DAY, WEEK, and MONTH). Developers can choose start and end dates and the reporting period for data retrieval and aggregation. If the customer does not elect to share their data, the report does not generate data."; readonly examples: readonly [{ readonly reportSpecification: { readonly dataStartTime: "2023-09-10"; readonly dataEndTime: "2023-09-16"; readonly reportType: "END_USER_DATA_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly marketplaceIds: readonly ["A1PA6795UKMFR9", "APJ6JRA9NG5V4"]; }; readonly endUserData: readonly [{ readonly fullName: "John Doe"; readonly mailingAddress: { readonly addressLine1: "ABC Blvd"; readonly addressLine2: "Apartment 000"; readonly addressLine3: ""; readonly city: "Berlin"; readonly stateOrRegion: "Berlin"; readonly districtOrCounty: ""; readonly postalCode: "10115"; readonly countryCode: "DE"; }; readonly primaryEmail: "jdoe@xyz.com"; readonly asinMetrics: readonly [{ readonly startDate: "2023-09-10"; readonly endDate: "2023-09-16"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-09-10"; readonly endDate: "2023-09-16"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 432; readonly gms: 98.8; readonly currencyCode: "EUR"; }]; }, { readonly fullName: "Oliver Smith"; readonly mailingAddress: { readonly addressLine1: "000 XYZ Street"; readonly addressLine2: ""; readonly addressLine3: ""; readonly city: "Rome"; readonly stateOrRegion: "Lazio"; readonly districtOrCounty: ""; readonly postalCode: "39100"; readonly countryCode: "IT"; }; readonly primaryEmail: "osmith@xyz.com"; readonly asinMetrics: readonly [{ readonly startDate: "2023-09-10"; readonly endDate: "2023-09-16"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-09-10"; readonly endDate: "2023-09-16"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 432; readonly gms: 98.8; readonly currencyCode: "EUR"; }]; }]; }, { readonly reportSpecification: { readonly reportType: "END_USER_DATA_REPORT"; readonly marketplaceIds: readonly ["A1PA6795UKMFR9"]; readonly dataStartTime: "2022-08-15"; readonly dataEndTime: "2023-10-05"; }; readonly endUserData: readonly [{ readonly fullName: "John Doe"; readonly mailingAddress: { readonly addressLine1: "ABC Blvd"; readonly addressLine2: "Apartment 000"; readonly addressLine3: ""; readonly city: "Berlin"; readonly stateOrRegion: "Berlin"; readonly districtOrCounty: ""; readonly postalCode: "10115"; readonly countryCode: "DE"; }; readonly primaryEmail: "jdoe@xyz.com"; readonly asinMetrics: readonly [{ readonly startDate: "2023-09-01"; readonly endDate: "2023-09-30"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 1256; readonly gms: 125.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-08-01"; readonly endDate: "2023-08-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-07-01"; readonly endDate: "2023-07-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-06-01"; readonly endDate: "2023-06-30"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-05-01"; readonly endDate: "2023-05-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-04-01"; readonly endDate: "2023-04-30"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-03-01"; readonly endDate: "2023-03-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-02-01"; readonly endDate: "2023-02-28"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2023-01-01"; readonly endDate: "2023-01-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2022-12-01"; readonly endDate: "2022-12-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2022-11-01"; readonly endDate: "2022-11-30"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2022-10-01"; readonly endDate: "2022-10-31"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }, { readonly startDate: "2022-09-01"; readonly endDate: "2022-09-30"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; readonly gms: 145.2; readonly currencyCode: "EUR"; }]; }]; }]; readonly required: readonly ["reportSpecification", "endUserData"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the report request."; readonly required: readonly ["reportType", "marketplaceIds", "dataStartTime", "dataEndTime"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; }; readonly reportOptions: { readonly type: "object"; readonly description: "Used to specify the report period."; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "The granularity of the data in the report. Valid values are: DAY, WEEK, and MONTH. If no granularity is specified, reportPeriod defaults to MONTH."; readonly enum: readonly ["DAY", "WEEK", "MONTH"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. If the provided start date occurs mid-week or mid-month, the following Sunday for weekly reporting periods or the first day of the next month for monthly reporting periods will be used instead."; readonly examples: readonly ["2023-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. If the provided end date occurs mid-week or mid-month, the preceding Saturday for weekly reporting periods or the last day of the previous month for monthly reporting periods will be used instead. Additionally if the end date differs from the start date by more than 365 days, it will be adjusted to the closest end date with a maximum 365 day difference based on the selected reporting period."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Any of the EU(8) marketplaces. DE, FR, IT, ES, NL, PL, SE and BE"; readonly items: { readonly type: "string"; readonly description: "Any EU(8) Marketplace ID. DE, FR, IT, ES, NL, PL, SE and BE. The ID for the marketplace can be found on the SP-API documentation. - https://developer-docs.amazon.com/sp-api/docs/marketplace-ids"; }; }; }; }; readonly endUserData: { readonly type: "array"; readonly description: "A list of consented end users (buyers) and their data."; readonly items: { readonly $ref: "#/definitions/EndUserData"; }; }; }; readonly definitions: { readonly EndUserData: { readonly type: "object"; readonly description: "Contains end user contact information, page view and GMS metrics."; readonly required: readonly ["fullName", "mailingAddress", "primaryEmail", "asinMetrics"]; readonly properties: { readonly fullName: { readonly type: "string"; readonly description: "Full Name of the end user."; }; readonly mailingAddress: { readonly type: "object"; readonly description: "Mailing address of the end user."; readonly properties: { readonly addressLine1: { readonly type: "string"; readonly description: "The first line of the address."; }; readonly addressLine2: { readonly type: "string"; readonly description: "Additional address."; }; readonly addressLine3: { readonly type: "string"; readonly description: "Additional address."; }; readonly city: { readonly type: "string"; readonly description: "City."; }; readonly stateOrRegion: { readonly type: "string"; readonly description: "State or Region."; }; readonly districtOrCounty: { readonly type: "string"; readonly description: "District or County."; }; readonly postalCode: { readonly type: "string"; readonly description: "Postal code."; }; readonly countryCode: { readonly type: "string"; readonly description: "The two letter ISO 3166-1 alpha-2 country code."; readonly examples: readonly ["IT", "DE", "FR"]; }; }; }; readonly primaryEmail: { readonly type: "string"; readonly description: "Primary email of the end user."; }; readonly asinMetrics: { readonly type: "array"; readonly description: "A list of Asin Page View and GMS metrics of an end user."; readonly items: { readonly $ref: "#/definitions/AsinMetrics"; }; }; }; }; readonly AsinMetrics: { readonly type: "object"; readonly description: "Page view and GMS metrics of the end user."; readonly required: readonly ["startDate", "endDate", "marketplaceId", "asin"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "Start date of the aggregation window."; readonly examples: readonly ["2023-01-16"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "End date of the aggregation window."; readonly examples: readonly ["2023-01-23"]; }; readonly marketplaceId: { readonly type: "string"; readonly description: "Marketplace for which the metrics are provided."; readonly examples: readonly ["A1PA6795UKMFR9"]; }; readonly asin: { readonly type: "string"; readonly description: "ASIN for which the metrics are provided. Only ASINs with an active offer from the Seller are included."; readonly examples: readonly ["B00EZ1IGCO"]; }; readonly pageViews: { readonly type: "integer"; readonly description: "End user's page views (count) for the ASIN."; readonly minimum: 0; readonly examples: readonly [12352]; }; readonly gms: { readonly type: "number"; readonly description: "End user's GMS for the ASIN. GMS = (Product Price * Quantity) + Shipping + Giftwrap - Returns - Promotional Discounts."; readonly minimum: 0; readonly examples: readonly [15.23]; }; readonly currencyCode: { readonly type: "string"; readonly description: "The ISO 4217 currency code in which GMS is calculated."; readonly examples: readonly ["EUR"]; }; }; }; }; }; type EndUserDataReport = FromSchema; //#endregion //#region src/reports/marketplace-asin-page-view-metrics.d.ts declare const marketplaceAsinPageViewMetrics: { readonly type: "object"; readonly description: "Provides information on the ASIN page view (glance view) metrics for the DE, FR, IT, ES, NL, PL, SE, BE (EU-8) and UK marketplaces, with data available up to the last seven days. A page view is a customer view of the product's detail page for a given ASIN. Developers have the option to specify a start and end date to retrieve data within that range. If no dates are specified, the report will provide the data for the latest available day. For marketplaces and product categories where the seller does not have a meaningful presence (40 units sold), the report will not return any data."; readonly examples: readonly [{ readonly reportSpecification: { readonly dataStartTime: "2023-04-27"; readonly dataEndTime: "2023-05-03"; readonly reportType: "MARKETPLACE_ASIN_PAGE_VIEW_METRICS"; readonly reportOptions: { readonly productType: "AUTO_BATTERY"; }; readonly marketplaceIds: readonly ["A1PA6795UKMFR9", "APJ6JRA9NG5V4"]; }; readonly marketplaceAsinPageViewMetrics: readonly [{ readonly startTime: "2023-04-27T00:00:00Z"; readonly endTime: "2023-04-28T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12352; }, { readonly startTime: "2023-04-28T00:00:00Z"; readonly endTime: "2023-04-29T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 12321; }, { readonly startTime: "2023-04-29T00:00:00Z"; readonly endTime: "2023-04-30T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 10021; }, { readonly startTime: "2023-04-30T00:00:00Z"; readonly endTime: "2023-05-01T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 1432; }, { readonly startTime: "2023-05-01T00:00:00Z"; readonly endTime: "2023-05-02T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 342; }, { readonly startTime: "2023-05-02T00:00:00Z"; readonly endTime: "2023-05-03T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 450; }, { readonly startTime: "2023-05-03T00:00:00Z"; readonly endTime: "2023-05-04T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 1250; }, { readonly startTime: "2023-04-27T00:00:00Z"; readonly endTime: "2023-04-28T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 12352; }, { readonly startTime: "2023-04-28T00:00:00Z"; readonly endTime: "2023-04-29T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 12321; }, { readonly startTime: "2023-04-29T00:00:00Z"; readonly endTime: "2023-04-30T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 10021; }, { readonly startTime: "2023-04-30T00:00:00Z"; readonly endTime: "2023-05-01T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 1432; }, { readonly startTime: "2023-05-01T00:00:00Z"; readonly endTime: "2023-05-02T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 342; }, { readonly startTime: "2023-05-02T00:00:00Z"; readonly endTime: "2023-05-03T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 450; }, { readonly startTime: "2023-05-03T00:00:00Z"; readonly endTime: "2023-05-04T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 1250; }]; }, { readonly reportSpecification: { readonly reportType: "MARKETPLACE_ASIN_PAGE_VIEW_METRICS"; readonly reportOptions: { readonly productType: "AUTO_BATTERY"; }; readonly marketplaceIds: readonly ["A1PA6795UKMFR9", "APJ6JRA9NG5V4"]; }; readonly marketplaceAsinPageViewMetrics: readonly [{ readonly startTime: "2023-05-03T00:00:00Z"; readonly endTime: "2023-05-04T00:00:00Z"; readonly marketplaceId: "A1PA6795UKMFR9"; readonly asin: "B00EZ1IGCO"; readonly pageViews: 1250; }, { readonly startTime: "2023-05-03T00:00:00Z"; readonly endTime: "2023-05-04T00:00:00Z"; readonly marketplaceId: "APJ6JRA9NG5V4"; readonly asin: "A0DEZ1IKDB"; readonly pageViews: 1250; }]; }]; readonly required: readonly ["reportSpecification", "marketplaceAsinPageViewMetrics"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the report request."; readonly required: readonly ["reportType", "reportOptions", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; }; readonly reportOptions: { readonly type: "object"; readonly description: "Specifies the product type."; readonly required: readonly ["productType"]; readonly properties: { readonly productType: { readonly type: "string"; readonly description: "The Amazon product type of the ASINs for which the report is being requested. All ASINs with the productType will be included. The value for the product type can be found by following instructions on Seller Central's Help page. - https://developer-docs.amazon.com/sp-api/docs/seller-central-urls"; readonly examples: readonly ["AUTO_BATTERY", "LUGGAGE", "SHOES"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. If the start date of the report is more than seven days ago, the report will be cancelled. If the start date of the report is not provided, it will default to the start date of the most recently available daily data."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. If the end date of the report is not within the seven days from start date, the report will be cancelled. If the end date of the report is not provided, it will default to the end date of the most recently available daily date."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Any of the EU(8) or UK marketplaces. DE, FR, IT, ES, NL, PL, SE, BE and UK"; readonly items: { readonly type: "string"; readonly description: "Any EU(8) or UK Marketplace ID. DE, FR, IT, ES, NL, PL, SE, BE and UK. The ID for the marketplace can be found on the SP-API documentation. - https://developer-docs.amazon.com/sp-api/docs/marketplace-ids"; }; }; }; }; readonly marketplaceAsinPageViewMetrics: { readonly type: "array"; readonly description: "A list of ASIN page view metrics."; readonly items: { readonly $ref: "#/definitions/MarketplaceAsinPageViewMetrics"; }; }; }; readonly definitions: { readonly MarketplaceAsinPageViewMetrics: { readonly type: "object"; readonly description: "Contains aggregate ASIN page view metrics."; readonly required: readonly ["startTime", "endTime", "marketplaceId", "asin", "pageViews"]; readonly properties: { readonly startTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Start time of the aggregation window in UTC."; readonly examples: readonly ["2023-01-16T00:00:00Z"]; }; readonly endTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "End time of the aggregation window in UTC."; readonly examples: readonly ["2023-01-23T00:00:00Z"]; }; readonly marketplaceId: { readonly type: "string"; readonly description: "Marketplace for which the page view metrics are provided."; readonly examples: readonly ["A1PA6795UKMFR9"]; }; readonly asin: { readonly type: "string"; readonly description: "ASIN for which the page view metrics are provided."; readonly examples: readonly ["B00EZ1IGCO"]; }; readonly pageViews: { readonly type: "integer"; readonly description: "Total page views (count)."; readonly minimum: 0; readonly examples: readonly ["12352"]; }; }; }; }; }; type MarketplaceAsinPageViewMetrics = FromSchema; //#endregion //#region src/reports/promotion-report.d.ts declare const promotionReport: { readonly type: "object"; readonly description: "The Promotion Performance report contains data to help vendors optimize their promotions and adjust their advertising strategies. Currently three promotion types are supported: Best Deal, Lightning Deal, and Price Discount. This report supports start dates up to two years before the current date."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_PROMOTION_PERFORMANCE_REPORT"; readonly reportOptions: { readonly promotionStartDateFrom: "2020-11-23T15:33:26Z"; readonly promotionStartDateTo: "2020-12-06T15:33:26Z"; }; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly promotions: readonly [{ readonly promotionId: "16913551269"; readonly promotionName: "Save on BrandX Product Name"; readonly vendorCode: "ABCDE"; readonly merchantId: "A21MAFL4G6JTR3"; readonly unitsSold: 121; readonly amountSpent: 9338.2; readonly amountSpentCurrencyCode: "USD"; readonly revenue: 32917.01; readonly revenueCurrencyCode: "USD"; readonly startDateTime: "2020-11-23T12:34:56Z"; readonly endDateTime: "2020-11-23T12:34:56Z"; readonly type: "BEST_DEAL"; readonly status: "APPROVED"; readonly creationChannel: "SELF-SERVICE"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly fundingAgreementId: "58985408"; readonly glanceViews: 41084; readonly createdDateTime: "2020-09-18T13:24:39Z"; readonly lastUpdatedDateTime: "2020-09-18T13:24:39Z"; readonly includedProducts: readonly [{ readonly asin: "B08755Z2ND"; readonly productName: "BrandX Product, Travel Size, 3 Pack"; readonly productGlanceViews: 380; readonly productUnitsSold: 20; readonly productAmountSpent: 4425.22; readonly productAmountSpentCurrencyCode: "USD"; readonly productRevenue: 16371.85; readonly productRevenueCurrencyCode: "USD"; }]; }]; }]; readonly required: readonly ["reportSpecification", "promotions"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_PROMOTION_PERFORMANCE_REPORT"; readonly reportOptions: { readonly promotionStartDateFrom: "2020-11-23T15:33:26Z"; readonly promotionStartDateTo: "2020-12-06T15:33:26Z"; }; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly examples: readonly ["GET_PROMOTION_PERFORMANCE_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying the parameters promotionStartDateFrom and promotionStartDateTo."; readonly required: readonly ["promotionStartDateFrom", "promotionStartDateTo"]; readonly properties: { readonly promotionStartDateFrom: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date and time range in ISO 8601 format used for selecting promotions to report on. All promotions with a start date-time that falls within the range will be included."; readonly examples: readonly ["2020-11-23T15:33:26Z"]; }; readonly promotionStartDateTo: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date and time range in ISO 8601 format used for selecting promotions to report on. All promotions with a start date-time that falls within the range will be included."; readonly examples: readonly ["2020-12-06T15:33:26Z"]; }; }; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "The marketplace IDs specified in the report request."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; readonly description: "The marketplace ID."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; }; }; }; readonly promotions: { readonly type: "array"; readonly description: "The list of included promotions."; readonly items: { readonly $ref: "#/definitions/DetailsByPromotion"; }; }; }; readonly definitions: { readonly DetailsByPromotion: { readonly type: "object"; readonly description: "An object that contains details about a promotion and every included product."; readonly examples: readonly [{ readonly promotionId: "16913551269"; readonly promotionName: "Save on BrandX Product Name"; readonly vendorCode: "ABCDE"; readonly merchantId: "A21MAFL4G6JTR3"; readonly unitsSold: 121; readonly amountSpent: 9338.2; readonly amountSpentCurrencyCode: "USD"; readonly revenue: 32917.01; readonly revenueCurrencyCode: "USD"; readonly startDateTime: "2020-11-23T12:34:56Z"; readonly endDateTime: "2020-11-23T12:34:56Z"; readonly type: "BEST_DEAL"; readonly status: "APPROVED"; readonly creationChannel: "SELF-SERVICE"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly fundingAgreementId: "58985408"; readonly glanceViews: 41084; readonly createdDateTime: "2020-09-18T13:24:39Z"; readonly lastUpdatedDateTime: "2020-09-18T13:24:39Z"; readonly includedProducts: readonly [{ readonly asin: "B08755Z2ND"; readonly productName: "Save on BrandX Product Name"; readonly productGlanceViews: 380; readonly productUnitsSold: 20; readonly productAmountSpent: 4425.22; readonly productAmountSpentCurrencyCode: "USD"; readonly productRevenue: 16371.85; readonly productRevenueCurrencyCode: "USD"; }]; }]; readonly required: readonly ["promotionId", "promotionName", "unitsSold", "revenue", "revenueCurrencyCode", "startDateTime", "endDateTime", "type", "status", "creationChannel", "marketplaceId", "createdDateTime", "lastUpdatedDateTime", "includedProducts"]; readonly properties: { readonly promotionId: { readonly type: "string"; readonly description: "The unique identifier of the promotion."; readonly examples: readonly ["16913551269"]; }; readonly promotionName: { readonly type: "string"; readonly description: "The customer facing name of the promotion."; readonly examples: readonly ["Save on BrandX Product Name"]; }; readonly vendorCode: { readonly type: "string"; readonly description: "The vendor code associated with the promotion funding agreement. For vendors only."; readonly examples: readonly ["ABCDE"]; }; readonly merchantId: { readonly type: "string"; readonly description: "The merchant customer ID associated with the promotion funding agreement. For sellers only."; readonly examples: readonly ["A21MAFL4G6JTR3"]; }; readonly unitsSold: { readonly type: "integer"; readonly description: "The number of units sold across all ASINs in the promotion."; readonly minimum: 0; readonly examples: readonly [121]; }; readonly amountSpent: { readonly type: "number"; readonly description: "Total funding provided across all ASINs in the promotion. For vendors only."; readonly minimum: 0; readonly examples: readonly [9338.2]; }; readonly amountSpentCurrencyCode: { readonly type: "string"; readonly description: "The ISO 4217 currency code of amountSpent."; readonly examples: readonly ["USD"]; }; readonly revenue: { readonly type: "number"; readonly description: "The total revenue generated across all ASINs in the promotion. For sellers, this is equivalent to \"sales\" in the Seller Central UI."; readonly minimum: 0; readonly examples: readonly [32917.01]; }; readonly revenueCurrencyCode: { readonly type: "string"; readonly description: "The ISO 4217 currency code of revenue."; readonly examples: readonly ["USD"]; }; readonly startDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Promotion start date-time in ISO 8601 format in UTC."; readonly examples: readonly ["2020-11-23T12:34:56Z"]; }; readonly endDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Promotion end date-time in ISO 8601 format in UTC."; readonly examples: readonly ["2020-11-23T12:34:56Z"]; }; readonly type: { readonly type: "string"; readonly description: "The type of the promotion."; readonly enum: readonly ["BEST_DEAL", "DEAL_OF_THE_DAY", "LIGHTNING_DEAL", "PRICE_DISCOUNT", "SALES_DISCOUNT", "COUPON", "PROMO_CODE"]; }; readonly status: { readonly type: "string"; readonly description: "The state that the promotion is in."; readonly enum: readonly ["APPROVED", "PENDING_APPROVAL", "NEEDS_YOUR_ATTENTION", "CANCELED"]; }; readonly creationChannel: { readonly type: "string"; readonly description: "The mode of creation for the promotion."; readonly enum: readonly ["SELF-SERVICE", "FULL-SERVICE", "AUTOMATED", "MANUAL"]; readonly 'x-docgen-enum-table-extension': readonly [{ readonly value: "SELF-SERVICE"; readonly description: "Created by the vendor/seller directly in Vendor/Seller Central."; }, { readonly value: "FULL-SERVICE"; readonly description: "Created on behalf of the vendor/seller by account managers."; }, { readonly value: "AUTOMATED"; readonly description: "Created automatically by a system in response to a trigger. For example, Deal-O-Matic."; }, { readonly value: "MANUAL"; readonly description: "Only used for digital point-of-sale discounts created in Vendisto."; }]; }; readonly marketplaceId: { readonly type: "string"; readonly description: "The marketplace the promotion is running in."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly fundingAgreementId: { readonly type: "string"; readonly description: "The ID for the funding agreement. For vendors only."; readonly examples: readonly ["58985408"]; }; readonly glanceViews: { readonly type: "integer"; readonly description: "The total customer views for all product detail pages."; readonly minimum: 0; readonly examples: readonly [41084]; }; readonly createdDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The promotion creation date-time in ISO 8601 format in UTC."; readonly examples: readonly ["2020-09-18T13:24:39Z"]; }; readonly lastUpdatedDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The promotion last updated date-time in ISO 8601 format in UTC."; readonly examples: readonly ["2020-09-18T13:24:39Z"]; }; readonly includedProducts: { readonly type: "array"; readonly description: "List of included products and their details."; readonly items: { readonly $ref: "#/definitions/DetailsByProduct"; }; }; }; }; readonly DetailsByProduct: { readonly type: "object"; readonly description: "An object that contains details about a product."; readonly examples: readonly [{ readonly asin: "B08755Z2ND"; readonly productName: "BrandX Product, Travel Size, 3 Pack"; readonly productGlanceViews: 380; readonly productUnitsSold: 20; readonly productAmountSpent: 4425.22; readonly productAmountSpentCurrencyCode: "USD"; readonly productRevenue: 16371.85; readonly productRevenueCurrencyCode: "USD"; }]; readonly required: readonly ["asin", "productName", "productUnitsSold", "productRevenue", "productRevenueCurrencyCode"]; readonly properties: { readonly asin: { readonly type: "string"; readonly description: "The product ASIN."; readonly examples: readonly ["B08755Z2ND"]; }; readonly productName: { readonly type: "string"; readonly description: "The product name."; readonly examples: readonly ["BrandX Product, Travel Size, 3 Pack"]; }; readonly productGlanceViews: { readonly type: "integer"; readonly description: "The number of customer views of the product detail page."; readonly minimum: 0; readonly examples: readonly [380]; }; readonly productUnitsSold: { readonly type: "integer"; readonly description: "The number of units sold at the promotional price."; readonly minimum: 0; readonly examples: readonly [20]; }; readonly productAmountSpent: { readonly type: "number"; readonly description: "Total funding provided by the vendor at the ASIN level. For vendors only."; readonly minimum: 0; readonly examples: readonly [4425.22]; }; readonly productAmountSpentCurrencyCode: { readonly type: "string"; readonly description: "ISO 4217 currency code of productAmountSpent."; readonly examples: readonly ["USD"]; }; readonly productRevenue: { readonly type: "number"; readonly description: "The total revenue generated at the ASIN level. For sellers, this is equivalent to \"sales\" in the Seller Central UI."; readonly minimum: 0; readonly examples: readonly [16371.85]; }; readonly productRevenueCurrencyCode: { readonly type: "string"; readonly description: "ISO 4217 currency code of productRevenue."; readonly examples: readonly ["USD"]; }; }; }; }; }; type PromotionReport = FromSchema; //#endregion //#region src/reports/seller-coupon-report.d.ts declare const sellerCouponReport: { readonly type: "object"; readonly description: "This report contains data to help sellers optimize their coupons and adjust their advertising strategies. This report supports start dates up to two years before the current date."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_COUPON_PERFORMANCE_REPORT"; readonly reportOptions: { readonly couponStartDateFrom: "2021-11-01T15:33:26Z"; readonly couponStartDateTo: "2021-11-30T15:33:26Z"; }; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly coupons: readonly [{ readonly couponId: "A2NW32V27GZS2T"; readonly merchantId: "A21MAFL4G6JTR3"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly name: "Product $40 Off"; readonly websiteMessage: "Save on BrandX Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly customerSegment: "All (Default)"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; readonly clips: 13; readonly redemptions: 1; readonly budget: 10000; readonly totalDiscount: 40; readonly budgetSpent: 42.29; readonly budgetRemaining: 9957.71; readonly budgetPercentageUsed: 0.4; readonly sales: 62.1; readonly asins: readonly [{ readonly asin: "B08XJWMYR5"; }, { readonly asin: "B07Z7XTQKZ"; }]; }]; }]; readonly required: readonly ["reportSpecification", "coupons"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_COUPON_PERFORMANCE_REPORT"; readonly reportOptions: { readonly couponStartDateFrom: "2021-11-01T15:33:26Z"; readonly couponStartDateTo: "2021-11-30T15:33:26Z"; }; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly examples: readonly ["GET_COUPON_PERFORMANCE_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters couponStartDateFrom and couponStartDateTo."; readonly required: readonly ["couponStartDateFrom", "couponStartDateTo"]; readonly properties: { readonly couponStartDateFrom: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC used for selecting coupons to report on. All coupons with a start date-time that falls within the range will be included."; readonly examples: readonly ["2021-11-01T15:33:26Z"]; }; readonly couponStartDateTo: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC used for selecting coupons to report on. All coupons with a start date-time that falls within the range will be included."; readonly examples: readonly ["2021-11-30T15:33:26Z"]; }; }; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Marketplace IDs as specified in the report request."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; readonly description: "The marketplace ID."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; }; }; }; readonly coupons: { readonly type: "array"; readonly description: "A list of included coupons."; readonly items: { readonly $ref: "#/definitions/CouponDetails"; }; }; }; readonly definitions: { readonly CouponDetails: { readonly type: "object"; readonly description: "Contains details about a coupon."; readonly examples: readonly [{ readonly couponId: "A2NW32V27GZS2T"; readonly merchantId: "A21MAFL4G6JTR3"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly currencyCode: "USD"; readonly name: "Product $40 Off"; readonly websiteMessage: "Save on BrandX Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly customerSegment: "All (Default)"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; readonly clips: 13; readonly redemptions: 1; readonly budget: 10000; readonly totalDiscount: 40; readonly budgetSpent: 42.29; readonly budgetRemaining: 9957.71; readonly budgetPercentageUsed: 0.4; readonly sales: 62.1; readonly asins: readonly [{ readonly asin: "B08XJWMYR5"; }, { readonly asin: "B07Z7XTQKZ"; }]; }]; readonly required: readonly ["couponId", "merchantId", "marketplaceId", "currencyCode", "startDateTime", "endDateTime", "customerSegment", "clips", "redemptions", "totalDiscount", "budgetSpent", "budgetPercentageUsed", "asins"]; readonly properties: { readonly couponId: { readonly type: "string"; readonly description: "Unique identifier of the coupon."; readonly examples: readonly ["A2NW32V27GZS2T"]; }; readonly merchantId: { readonly type: "string"; readonly description: "Merchant customer ID associated with the coupon."; readonly examples: readonly ["A21MAFL4G6JTR3"]; }; readonly marketplaceId: { readonly type: "string"; readonly description: "Marketplace the coupon is running in."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly currencyCode: { readonly type: "string"; readonly description: "The ISO 4217 currency code of all currency values in the coupon."; readonly examples: readonly ["USD"]; }; readonly name: { readonly type: "string"; readonly description: "The name given to the coupon."; readonly examples: readonly ["Product $40 Off"]; }; readonly websiteMessage: { readonly type: "string"; readonly description: "The message displayed with the coupon on the product page."; readonly examples: readonly ["Save on BrandX Product"]; }; readonly startDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Coupon start date-time in UTC."; readonly examples: readonly ["2021-11-26T05:59:59Z"]; }; readonly endDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Coupon end date-time in UTC."; readonly examples: readonly ["2021-11-29T23:59:59Z"]; }; readonly customerSegment: { readonly type: "string"; readonly description: "Customer segment that the coupon is available to."; readonly examples: readonly ["All (Default)", "Amazon Prime", "Amazon Student"]; }; readonly discountType: { readonly type: "string"; readonly description: "Whether the discount is given as a fixed amount or a percentage off the list price."; readonly enum: readonly ["PERCENT_OFF_LIST_PRICE", "AMOUNT_OFF_LIST_PRICE"]; }; readonly discountAmount: { readonly type: "number"; readonly description: "Discount amount the customer receives. Reflects a percentage when discountType is PERCENT_OFF_LIST_PRICE and a currency value when discountType is AMOUNT_OFF_LIST_PRICE."; readonly minimum: 0; readonly examples: readonly [10]; }; readonly clips: { readonly type: "integer"; readonly description: "Number of times the coupon has been applied on the product page by unique customers."; readonly minimum: 0; readonly examples: readonly [13]; }; readonly redemptions: { readonly type: "integer"; readonly description: "Number of times the coupon has been used for a purchase. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [1]; }; readonly budget: { readonly type: "number"; readonly description: "The budget allocated to the coupon to cover discount offering and clip/redemption fees. Currency value."; readonly minimum: 0; readonly examples: readonly [10000]; }; readonly totalDiscount: { readonly type: "number"; readonly description: "Total amount saved by customers redeeming the coupon. Currency value. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [40]; }; readonly budgetSpent: { readonly type: "number"; readonly description: "Total amount spent by the seller on the coupon, including clip fees and redemption fees. Currency value. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [42.29]; }; readonly budgetRemaining: { readonly type: "number"; readonly description: "The budget remaining for the coupon, equal to budget minus budgetSpent. Currency value. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [9957.71]; }; readonly budgetPercentageUsed: { readonly type: "number"; readonly description: "Percentage of the allocated budget that has been spent, equal to the budgetSpent divided by budget."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [0.4]; }; readonly sales: { readonly type: "number"; readonly description: "Total revenue generated by redemptions of the coupon after the discount. Currency value. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [62.1]; }; readonly asins: { readonly type: "array"; readonly description: "Products associated with the coupon."; readonly items: { readonly $ref: "#/definitions/AsinDetails"; }; }; }; }; readonly AsinDetails: { readonly type: "object"; readonly description: "Contains details about an asin."; readonly examples: readonly [{ readonly asin: "B08XJWMYR5"; }, { readonly asin: "B07Z7XTQKZ"; }]; readonly required: readonly ["asin"]; readonly properties: { readonly asin: { readonly type: "string"; readonly description: "The asin of the product."; readonly examples: readonly ["B08XJWMYR5"]; }; }; }; }; }; type SellerCouponReport = FromSchema; //#endregion //#region src/reports/seller-sales-and-traffic-report.d.ts declare const sellerSalesAndTrafficReport: { readonly type: "object"; readonly description: "This report shares data on the sales performance and page traffic of the seller's items aggregated by date (across the seller's entire catalog of items) and aggregated by ASIN. Aggregated data is available at different date range aggregation levels: DAY, WEEK, MONTH. Per-ASIN data is available at different ASIN aggregation levels: PARENT, CHILD, SKU. Requests can span multiple date range periods."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_SALES_AND_TRAFFIC_REPORT"; readonly reportOptions: { readonly dateGranularity: "DAY"; readonly asinGranularity: "SKU"; }; readonly dataStartTime: "2021-06-11"; readonly dataEndTime: "2021-06-14"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly salesAndTrafficByDate: readonly [{ readonly date: "2021-06-11"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 238.44; readonly currencyCode: "USD"; }; readonly unitsOrdered: 23; readonly totalOrderItems: 20; readonly averageSalesPerOrderItem: { readonly amount: 11.92; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.15; readonly averageSellingPrice: { readonly amount: 10.37; readonly currencyCode: "USD"; }; readonly unitsRefunded: 1; readonly refundRate: 4.35; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 650.72; readonly currencyCode: "USD"; }; readonly unitsShipped: 59; readonly ordersShipped: 54; }; readonly trafficByDate: { readonly browserPageViews: 1158; readonly mobileAppPageViews: 500; readonly pageViews: 1658; readonly browserSessions: 906; readonly mobileAppSessions: 94; readonly sessions: 1000; readonly buyBoxPercentage: 10.54; readonly orderItemSessionPercentage: 2.21; readonly unitSessionPercentage: 2.54; readonly averageOfferCount: 9686; readonly averageParentItems: 9630; readonly feedbackReceived: 10; readonly negativeFeedbackReceived: 1; readonly receivedNegativeFeedbackRate: 10; }; }, { readonly date: "2021-06-12"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 217.7; readonly currencyCode: "USD"; }; readonly unitsOrdered: 18; readonly totalOrderItems: 18; readonly averageSalesPerOrderItem: { readonly amount: 12.09; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1; readonly averageSellingPrice: { readonly amount: 12.09; readonly currencyCode: "USD"; }; readonly unitsRefunded: 0; readonly refundRate: 0; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly unitsShipped: 0; readonly ordersShipped: 0; }; readonly trafficByDate: { readonly browserPageViews: 1209; readonly mobileAppPageViews: 191; readonly pageViews: 1400; readonly browserSessions: 937; readonly mobileAppSessions: 163; readonly sessions: 1100; readonly buyBoxPercentage: 10.92; readonly orderItemSessionPercentage: 1.92; readonly unitSessionPercentage: 1.92; readonly averageOfferCount: 9702; readonly averageParentItems: 9646; readonly feedbackReceived: 0; readonly negativeFeedbackReceived: 0; readonly receivedNegativeFeedbackRate: 0; }; }, { readonly date: "2021-06-13"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 277.06; readonly currencyCode: "USD"; }; readonly unitsOrdered: 25; readonly totalOrderItems: 23; readonly averageSalesPerOrderItem: { readonly amount: 12.05; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.09; readonly averageSellingPrice: { readonly amount: 11.08; readonly currencyCode: "USD"; }; readonly unitsRefunded: 0; readonly refundRate: 0; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 519.96; readonly currencyCode: "USD"; }; readonly unitsShipped: 46; readonly ordersShipped: 43; }; readonly trafficByDate: { readonly browserPageViews: 1231; readonly mobileAppPageViews: 69; readonly pageViews: 1300; readonly browserSessions: 988; readonly mobileAppSessions: 112; readonly sessions: 1100; readonly buyBoxPercentage: 11.62; readonly orderItemSessionPercentage: 2.33; readonly unitSessionPercentage: 2.53; readonly averageOfferCount: 9701; readonly averageParentItems: 9645; readonly feedbackReceived: 0; readonly negativeFeedbackReceived: 0; readonly receivedNegativeFeedbackRate: 0; }; }, { readonly date: "2021-06-14"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 349.94; readonly currencyCode: "USD"; }; readonly unitsOrdered: 31; readonly totalOrderItems: 30; readonly averageSalesPerOrderItem: { readonly amount: 11.66; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.03; readonly averageSellingPrice: { readonly amount: 11.29; readonly currencyCode: "USD"; }; readonly unitsRefunded: 0; readonly refundRate: 0; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly unitsShipped: 0; readonly ordersShipped: 0; }; readonly trafficByDate: { readonly browerPageViews: 1463; readonly mobileAppPageViews: 537; readonly pageViews: 2000; readonly browserSessions: 1141; readonly mobileAppSessions: 112; readonly sessions: 1253; readonly buyBoxPercentage: 13.4; readonly orderItemSessionPercentage: 2.63; readonly unitSessionPercentage: 2.72; readonly averageOfferCount: 9701; readonly averageParentItems: 9645; readonly feedbackReceived: 0; readonly negativeFeedbackReceived: 0; readonly receivedNegativeFeedbackRate: 0; }; }]; readonly salesAndTrafficByAsin: readonly [{ readonly parentAsin: "B123456789"; readonly childAsin: "B123456789"; readonly sku: "AB-1C2D-EFGH"; readonly salesByAsin: { readonly unitsOrdered: 1; readonly orderedProductSales: { readonly amount: 16.79; readonly currencyCode: "USD"; }; readonly totalOrderItems: 1; }; readonly trafficByAsin: { readonly browserSessions: 13; readonly mobileAppSessions: 5; readonly sessions: 18; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 21; readonly mobileAppPageViews: 22; readonly pageViews: 43; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 95.24; readonly unitSessionPercentage: 7.69; }; }, { readonly parentAsin: "B234567890"; readonly childAsin: "B234567890"; readonly sku: "CD-2E3F-GHIJ"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly orderedProductSales: { readonly amount: 26.25; readonly currencyCode: "USD"; }; readonly totalOrderItems: 2; }; readonly trafficByAsin: { readonly browserSessions: 8; readonly mobileAppSessions: 5; readonly sessions: 13; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.1; readonly sessionPercentage: 0.2; readonly browserPageViews: 21; readonly mobileAppPageViews: 12; readonly pageViews: 33; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.25; readonly pageViewsPercentage: 0.32; readonly buyBoxPercentage: 0; readonly unitSessionPercentage: 37.5; }; }, { readonly parentAsin: "B345678901"; readonly childAsin: "B345678901"; readonly sku: "EF-3G4H-IJKL"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly orderedProductSales: { readonly amount: 45; readonly currencyCode: "USD"; }; readonly totalOrderItems: 3; }; readonly trafficByAsin: { readonly browserSessions: 1; readonly mobileAppSessions: 5; readonly sessions: 6; readonly browserSessionPercentage: 0.13; readonly mobileAppSessionPercentage: 0.12; readonly sessionPercentage: 0.12; readonly browserPageViews: 41; readonly mobileAppPageViews: 22; readonly pageViews: 63; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 100; readonly unitSessionPercentage: 300; }; }]; }, { readonly reportSpecification: { readonly reportType: "GET_SALES_AND_TRAFFIC_REPORT"; readonly reportOptions: { readonly dateGranularity: "WEEK"; readonly asinGranularity: "CHILD"; }; readonly dataStartTime: "2021-06-11"; readonly dataEndTime: "2021-06-14"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly salesAndTrafficByDate: readonly [{ readonly date: "2021-06-06"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 456.14; readonly currencyCode: "USD"; }; readonly unitsOrdered: 41; readonly totalOrderItems: 38; readonly averageSalesPerOrderItem: { readonly amount: 12; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.08; readonly averageSellingPrice: { readonly amount: 11.13; readonly currencyCode: "USD"; }; readonly unitsRefunded: 1; readonly refundRate: 2.44; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 650.72; readonly currencyCode: "USD"; }; readonly unitsShipped: 59; readonly ordersShipped: 54; }; readonly trafficByDate: { readonly browserPageViews: 2367; readonly mobileAppPageViews: 1333; readonly pageViews: 3700; readonly browserSessions: 2009; readonly mobileAppSessions: 220; readonly sessions: 2229; readonly buyBoxPercentage: 10.73; readonly orderItemSessionPercentage: 2.06; readonly unitSessionPercentage: 2.22; readonly averageOfferCount: 9694; readonly averageParentItems: 9638; readonly feedbackReceived: 10; readonly negativeFeedbackReceived: 1; readonly receivedNegativeFeedbackRate: 10; }; }, { readonly date: "2021-06-13"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 627; readonly currencyCode: "USD"; }; readonly unitsOrdered: 56; readonly totalOrderItems: 53; readonly averageSalesPerOrderItem: { readonly amount: 11.83; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.06; readonly averageSellingPrice: { readonly amount: 11.2; readonly currencyCode: "USD"; }; readonly unitsRefunded: 0; readonly refundRate: 0; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 519.96; readonly currencyCode: "USD"; }; readonly unitsShipped: 46; readonly ordersShipped: 43; }; readonly trafficByDate: { readonly browserPageViews: 2694; readonly mobileAppPageViews: 1300; readonly pageViews: 3994; readonly browserSessions: 2129; readonly mobileAppSessions: 220; readonly sessions: 2349; readonly buyBoxPercentage: 12.58; readonly orderItemSessionPercentage: 2.49; readonly unitSessionPercentage: 2.63; readonly averageOfferCount: 9701; readonly averageParentItems: 9645; readonly feedbackReceived: 0; readonly negativeFeedbackReceived: 0; readonly receivedNegativeFeedbackRate: 0; }; }]; readonly salesAndTrafficByAsin: readonly [{ readonly parentAsin: "B123456789"; readonly childAsin: "B123456789"; readonly salesByAsin: { readonly unitsOrdered: 1; readonly orderedProductSales: { readonly amount: 16.79; readonly currencyCode: "USD"; }; readonly totalOrderItems: 1; }; readonly trafficByAsin: { readonly browserSessions: 13; readonly mobileAppSessions: 5; readonly sessions: 18; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 21; readonly mobileAppPageViews: 22; readonly pageViews: 43; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 95.24; readonly unitSessionPercentage: 7.69; }; }, { readonly parentAsin: "B234567890"; readonly childAsin: "B234567890"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly orderedProductSales: { readonly amount: 26.25; readonly currencyCode: "USD"; }; readonly totalOrderItems: 2; }; readonly trafficByAsin: { readonly browserSessions: 13; readonly mobileAppSessions: 15; readonly sessions: 28; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 21; readonly mobileAppPageViews: 42; readonly pageViews: 63; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 0; readonly unitSessionPercentage: 37.5; }; }, { readonly parentAsin: "B345678901"; readonly childAsin: "B345678901"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly orderedProductSales: { readonly amount: 45; readonly currencyCode: "USD"; }; readonly totalOrderItems: 3; }; readonly trafficByAsin: { readonly browserSessions: 43; readonly mobileAppSessions: 5; readonly sessions: 48; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 41; readonly mobileAppPageViews: 22; readonly pageViews: 63; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 100; readonly unitSessionPercentage: 300; }; }]; }, { readonly reportSpecification: { readonly reportType: "GET_SALES_AND_TRAFFIC_REPORT"; readonly reportOptions: { readonly dateGranularity: "MONTH"; readonly asinGranularity: "PARENT"; }; readonly dataStartTime: "2021-06-11"; readonly dataEndTime: "2021-06-14"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly salesAndTrafficByDate: readonly [{ readonly date: "2021-06-01"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 6874.79; readonly currencyCode: "USD"; }; readonly unitsOrdered: 590; readonly totalOrderItems: 561; readonly averageSalesPerOrderItem: { readonly amount: 12.25; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.05; readonly averageSellingPrice: { readonly amount: 11.65; readonly currencyCode: "USD"; }; readonly unitsRefunded: 1; readonly refundRate: 0.17; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 1170.68; readonly currencyCode: "USD"; }; readonly unitsShipped: 105; readonly ordersShipped: 97; }; readonly trafficByDate: { readonly browserPageViews: 5061; readonly mobileAppPageViews: 1000; readonly pageViews: 6061; readonly browserSessions: 3972; readonly mobileAppSessions: 1028; readonly sessions: 4100; readonly buyBoxPercentage: 11.72; readonly orderItemSessionPercentage: 14.12; readonly unitSessionPercentage: 14.85; readonly averageOfferCount: 9698; readonly averageParentItems: 9642; readonly feedbackReceived: 10; readonly negativeFeedbackReceived: 1; readonly receivedNegativeFeedbackRate: 10; }; }]; readonly salesAndTrafficByAsin: readonly [{ readonly parentAsin: "B123456789"; readonly salesByAsin: { readonly unitsOrdered: 1; readonly orderedProductSales: { readonly amount: 16.79; readonly currencyCode: "USD"; }; readonly totalOrderItems: 1; }; readonly trafficByAsin: { readonly browserSessions: 13; readonly mobileAppSessions: 5; readonly sessions: 18; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 21; readonly mobileAppPageViews: 22; readonly pageViews: 43; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 95.24; readonly unitSessionPercentage: 7.69; }; }, { readonly parentAsin: "B234567890"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly orderedProductSales: { readonly amount: 26.25; readonly currencyCode: "USD"; }; readonly totalOrderItems: 2; }; readonly trafficByAsin: { readonly browserSessions: 13; readonly mobileAppSessions: 95; readonly sessions: 108; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 81; readonly mobileAppPageViews: 22; readonly pageViews: 103; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 0; readonly unitSessionPercentage: 37.5; }; }, { readonly parentAsin: "B345678901"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly orderedProductSales: { readonly amount: 45; readonly currencyCode: "USD"; }; readonly totalOrderItems: 3; }; readonly trafficByAsin: { readonly browserSessions: 3; readonly mobileAppSessions: 5; readonly sessions: 8; readonly browserSessionPercentage: 0.33; readonly mobileAppSessionPercentage: 0.2; readonly sessionPercentage: 0.26; readonly browserPageViews: 1; readonly mobileAppPageViews: 2; readonly pageViews: 3; readonly browserPageViewsPercentage: 0.41; readonly mobileAppPageViewsPercentage: 0.2; readonly pageViewsPercentage: 0.3; readonly buyBoxPercentage: 100; readonly unitSessionPercentage: 300; }; }]; }]; readonly required: readonly ["reportSpecification", "salesAndTrafficByDate", "salesAndTrafficByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Report summary including specified reporting date range, dateGranularity, and asinGranularity in the input."; readonly examples: readonly [{ readonly reportType: "GET_SALES_AND_TRAFFIC_REPORT"; readonly reportOptions: { readonly dateGranularity: "WEEK"; readonly asinGranularity: "PARENT"; }; readonly dataStartTime: "2021-06-11"; readonly dataEndTime: "2021-06-14"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "Type of the report."; readonly enum: readonly ["GET_SALES_AND_TRAFFIC_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as dateGranularity and asinGranularity."; readonly examples: readonly [{ readonly dateGranularity: "DAY"; readonly asinGranularity: "CHILD"; }]; readonly properties: { readonly dateGranularity: { readonly type: "string"; readonly description: "This parameter determines what granularity of the aggregated sales and traffic data is expected in the report. Valid values are: DAY, WEEK, MONTH. If this parameter is omitted, then the salesAndTrafficByDate section of this report will default to DAY granularity."; readonly enum: readonly ["DAY", "WEEK", "MONTH"]; }; readonly asinGranularity: { readonly type: "string"; readonly description: "This parameter determines what granularity of the ASIN sales and traffic data is expected in the report. Valid values are: PARENT, CHILD, SKU. If this parameter is omitted, then the salesAndTrafficByAsin section of this report will default to PARENT granularity."; readonly enum: readonly ["PARENT", "CHILD", "SKU"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "This parameter determines the start date of the report - the time component is ignored. If the start date of the report is more than two years ago, the report will be cancelled. For WEEK and MONTH dateGranularity, if this value does not correspond to the first day in the specified dateGranularity then the report start date will be expanded to include the first day of the reporting period for the dateGranularity specified. The first day of the reporting period for the WEEK dateGranularity is Sunday and the first day of the reporting period for the MONTH dateGranularity is the first day of the month. For example, if the specified dataStartTime is 3 days after the start date of a WEEK dateGranularity, then the start date used to generate the report will be dataStartTime minus 3 days."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "This parameter determines the end date of the report - the time component is ignored. For WEEK and MONTH dateGranularity, if this value does not correspond to the last day in the specified dateGranularity then the report end date will be expanded to include the last day of the reporting period for the dateGranularity specified. The last day of the reporting period for the WEEK dateGranularity is Saturday and the last day of the reporting period for the MONTH dateGranularity is the last day of the month. For example, if the specified dataEndTime is 3 days before the end date of a WEEK dateGranularity, the end date used to generate the report will be dataEndTime plus 3 days."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the seller's account. This report type supports only one marketplaceId per report. Specifying multiple marketplaces will result in failure to generate the report."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly salesAndTrafficByDate: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/SalesAndTrafficByDate"; }; }; readonly salesAndTrafficByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/SalesAndTrafficByAsin"; }; }; }; readonly definitions: { readonly SalesAndTrafficByDate: { readonly type: "object"; readonly description: "Object describing sales and traffic metrics for ASINs in the seller's account aggregated by date."; readonly examples: readonly [{ readonly date: "2021-06-11"; readonly salesByDate: { readonly orderedProductSales: { readonly amount: 636.63; readonly currencyCode: "USD"; }; readonly orderedProductSalesB2B: { readonly amount: 636.63; readonly currencyCode: "USD"; }; readonly unitsOrdered: 54; readonly unitsOrderedB2B: 54; readonly totalOrderItems: 53; readonly totalOrderItemsB2B: 53; readonly averageSalesPerOrderItem: { readonly amount: 12.01; readonly currencyCode: "USD"; }; readonly averageSalesPerOrderItemB2B: { readonly amount: 12.01; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.02; readonly averageUnitsPerOrderItemB2B: 1.02; readonly averageSellingPrice: { readonly amount: 11.79; readonly currencyCode: "USD"; }; readonly averageSellingPriceB2B: { readonly amount: 11.79; readonly currencyCode: "USD"; }; readonly unitsRefunded: 1; readonly refundRate: 1.85; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 542.9; readonly currencyCode: "USD"; }; readonly unitsShipped: 47; readonly ordersShipped: 47; }; readonly trafficByDate: { readonly browserPageViews: 3569; readonly browserPageViewsB2B: 3569; readonly mobileAppPageViews: 1000; readonly mobileAppPageViewsB2B: 1000; readonly pageViews: 4569; readonly pageViewsB2B: 4569; readonly browserSessions: 2858; readonly browserSessionsB2B: 2858; readonly mobileAppSessions: 1000; readonly mobileAppSessionsB2B: 1000; readonly sessions: 3858; readonly sessionsB2B: 3858; readonly buyBoxPercentage: 12.08; readonly buyBoxPercentageB2B: 12.08; readonly orderItemSessionPercentage: 1.85; readonly orderItemSessionPercentageB2B: 1.85; readonly unitSessionPercentage: 1.89; readonly unitSessionPercentageB2B: 1.89; readonly averageOfferCount: 10223; readonly averageParentItems: 10163; readonly feedbackReceived: 10; readonly negativeFeedbackReceived: 1; readonly receivedNegativeFeedbackRate: 10; }; }]; readonly required: readonly ["date", "salesByDate", "trafficByDate"]; readonly properties: { readonly date: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the period of the aggregated data."; readonly examples: readonly ["2021-06-06"]; }; readonly salesByDate: { readonly $ref: "#/definitions/SalesByDate"; readonly description: "Object describing sales metrics for ASINs in the seller's account aggregated by date."; }; readonly trafficByDate: { readonly $ref: "#/definitions/TrafficByDate"; readonly description: "Object describing traffic metrics for ASINs in the seller's account aggregated by date."; }; }; }; readonly SalesByDate: { readonly type: "object"; readonly description: "Object describing sales metrics for ASINs in the seller's account aggregated by date."; readonly examples: readonly [{ readonly orderedProductSales: { readonly amount: 636.63; readonly currencyCode: "USD"; }; readonly orderedProductSalesB2B: { readonly amount: 636.63; readonly currencyCode: "USD"; }; readonly unitsOrdered: 54; readonly unitsOrderedB2B: 54; readonly totalOrderItems: 53; readonly totalOrderItemsB2B: 53; readonly averageSalesPerOrderItem: { readonly amount: 12.01; readonly currencyCode: "USD"; }; readonly averageSalesPerOrderItemB2B: { readonly amount: 12.01; readonly currencyCode: "USD"; }; readonly averageUnitsPerOrderItem: 1.02; readonly averageUnitsPerOrderItemB2B: 1.02; readonly averageSellingPrice: { readonly amount: 11.79; readonly currencyCode: "USD"; }; readonly averageSellingPriceB2B: { readonly amount: 11.79; readonly currencyCode: "USD"; }; readonly unitsRefunded: 1; readonly refundRate: 1.85; readonly claimsGranted: 0; readonly claimsAmount: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedProductSales: { readonly amount: 542.9; readonly currencyCode: "USD"; }; readonly unitsShipped: 47; readonly ordersShipped: 47; }]; readonly required: readonly ["orderedProductSales", "unitsOrdered", "totalOrderItems", "averageSalesPerOrderItem", "averageUnitsPerOrderItem", "averageSellingPrice", "unitsRefunded", "refundRate", "claimsGranted", "claimsAmount", "shippedProductSales", "unitsShipped", "ordersShipped"]; readonly properties: { readonly orderedProductSales: { readonly $ref: "#/definitions/Amount"; readonly description: "The amount of ordered product sales, calculated by multiplying the price of products and the number of units sold for the selected time period."; }; readonly orderedProductSalesB2B: { readonly $ref: "#/definitions/Amount"; readonly description: "The amount of ordered product sales to Amazon Business customers, calculated by multiplying the price of products and the number of units sold for the selected time period. Note: This field is only populated when the seller is a B2B seller."; }; readonly unitsOrdered: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of units ordered for the selected time period. For clarification on the difference between orders, order items, and units take the following order as an example: An order containing 2 copies of book A and 3 copies of book B; The number of orders is 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3)."; readonly examples: readonly [25]; }; readonly unitsOrderedB2B: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of units ordered by Amazon Business customers for the selected time period. For clarification on the difference between orders, order items, and units take the following order as an example: An order containing 2 copies of book A and 3 copies of book B; The number of orders is 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3). Note: This field is only populated when the seller is a B2B seller."; readonly examples: readonly [25]; }; readonly totalOrderItems: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of items that were ordered for the selected time period. For clarification on the difference between orders, order items, and units take the following order as an example: An order containing 2 copies of book A and 3 copies of book B; The number of orders is 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3)."; readonly examples: readonly [25]; }; readonly totalOrderItemsB2B: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of items that were ordered by Amazon Business customers for the selected time period. For clarification on the difference between orders, order items, and units take the following order as an example: An order containing 2 copies of book A and 3 copies of book B; The number of orders is 1, the number of order items is 2 (book A and book B), and the number of units is 5 (2 + 3). Note: This field is only populated when the seller is a B2B seller."; readonly examples: readonly [25]; }; readonly averageSalesPerOrderItem: { readonly $ref: "#/definitions/Amount"; readonly description: "The average ordered product sales, calculated by dividing orderedProductSales by totalOrderItems for the selected time period."; }; readonly averageSalesPerOrderItemB2B: { readonly $ref: "#/definitions/Amount"; readonly description: "The average ordered product sales to Amazon Business customers, calculated by dividing orderedProductSalesB2B by totalOrderItemsB2B for the selected time period. Note: This field is only populated when the seller is a B2B seller."; }; readonly averageUnitsPerOrderItem: { readonly type: "number"; readonly description: "The average number of units in each order item for the selected time period."; readonly minimum: 0; readonly examples: readonly [33.33]; }; readonly averageUnitsPerOrderItemB2B: { readonly type: "number"; readonly description: "The average number of units in each order item ordered by Amazon Business customers for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [33.33]; }; readonly averageSellingPrice: { readonly $ref: "#/definitions/Amount"; readonly description: "The average price of the units sold in the selected time period, calculated by dividing the orderedProductSales by unitsOrdered for the selected time period."; }; readonly averageSellingPriceB2B: { readonly $ref: "#/definitions/Amount"; readonly description: "The average price of the units sold to Amazon Business customers, calculated by dividing the orderedProductSalesB2B by unitsOrderedB2B for the selected time period. Note: This field is only populated when the seller is a B2B seller."; }; readonly unitsRefunded: { readonly type: "integer"; readonly description: "The number of units refunded in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly refundRate: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many orders were refunded by the seller, calculated by dividing unitsOrdered by unitsRefunded in the selected time period."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly claimsGranted: { readonly type: "integer"; readonly description: "The number of A-to-z guarantee claims granted."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly claimsAmount: { readonly $ref: "#/definitions/Amount"; readonly description: "Monetary amount of filed A-to-z guarantee claims."; }; readonly shippedProductSales: { readonly $ref: "#/definitions/Amount"; readonly description: "The amount of ordered product sales shipped for the selected time period."; }; readonly unitsShipped: { readonly type: "integer"; readonly description: "The number of units shipped in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly ordersShipped: { readonly type: "integer"; readonly description: "The number of orders shipped in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; }; }; readonly TrafficByDate: { readonly type: "object"; readonly description: "Object describing traffic metrics for ASINs in the seller's account aggregated by date."; readonly examples: readonly [{ readonly browserPageViews: 3569; readonly browserPageViewsB2B: 3569; readonly mobileAppPageViews: 1000; readonly mobileAppPageViewsB2B: 1000; readonly pageViews: 4569; readonly pageViewsB2B: 4569; readonly browserSessions: 2858; readonly browserSessionsB2B: 2858; readonly mobileAppSessions: 2000; readonly mobileAppSessionsB2B: 2000; readonly sessions: 4858; readonly sessionsB2B: 4858; readonly buyBoxPercentage: 12.08; readonly buyBoxPercentageB2B: 12.08; readonly orderItemSessionPercentage: 1.85; readonly orderItemSessionPercentageB2B: 1.85; readonly unitSessionPercentage: 1.89; readonly unitSessionPercentageB2B: 1.89; readonly averageOfferCount: 10223; readonly averageParentItems: 10163; readonly feedbackReceived: 10; readonly negativeFeedbackReceived: 1; readonly receivedNegativeFeedbackRate: 10; }]; readonly required: readonly ["browserPageViews", "mobileAppPageViews", "pageViews", "browserSessions", "mobileAppSessions", "sessions", "buyBoxPercentage", "orderItemSessionPercentage", "unitSessionPercentage", "averageOfferCount", "averageParentItems", "feedbackReceived", "negativeFeedbackReceived", "receivedNegativeFeedbackRate"]; readonly properties: { readonly browserPageViews: { readonly type: "integer"; readonly description: "Browser page views are the number of times any user visited your Amazon.com browser pages for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserPageViewsB2B: { readonly type: "integer"; readonly description: "Browser B2B page views are the number of times an Amazon Business customer visited your Amazon.com browser pages for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppPageViews: { readonly type: "integer"; readonly description: "Mobile app page views are the number of times any user visited your Amazon.com mobile app pages for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppPageViewsB2B: { readonly type: "integer"; readonly description: "Mobile app B2B page views are the number of times an Amazon Business customer visited your Amazon.com mobile app pages for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly pageViews: { readonly type: "integer"; readonly description: "Page views are the number of times any user visited your Amazon.com pages using browser or mobile app for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly pageViewsB2B: { readonly type: "integer"; readonly description: "B2B page views are the number of times an Amazon Business customer visited your Amazon.com pages using browser or mobile app for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserSessions: { readonly type: "integer"; readonly description: "Browser sessions are visits to your Amazon.com browser pages by any user. All activity within a 24-hour period is considered a browser session. For example, if any user visits your pages using browser multiple times within a 24 hour period it is counted as a single session."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserSessionsB2B: { readonly type: "integer"; readonly description: "Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon Business customer. All activity within a 24-hour period is considered a browser session. For example, if an Amazon Business customer visits your pages using browser multiple times within a 24 hour period it is counted as a single session. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppSessions: { readonly type: "integer"; readonly description: "Mobile app sessions are visits to your Amazon.com mobile app pages by any user. All activity within a 24-hour period is considered a mobile app session. For example, if any user visits your pages using mobile app multiple times within a 24 hour period it is counted as a single session."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppSessionsB2B: { readonly type: "integer"; readonly description: "Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an Amazon Business customer. All activity within a 24-hour period is considered a mobile app session. For example, if an Amazon Business customer visits your pages using mobile app multiple times within a 24 hour period it is counted as a single session. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly sessions: { readonly type: "integer"; readonly description: "Sessions are visits to your Amazon.com pages using browser or mobile app by any user. All activity within a 24-hour period is considered a session. For example, if any user visits your pages multiple times using mobile app or browser within a 24 hour period it is counted as a single session."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly sessionsB2B: { readonly type: "integer"; readonly description: "B2B sessions are visits to your Amazon.com pages using browser or mobile app by an Amazon Business customer. All activity within a 24-hour period is considered a session. For example, if an Amazon Business customer visits your pages multiple times using mobile app or browser within a 24 hour period it is counted as a single session. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly buyBoxPercentage: { readonly type: "number"; readonly description: "The percentage of page views where the buy box (the add to shopping cart link) appeared on the page for customers to add your product to their cart."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly buyBoxPercentageB2B: { readonly type: "number"; readonly description: "The percentage of page views by Amazon Business customers where the buy box (the add to shopping cart link) appeared on the page for customers to add your product to their cart. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly orderItemSessionPercentage: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many order items were generated relative to the number of people who viewed the products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly orderItemSessionPercentageB2B: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many order items were generated by Amazon Business customers relative to the number of Amazon Business customers who viewed the products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly unitSessionPercentage: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many units were purchased relative to the number of people who viewed the products."; readonly minimum: 0; readonly examples: readonly [33.33]; }; readonly unitSessionPercentageB2B: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many units were purchased by Amazon Business customers relative to number of Amazon Business customers who viewed the products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [33.33]; }; readonly averageOfferCount: { readonly type: "integer"; readonly description: "The average number of offers listed for sale in the selected time period. It is calculated from the total number of offers and the total number of days in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly averageParentItems: { readonly type: "integer"; readonly description: "The average number of parent items listed for sale in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly feedbackReceived: { readonly type: "integer"; readonly description: "The number of customer feedback received in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly negativeFeedbackReceived: { readonly type: "integer"; readonly description: "The number of negative customer feedback received in the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly receivedNegativeFeedbackRate: { readonly type: "number"; readonly description: "The negative feedback rate is the number of orders that have received a negative feedback divided by the number of orders in the selected time period."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; }; }; readonly SalesAndTrafficByAsin: { readonly type: "object"; readonly description: "Object describing sales and traffic metrics for ASINs in the seller's account aggregated by ASIN."; readonly examples: readonly [{ readonly parentAsin: "B123456789"; readonly childAsin: "B123456789"; readonly sku: "123456789"; readonly salesByAsin: { readonly unitsOrdered: 3; readonly unitsOrderedB2B: 3; readonly orderedProductSales: { readonly amount: 27.3; readonly currencyCode: "USD"; }; readonly orderedProductSalesB2B: { readonly amount: 27.3; readonly currencyCode: "USD"; }; readonly totalOrderItems: 3; readonly totalOrderItemsB2B: 3; }; readonly trafficByAsin: { readonly browserSessions: 33; readonly browserSessionsB2B: 33; readonly mobileAppSessions: 22; readonly mobileAppSessionsB2B: 22; readonly sessions: 55; readonly sessionsB2B: 55; readonly browserSessionPercentage: 10.96; readonly browserSessionPercentageB2B: 10.96; readonly mobileAppSessionPercentage: 12.04; readonly mobileAppSessionPercentageB2B: 12.04; readonly sessionPercentage: 11.42; readonly sessionPercentageB2B: 11.42; readonly browserPageViews: 50; readonly browserPageViewsB2B: 50; readonly mobilePageViews: 60; readonly mobilePageViewsB2B: 60; readonly pageViews: 110; readonly pageViewsB2B: 110; readonly browserPageViewsPercentage: 13.23; readonly browserPageViewsPercentageB2B: 13.23; readonly mobilePageViewsPercentage: 10.23; readonly mobilePageViewsPercentageB2B: 10.23; readonly pageViewsPercentage: 11.23; readonly pageViewsPercentageB2B: 11.23; readonly buyBoxPercentage: 54; readonly buyBoxPercentageB2B: 54; readonly unitSessionPercentage: 9.09; readonly unitSessionPercentageB2B: 9.09; }; }]; readonly required: readonly ["parentAsin", "salesByAsin", "trafficByAsin"]; readonly properties: { readonly parentAsin: { readonly description: "The Amazon Standard Identification Number of the parent product. A parent product appears in our catalog as a non-buyable, generic identifier for a product that has buyable variations (child products)."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly childAsin: { readonly description: "The Amazon Standard Identification Number of the child product. Child products are unique, sellable products that are related in our catalog to a single, non-sellable parent product. Note: This field is only present when ASIN aggregation is CHILD or SKU."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly sku: { readonly description: "The Stock Keeping Unit of the product. The SKU is a seller specific product identifier. Note: This field is only present when ASIN aggregation is SKU."; readonly type: "string"; readonly examples: readonly ["123456789"]; }; readonly salesByAsin: { readonly $ref: "#/definitions/SalesByAsin"; readonly description: "Sales metrics for ASINs in the seller's account aggregated by ASIN"; }; readonly trafficByAsin: { readonly $ref: "#/definitions/TrafficByAsin"; readonly description: "Traffic metrics for ASINs in the seller's account aggregated by ASIN"; }; }; }; readonly SalesByAsin: { readonly type: "object"; readonly description: "Object describing sales and traffic metrics for ASINs in the seller's account aggregated by ASIN."; readonly examples: readonly [{ readonly unitsOrdered: 3; readonly unitsOrderedB2B: 3; readonly orderedProductSales: { readonly amount: 27.3; readonly currencyCode: "USD"; }; readonly orderedProductSalesB2B: { readonly amount: 27.3; readonly currencyCode: "USD"; }; readonly totalOrderItems: 3; readonly totalOrderItemsB2B: 3; }]; readonly required: readonly ["unitsOrdered", "orderedProductSales", "totalOrderItems"]; readonly properties: { readonly unitsOrdered: { readonly type: "integer"; readonly description: "The number of units ordered."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly unitsOrderedB2B: { readonly type: "integer"; readonly description: "The number of units ordered by Amazon Business customers. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly orderedProductSales: { readonly $ref: "#/definitions/Amount"; readonly description: "The amount of ordered product sales, calculated by multiplying the price of products and the number of units sold for the selected time period."; }; readonly orderedProductSalesB2B: { readonly $ref: "#/definitions/Amount"; readonly description: "The amount of ordered product sales to Amazon Business customers, calculated by multiplying the price of products and the number of units sold for the selected time period. Note: This field is only populated when the seller is a B2B seller."; }; readonly totalOrderItems: { readonly type: "integer"; readonly description: "The number of items that were ordered for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly totalOrderItemsB2B: { readonly type: "integer"; readonly description: "The number of items that were ordered by Amazon Business customers for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; }; }; readonly TrafficByAsin: { readonly type: "object"; readonly description: "Object describing traffic metrics for ASINs in the seller's account aggregated by ASIN."; readonly examples: readonly [{ readonly browserSessions: 33; readonly browserSessionsB2B: 33; readonly mobileAppSessions: 12; readonly mobileAppSessionsB2B: 12; readonly sessions: 45; readonly sessionsB2B: 45; readonly browserSessionPercentage: 10.96; readonly browserSessionPercentageB2B: 10.96; readonly mobileAppSessionPercentage: 5.04; readonly mobileAppSessionPercentageB2B: 5.04; readonly sessionPercentage: 8.04; readonly sessionPercentageB2B: 8.04; readonly browserPageViews: 50; readonly browserPageViewsB2B: 50; readonly mobileAppPageViews: 50; readonly mobileAppPageViewsB2B: 50; readonly pageViews: 100; readonly pageViewsB2B: 100; readonly browserPageViewsPercentage: 13.23; readonly browserPageViewsPercentageB2B: 13.23; readonly mobileAppPageViewsPercentage: 9.23; readonly mobileAppPageViewsPercentageB2B: 9.23; readonly pageViewsPercentage: 10.23; readonly pageViewsPercentageB2B: 10.23; readonly buyBoxPercentage: 54; readonly buyBoxPercentageB2B: 54; readonly unitSessionPercentage: 9.09; readonly unitSessionPercentageB2B: 9.09; }]; readonly required: readonly ["browserSessions", "mobileAppSessions", "sessions", "browserSessionPercentage", "mobileAppSessionPercentage", "sessionPercentage", "browserPageViews", "mobileAppPageViews", "pageViews", "browserPageViewsPercentage", "mobileAppPageViewsPercentage", "pageViewsPercentage", "buyBoxPercentage", "unitSessionPercentage"]; readonly properties: { readonly browserSessions: { readonly type: "integer"; readonly description: "Browser sessions are visits to your Amazon.com browser pages by any user. All activity within a 24-hour period is considered a browser session. For example, if any user visits your pages using browser multiple times within a 24 hour period it is counted as a single session."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserSessionsB2B: { readonly type: "integer"; readonly description: "Browser B2B sessions are visits to your Amazon.com browser pages by an Amazon Business customer. All activity within a 24-hour period is considered a browser session. For example, if an Amazon Business customer visits your pages using browser multiple times within a 24 hour period it is counted as a single session. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppSessions: { readonly type: "integer"; readonly description: "Mobile app sessions are visits to your Amazon.com mobile app pages by any user. All activity within a 24-hour period is considered a mobile app session. For example, if any user visits your pages using mobile app multiple times within a 24 hour period it is counted as a single session."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppSessionsB2B: { readonly type: "integer"; readonly description: "Mobile app B2B sessions are visits to your Amazon.com mobile app pages by an Amazon Business customer. All activity within a 24-hour period is considered a mobile app session. For example, if an Amazon Business customer visits your pages using mobile app multiple times within a 24 hour period it is counted as a single session. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly sessions: { readonly type: "integer"; readonly description: "Sessions are visits to your Amazon.com pages using mobile app or browser by any user. All activity within a 24-hour period is considered a session. For example, if any user visits your pages multiple times within a 24 hour period it is counted as a single session."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly sessionsB2B: { readonly type: "integer"; readonly description: "B2B sessions are visits to your Amazon.com pages by Amazon Business customers using mobile app or browser. All activity within a 24-hour period is considered a session. For example, if an Amazon Business customer visits your pages multiple times within a 24 hour period it is counted as a single session. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserSessionPercentage: { readonly type: "number"; readonly description: "The percentage of browser sessions that contain at least one page view for a particular SKU/ASIN relative to the total number of browser sessions for all products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly browserSessionPercentageB2B: { readonly type: "number"; readonly description: "The percentage of browser sessions that contain at least one page view by an Amazon Business customer for a particular SKU/ASIN relative to the total number of browser sessions by Amazon Business customers for all products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly mobileAppSessionPercentage: { readonly type: "number"; readonly description: "The percentage of mobile app sessions that contain at least one page view for a particular SKU/ASIN relative to the total number of mobile app sessions for all products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly mobileAppSessionPercentageB2B: { readonly type: "number"; readonly description: "The percentage of mobile app sessions that contain at least one page view by an Amazon Business customer for a particular SKU/ASIN relative to the total number of mobile app sessions by Amazon Business customers for all products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly sessionPercentage: { readonly type: "number"; readonly description: "The percentage of sessions that contain at least one page view for a particular SKU/ASIN relative to the total number of sessions for all products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly sessionPercentageB2B: { readonly type: "number"; readonly description: "The percentage of sessions that contain at least one page view by an Amazon Business customer for a particular SKU/ASIN relative to the total number of sessions by Amazon Business customers for all products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly browserPageViews: { readonly type: "integer"; readonly description: "Browser page views are the number of times any user visited your Amazon.com browser pages for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserPageViewsB2B: { readonly type: "integer"; readonly description: "Browser page views are the number of times an Amazon Business customer visited your Amazon.com browser pages for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppPageViews: { readonly type: "integer"; readonly description: "Mobile app page views are the number of times any user visited your Amazon.com mobile app pages for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly mobileAppPageViewsB2B: { readonly type: "integer"; readonly description: "Mobile app B2B page views are the number of times an Amazon Business customer visited your Amazon.com mobile app pages for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly pageViews: { readonly type: "integer"; readonly description: "Page views are the number of times any user visited your Amazon.com pages using browser or mobile app for the selected time period."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly pageViewsB2B: { readonly type: "integer"; readonly description: "B2B page views are the number of times an Amazon Business customer visited your Amazon.com pages using browser or mobile app for the selected time period. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [25]; }; readonly browserPageViewsPercentage: { readonly type: "number"; readonly description: "The percentage of browser views that a particular SKU/ASIN receives relative to the total number of mobile page views for all products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly browserPageViewsPercentageB2B: { readonly type: "number"; readonly description: "The percentage of browser views by Amazon Business customers that a particular SKU/ASIN receives relative to the total number of mobile page views by Amazon Business customers for all products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly mobileAppPageViewsPercentage: { readonly type: "number"; readonly description: "The percentage of mobile page views that a particular SKU/ASIN receives relative to the total number of mobile page views for all products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly mobileAppPageViewsPercentageB2B: { readonly type: "number"; readonly description: "The percentage of mobile page views by Amazon Business customers that a particular SKU/ASIN receives relative to the total number of mobile page views by Amazon Business customers for all products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly pageViewsPercentage: { readonly type: "number"; readonly description: "The percentage of page views that a particular SKU/ASIN receives relative to the total number of page views for all products."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly pageViewsPercentageB2B: { readonly type: "number"; readonly description: "The percentage of page views by Amazon Business customers that a particular SKU/ASIN receives relative to the total number of page views by Amazon Business customers for all products. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly buyBoxPercentage: { readonly type: "number"; readonly description: "The percentage of page views where the buy box (the add to shopping cart link) appeared on the page for customers to add your product to their cart."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly buyBoxPercentageB2B: { readonly type: "number"; readonly description: "The percentage of page views by Amazon Business customers where the buy box (the add to shopping cart link) appeared on the page for customers to add your product to their cart. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [33.33]; }; readonly unitSessionPercentage: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many units were purchased relative to the number of people who viewed the products, calculated by dividing unitsOrdered by sessions."; readonly minimum: 0; readonly examples: readonly [33.33]; }; readonly unitSessionPercentageB2B: { readonly type: "number"; readonly description: "The percentage conversion metric indicating how many units were purchased by Amazon Business customers relative to the number of Amazon Business customers who viewed the products, calculated by dividing unitsOrderedB2B by sessions. Note: This field is only populated when the seller is a B2B seller."; readonly minimum: 0; readonly examples: readonly [33.33]; }; }; }; readonly Amount: { readonly type: "object"; readonly examples: readonly [{ readonly amount: 0; readonly currencyCode: "USD"; }, { readonly amount: 20; readonly currencyCode: "EUR"; }]; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The amount."; readonly examples: readonly [20]; }; readonly currencyCode: { readonly type: "string"; readonly description: "Currency code of the amount. In ISO 4217 format."; readonly examples: readonly ["USD", "EUR", "AUD", "JPY"]; }; }; }; }; }; type SellerSalesAndTrafficReport = FromSchema; //#endregion //#region src/reports/selling-partner-market-basket-analysis-report.d.ts declare const sellingPartnerMarketBasketAnalysisReport: { readonly type: "object"; readonly description: "The Market Basket report contains data on the items that are most commonly purchased in combination with the items in the customer's basket (cart) at checkout. The data is available across different reporting periods: DAY, WEEK, MONTH, and QUARTER. Requests can span multiple reporting periods. In this report, \"asin\" is an ASIN in the selling partner's catalog and \"purchasedWithAsin\" might or might not be an ASIN in the selling partner's catalog."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly dataByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly purchasedWithAsin: "B1A345B78C"; readonly purchasedWithRank: 1; readonly combinationPct: 0.028; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly purchasedWithAsin: "B1D345E78F"; readonly purchasedWithRank: 2; readonly combinationPct: 0.0229; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly purchasedWithAsin: "B1G345H78I"; readonly purchasedWithRank: 3; readonly combinationPct: 0.0212; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly purchasedWithAsin: "B9C765B32A"; readonly purchasedWithRank: 1; readonly combinationPct: 0.4342; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly purchasedWithAsin: "B9F765E32D"; readonly purchasedWithRank: 2; readonly combinationPct: 0.0378; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly purchasedWithAsin: "B9I765H32G"; readonly purchasedWithRank: 3; readonly combinationPct: 0.0155; }]; }]; readonly required: readonly ["reportSpecification", "dataByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-12"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "Type of the report."; readonly enum: readonly ["GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod."; readonly required: readonly ["reportPeriod"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "The granularity of the data in the report. Valid values are: DAY, WEEK, MONTH, QUARTER."; readonly enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the report (any time component is ignored). For WEEK, MONTH and QUARTER reportPeriods, this value must correspond to the first day in the specified reportPeriod or else a fatal error is returned. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the report (any time component is ignored). For WEEK, MONTH and QUARTER reportPeriods, this value must correspond to the last day in the specified reportPeriod or else a fatal error is returned. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-12"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. This report type supports only one marketplaceId per report. Specifying multiple marketplaces will result in a fatal error and fail to generate the report."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; }; }; }; readonly dataByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/DetailsByAsin"; }; }; }; readonly definitions: { readonly DetailsByAsin: { readonly type: "object"; readonly description: "Contains market basket analysis data for each ASIN in the selling partner's catalog."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly purchasedWithAsin: "B1A345B78C"; readonly purchasedWithRank: 1; readonly combinationPct: 0.028; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly purchasedWithAsin: "B9F765E32D"; readonly purchasedWithRank: 2; readonly combinationPct: 0.0378; }]; readonly required: readonly ["startDate", "endDate", "asin", "purchasedWithAsin", "purchasedWithRank", "combinationPct"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the data for the ASIN specified in the asin property. If the request spans multiple reportPeriods, byAsin data will be shared for each of these reportPeriods."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the data for the ASIN specified in the asin property."; readonly examples: readonly ["2021-06-06"]; }; readonly asin: { readonly type: "string"; readonly description: "Amazon Standard Identification Number."; readonly examples: readonly ["B123456789", "B987654321"]; }; readonly purchasedWithAsin: { readonly type: "string"; readonly description: "The Amazon Standard Identifier Number of a product that was purchased in the same customer order as the asin."; readonly examples: readonly ["B123456789", "B987654321"]; }; readonly purchasedWithRank: { readonly type: "integer"; readonly description: "The relative frequency of the purchasedWithAsin and the asin having been purchased together. Rank=1 means purchasedWithAsin is the most common product purchased in the same customer order as asin."; readonly examples: readonly [1, 3]; }; readonly combinationPct: { readonly type: "number"; readonly minimum: 0; readonly maximum: 1; readonly description: "Percentage of customer orders that contain both the selling partner's product and the purchasedWithAsin in comparison to the total number of customer orders that contained at least two different items including the selling partner's product."; readonly examples: readonly [0.4342, 0.0155]; }; }; }; }; }; type SellingPartnerMarketBasketAnalysisReport = FromSchema; //#endregion //#region src/reports/selling-partner-repeat-purchase-report.d.ts declare const sellingPartnerRepeatPurchaseReport: { readonly type: "object"; readonly description: "The Repeat Purchase report shares data on the quantity of repeated purchases of the selling partner's items. Data is available at different date range aggregation levels: WEEK, MONTH, QUARTER. Requests can span multiple reporting periods. In this report, \"asin\" is an ASIN in the selling partner's catalog."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly dataByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly orders: 1256; readonly uniqueCustomers: 1201; readonly repeatCustomersPctTotal: 0.0083; readonly repeatPurchaseRevenue: { readonly amount: 2246.13; readonly currencyCode: "USD"; }; readonly repeatPurchaseRevenuePctTotal: 0.0217; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B234567890"; readonly orders: 2561; readonly uniqueCustomers: 43; readonly repeatCustomersPctTotal: 0.1234; readonly repeatPurchaseRevenue: { readonly amount: 1234.56; readonly currencyCode: "USD"; }; readonly repeatPurchaseRevenuePctTotal: 0.0465; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B987654321"; readonly orders: 6541; readonly uniqueCustomers: 123; readonly repeatCustomersPctTotal: 0.0129; readonly repeatPurchaseRevenue: { readonly amount: 1662.46; readonly currencyCode: "USD"; }; readonly repeatPurchaseRevenuePctTotal: 0.8717; }]; }]; readonly required: readonly ["reportSpecification", "dataByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly enum: readonly ["GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod."; readonly required: readonly ["reportPeriod"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "Determines what granularity of data is expected in the report. Valid values are: WEEK, MONTH, QUARTER."; readonly enum: readonly ["WEEK", "MONTH", "QUARTER"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH and QUARTER reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH and QUARTER reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. This report type supports only one marketplaceId per report. Specifying multiple marketplaces will result in failure to generate the report."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly dataByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/DataByAsin"; }; }; }; readonly definitions: { readonly DataByAsin: { readonly type: "object"; readonly description: "Contains repeat purchase analytics data for each ASIN in the selling partner's catalog"; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly orders: 1256; readonly uniqueCustomers: 1201; readonly repeatCustomersPctTotal: 0.0083; readonly repeatPurchaseRevenue: { readonly amount: 2246.13; readonly currencyCode: "USD"; }; readonly repeatPurchaseRevenuePctTotal: 0.0217; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B234567890"; readonly orders: 2561; readonly uniqueCustomers: 43; readonly repeatCustomersPctTotal: 0.1234; readonly repeatPurchaseRevenue: { readonly amount: 1234.56; readonly currencyCode: "USD"; }; readonly repeatPurchaseRevenuePctTotal: 0.0465; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B987654321"; readonly orders: 6541; readonly uniqueCustomers: 123; readonly repeatCustomersPctTotal: 0.0129; readonly repeatPurchaseRevenue: { readonly amount: 1662.46; readonly currencyCode: "USD"; }; readonly repeatPurchaseRevenuePctTotal: 0.8717; }]; readonly required: readonly ["startDate", "endDate", "asin", "orders", "uniqueCustomers", "repeatCustomersPctTotal", "repeatPurchaseRevenue", "repeatPurchaseRevenuePctTotal"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the data contained within the object. If the request spans multiple reportPeriods, byAsin data will be shared for each of these reportPeriods."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the data contained within the object."; readonly examples: readonly ["2021-06-12"]; }; readonly asin: { readonly type: "string"; readonly description: "Amazon Standard Identification Number."; readonly examples: readonly ["B123456789", "B987654321"]; }; readonly orders: { readonly type: "integer"; readonly description: "The number of orders. An order may include multiple quantities of a product and differs from ordered units."; readonly examples: readonly [1256, 6541]; }; readonly uniqueCustomers: { readonly type: "integer"; readonly description: "Number of unique customers who placed an order containing the asin."; readonly examples: readonly [1201, 123]; }; readonly repeatCustomersPctTotal: { readonly type: "number"; readonly minimum: 0; readonly maximum: 1; readonly description: "Fraction of unique customers that are repeat customers."; readonly examples: readonly [0.0083, 0.0129]; }; readonly repeatPurchaseRevenue: { readonly type: "object"; readonly description: "Ordered revenue from repeat customers. Returns are not reflected."; readonly examples: readonly [{ readonly amount: 2246.13; readonly currencyCode: "USD"; }]; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The amount."; readonly examples: readonly [2246.13]; }; readonly currencyCode: { readonly type: "string"; readonly pattern: "[A-Z]{3}"; readonly description: "The currency code of the amount."; readonly examples: readonly ["USD", "EUR", "JPY"]; }; }; }; readonly repeatPurchaseRevenuePctTotal: { readonly type: "number"; readonly minimum: 0; readonly maximum: 1; readonly description: "Fraction of repeatPurchaseRevenue versus total revenue."; readonly examples: readonly [0.0217, 0.8717]; }; }; }; }; }; type SellingPartnerRepeatPurchaseReport = FromSchema; //#endregion //#region src/reports/selling-partner-search-catalog-performance-report.d.ts declare const sellingPartnerSearchCatalogPerformanceReport: { readonly type: "object"; readonly description: "The Search Catalog Performance report provides search engagement metrics, such as impressions, clicks, cart adds, and purchases for a date range that you specify. The data is available at different reporting periods: WEEK, MONTH, and QUARTER. Requests cannot span multiple periods. For example, a request at the WEEK level cannot start on 2025-01-05 and end on 2025-01-18 as this request spans two weeks."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; readonly asins: "B123456789 B987654321"; }; readonly dataStartTime: "2025-01-05"; readonly dataEndTime: "2025-01-11"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly dataByAsin: readonly [{ readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B123456789"; readonly impressionData: { readonly impressionCount: 10000; readonly impressionMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingImpressionCount: 5000; readonly oneDayShippingImpressionCount: 3000; readonly twoDayShippingImpressionCount: 2000; }; readonly clickData: { readonly clickCount: 1000; readonly clickRate: 0.1; readonly clickedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingClickCount: 500; readonly oneDayShippingClickCount: 300; readonly twoDayShippingClickCount: 200; }; readonly cartAddData: { readonly cartAddCount: 100; readonly cartAddedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingCartAddCount: 50; readonly oneDayShippingCartAddCount: 30; readonly twoDayShippingCartAddCount: 20; }; readonly purchaseData: { readonly purchaseCount: 50; readonly searchTrafficSales: { readonly amount: 999.5; readonly currencyCode: "USD"; }; readonly conversionRate: 0.05; readonly purchaseMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingPurchaseCount: 25; readonly oneDayShippingPurchaseCount: 15; readonly twoDayShippingPurchaseCount: 10; }; }, { readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B987654321"; readonly impressionData: { readonly impressionCount: 10000; readonly impressionMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingImpressionCount: 5000; readonly oneDayShippingImpressionCount: 3000; readonly twoDayShippingImpressionCount: 2000; }; readonly clickData: { readonly clickCount: 1000; readonly clickRate: 0.1; readonly clickedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingClickCount: 500; readonly oneDayShippingClickCount: 300; readonly twoDayShippingClickCount: 200; }; readonly cartAddData: { readonly cartAddCount: 100; readonly cartAddedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingCartAddCount: 50; readonly oneDayShippingCartAddCount: 30; readonly twoDayShippingCartAddCount: 20; }; readonly purchaseData: { readonly purchaseCount: 50; readonly searchTrafficSales: { readonly amount: 999.5; readonly currencyCode: "USD"; }; readonly conversionRate: 0.05; readonly purchaseMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingPurchaseCount: 25; readonly oneDayShippingPurchaseCount: 15; readonly twoDayShippingPurchaseCount: 10; }; }]; }]; readonly required: readonly ["reportSpecification", "dataByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; readonly asins: "B123456789 B987654321"; }; readonly dataStartTime: "2025-01-05"; readonly dataEndTime: "2025-01-11"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The type of the report."; readonly enum: readonly ["GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "The report options that specify parameters, such as reportPeriod."; readonly required: readonly ["reportPeriod"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "The granularity of the data in the report. Valid values are WEEK, MONTH, and QUARTER."; readonly enum: readonly ["WEEK", "MONTH", "QUARTER"]; }; readonly asins: { readonly type: "string"; readonly description: "A space-separated list of Amazon Standard Identification Number (ASINs) for which you can request the report. If you do not provide ASINs, the report returns search catalog performance data for all ASINs for which you are a brand owner. There is a 200-character limit."; readonly examples: readonly ["B123456789 B987654321"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the report (Amazon ignores the time component). For WEEK, MONTH, and QUARTER reportPeriods, this value must correspond to the first day in the reportPeriod that you specify or else a fatal error returns. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2025-01-05"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the report (Amazon ignores the time component). For WEEK, MONTH, and QUARTER reportPeriods, this value must correspond to the last day in the reportPeriod that you specify or else a fatal error returns. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2025-01-11"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. This report type supports only one marketplaceId per report. If you specify multiple marketplaces, a fatal error returns and report generation fails."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly dataByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/SearchCatalogPerformanceData"; }; }; }; readonly definitions: { readonly SearchCatalogPerformanceData: { readonly type: "object"; readonly description: "Contains search catalog performance data for ASINs in the selling partner's catalog."; readonly examples: readonly [{ readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B123456789"; readonly impressionData: { readonly impressionCount: 10000; readonly impressionMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingImpressionCount: 5000; readonly oneDayShippingImpressionCount: 3000; readonly twoDayShippingImpressionCount: 2000; }; readonly clickData: { readonly clickCount: 1000; readonly clickRate: 0.1; readonly clickedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingClickCount: 500; readonly oneDayShippingClickCount: 300; readonly twoDayShippingClickCount: 200; }; readonly cartAddData: { readonly cartAddCount: 100; readonly cartAddedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingCartAddCount: 50; readonly oneDayShippingCartAddCount: 30; readonly twoDayShippingCartAddCount: 20; }; readonly purchaseData: { readonly purchaseCount: 50; readonly searchTrafficSales: { readonly amount: 999.5; readonly currencyCode: "USD"; }; readonly conversionRate: 0.05; readonly purchaseMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingPurchaseCount: 25; readonly oneDayShippingPurchaseCount: 15; readonly twoDayShippingPurchaseCount: 10; }; }, { readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B987654321"; readonly impressionData: { readonly impressionCount: 10000; readonly impressionMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingImpressionCount: 5000; readonly oneDayShippingImpressionCount: 3000; readonly twoDayShippingImpressionCount: 2000; }; readonly clickData: { readonly clickCount: 1000; readonly clickRate: 0.1; readonly clickedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingClickCount: 500; readonly oneDayShippingClickCount: 300; readonly twoDayShippingClickCount: 200; }; readonly cartAddData: { readonly cartAddCount: 100; readonly cartAddedMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingCartAddCount: 50; readonly oneDayShippingCartAddCount: 30; readonly twoDayShippingCartAddCount: 20; }; readonly purchaseData: { readonly purchaseCount: 50; readonly searchTrafficSales: { readonly amount: 999.5; readonly currencyCode: "USD"; }; readonly conversionRate: 0.05; readonly purchaseMedianPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly sameDayShippingPurchaseCount: 25; readonly oneDayShippingPurchaseCount: 15; readonly twoDayShippingPurchaseCount: 10; }; }]; readonly required: readonly ["startDate", "endDate", "asin", "impressionData", "clickData", "cartAddData", "purchaseData"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the data for the ASIN that you specify in the asin property."; readonly examples: readonly ["2025-01-05"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the data for the ASIN that you specify in the asin property."; readonly examples: readonly ["2025-01-11"]; }; readonly asin: { readonly type: "string"; readonly description: "The Amazon Standard Identification Number."; readonly examples: readonly ["B123456789"]; }; readonly impressionData: { readonly $ref: "#/definitions/SearchCatalogPerformanceImpressionData"; }; readonly clickData: { readonly $ref: "#/definitions/SearchCatalogPerformanceClickData"; }; readonly cartAddData: { readonly $ref: "#/definitions/SearchCatalogPerformanceCartAddData"; }; readonly purchaseData: { readonly $ref: "#/definitions/SearchCatalogPerformancePurchaseData"; }; }; }; readonly SearchCatalogPerformanceImpressionData: { readonly type: "object"; readonly description: "The search impression data for your catalog."; readonly required: readonly ["impressionCount", "impressionMedianPrice", "sameDayShippingImpressionCount", "oneDayShippingImpressionCount", "twoDayShippingImpressionCount"]; readonly properties: { readonly impressionCount: { readonly type: "integer"; readonly description: "Total number of impressions for the given ASIN, which originates from the search results page across all search queries. Amazon counts an impression every time the ASIN displays in the search results page. Impressions include sponsored search results."; readonly examples: readonly [10000]; }; readonly impressionMedianPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly sameDayShippingImpressionCount: { readonly type: "integer"; readonly description: "The number of times the impressed ASIN displays with the same day delivery message in a search results page."; readonly examples: readonly [5000]; }; readonly oneDayShippingImpressionCount: { readonly type: "integer"; readonly description: "The number of times the impressed ASIN displays with the one-day delivery message in a search results page."; readonly examples: readonly [3000]; }; readonly twoDayShippingImpressionCount: { readonly type: "integer"; readonly description: "The number of times the impressed ASIN displays with the two-day delivery message in a search results page."; readonly examples: readonly [2000]; }; }; }; readonly SearchCatalogPerformanceClickData: { readonly type: "object"; readonly description: "The search click data for your catalog."; readonly required: readonly ["clickCount", "clickRate", "clickedMedianPrice", "sameDayShippingClickCount", "oneDayShippingClickCount", "twoDayShippingClickCount"]; readonly properties: { readonly clickCount: { readonly type: "integer"; readonly description: "The total number of clicks on the ASIN that originates from the search results page."; readonly examples: readonly [1000]; }; readonly clickRate: { readonly type: "number"; readonly description: "The number of clicks divided by the number of impressions for the ASIN."; readonly examples: readonly [0.1]; }; readonly clickedMedianPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly sameDayShippingClickCount: { readonly type: "integer"; readonly description: "The number of times customers click on the ASIN with the same day delivery message on the search results page."; readonly examples: readonly [500]; }; readonly oneDayShippingClickCount: { readonly type: "integer"; readonly description: "The number of times customers click on the ASIN with the one-day delivery message on the search results page."; readonly examples: readonly [300]; }; readonly twoDayShippingClickCount: { readonly type: "integer"; readonly description: "The number of times customers click on the ASIN with the two-day delivery message on the search results page."; readonly examples: readonly [200]; }; }; }; readonly SearchCatalogPerformanceCartAddData: { readonly type: "object"; readonly description: "The search attributed cart-add data for your catalog."; readonly required: readonly ["cartAddCount", "cartAddedMedianPrice", "sameDayShippingCartAddCount", "oneDayShippingCartAddCount", "twoDayShippingCartAddCount"]; readonly properties: { readonly cartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add an ASIN to a cart. This data originates from the search results page."; readonly examples: readonly [100]; }; readonly cartAddedMedianPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly sameDayShippingCartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add an ASIN to a cart with the same day delivery message in the search results page."; readonly examples: readonly [50]; }; readonly oneDayShippingCartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add an ASIN to a cart with the one-day delivery message in the search results page."; readonly examples: readonly [30]; }; readonly twoDayShippingCartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add an ASIN to a cart with the two-day delivery message in the search results page."; readonly examples: readonly [20]; }; }; }; readonly SearchCatalogPerformancePurchaseData: { readonly type: "object"; readonly description: "The search attributed purchase data for your catalog."; readonly required: readonly ["purchaseCount", "searchTrafficSales", "conversionRate", "purchaseMedianPrice", "sameDayShippingPurchaseCount", "oneDayShippingPurchaseCount", "twoDayShippingPurchaseCount"]; readonly properties: { readonly purchaseCount: { readonly type: "integer"; readonly description: "The total number of purchases for an ASIN. This data originates from the search results page."; readonly examples: readonly [50]; }; readonly searchTrafficSales: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly conversionRate: { readonly type: "number"; readonly description: "The number of purchases divided by the number of clicks for the ASIN."; readonly examples: readonly [0.05]; }; readonly purchaseMedianPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly sameDayShippingPurchaseCount: { readonly type: "integer"; readonly description: "The number of times customers purchase an ASIN with the same day delivery message in the search results page."; readonly examples: readonly [25]; }; readonly oneDayShippingPurchaseCount: { readonly type: "integer"; readonly description: "The number of times customers purchase an ASIN with the one-day delivery message in the search results page."; readonly examples: readonly [15]; }; readonly twoDayShippingPurchaseCount: { readonly type: "integer"; readonly description: "The number of times customers purchase an ASIN with the two-day delivery message in the search results page."; readonly examples: readonly [10]; }; }; }; readonly CurrencyAmount: { readonly type: "object"; readonly description: "Represents an amount of money in a specific currency."; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The monetary amount."; readonly examples: readonly [19.99, 999.5]; }; readonly currencyCode: { readonly type: "string"; readonly pattern: "[A-Z]{3}"; readonly description: "The 3-letter currency code in ISO 4217 format."; readonly examples: readonly ["USD", "EUR", "JPY"]; }; }; }; }; }; type SellingPartnerSearchCatalogPerformanceReport = FromSchema; //#endregion //#region src/reports/selling-partner-search-query-performance-report.d.ts declare const sellingPartnerSearchQueryPerformanceReport: { readonly type: "object"; readonly description: "The Search Query Performance Report provides overall query performance, such as impressions, clicks, cart adds, and purchases for a list of Amazon Standard Identification Numbers (ASINs) and date range that you specify. Data is available at different reporting periods: WEEK, MONTH, and QUARTER. Requests cannot span multiple periods. For example, a request at the WEEK level cannot start on 2025-01-05 and end on 2025-01-18 as this request spans two weeks."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; readonly asin: "B123456789 B987654321"; }; readonly dataStartTime: "2025-01-05"; readonly dataEndTime: "2025-01-11"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly dataByAsin: readonly [{ readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B123456789"; readonly searchQueryData: { readonly searchQuery: "wireless headphones"; readonly searchQueryScore: 5; readonly searchQueryVolume: 15000; }; readonly impressionData: { readonly totalQueryImpressionCount: 10000; readonly asinImpressionCount: 765; readonly asinImpressionShare: 0.0765; }; readonly clickData: { readonly totalClickCount: 1000; readonly totalClickRate: 0.1; readonly asinClickCount: 50; readonly asinClickShare: 0.05; readonly totalMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingClickCount: 200; readonly totalOneDayShippingClickCount: 300; readonly totalTwoDayShippingClickCount: 500; }; readonly cartAddData: { readonly totalCartAddCount: 200; readonly totalCartAddRate: 0.02; readonly asinCartAddCount: 10; readonly asinCartAddShare: 0.05; readonly totalMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingCartAddCount: 40; readonly totalOneDayShippingCartAddCount: 60; readonly totalTwoDayShippingCartAddCount: 100; }; readonly purchaseData: { readonly totalPurchaseCount: 100; readonly totalPurchaseRate: 0.01; readonly asinPurchaseCount: 5; readonly asinPurchaseShare: 0.05; readonly totalMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingPurchaseCount: 20; readonly totalOneDayShippingPurchaseCount: 30; readonly totalTwoDayShippingPurchaseCount: 50; }; }, { readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B987654321"; readonly searchQueryData: { readonly searchQuery: "wireless headphones"; readonly searchQueryScore: 5; readonly searchQueryVolume: 15000; }; readonly impressionData: { readonly totalQueryImpressionCount: 10000; readonly asinImpressionCount: 765; readonly asinImpressionShare: 0.0765; }; readonly clickData: { readonly totalClickCount: 1000; readonly totalClickRate: 0.1; readonly asinClickCount: 50; readonly asinClickShare: 0.05; readonly totalMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingClickCount: 200; readonly totalOneDayShippingClickCount: 300; readonly totalTwoDayShippingClickCount: 500; }; readonly cartAddData: { readonly totalCartAddCount: 200; readonly totalCartAddRate: 0.02; readonly asinCartAddCount: 10; readonly asinCartAddShare: 0.05; readonly totalMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingCartAddCount: 40; readonly totalOneDayShippingCartAddCount: 60; readonly totalTwoDayShippingCartAddCount: 100; }; readonly purchaseData: { readonly totalPurchaseCount: 100; readonly totalPurchaseRate: 0.01; readonly asinPurchaseCount: 5; readonly asinPurchaseShare: 0.05; readonly totalMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingPurchaseCount: 20; readonly totalOneDayShippingPurchaseCount: 30; readonly totalTwoDayShippingPurchaseCount: 50; }; }]; }]; readonly required: readonly ["reportSpecification", "dataByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; readonly asin: "B123456789 B987654321"; }; readonly dataStartTime: "2025-01-05"; readonly dataEndTime: "2025-01-11"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The type of the report."; readonly enum: readonly ["GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "The report options that specify parameters, such as reportPeriod and asin."; readonly required: readonly ["reportPeriod", "asin"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "The granularity of the data in the report. Valid values are WEEK, MONTH, and QUARTER."; readonly enum: readonly ["WEEK", "MONTH", "QUARTER"]; }; readonly asin: { readonly type: "string"; readonly description: "A space-separated list of ASINs for which you can request the report. There is a 200-character limit."; readonly examples: readonly ["B123456789 B987654321"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the report (Amazon ignores the time component). For WEEK, MONTH, and QUARTER reportPeriods, this value must correspond to the first day in the reportPeriod that you specify or else a fatal error returns. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2025-01-05"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the report (Amazon ignores the time component). For WEEK, MONTH, and QUARTER reportPeriods, this value must correspond to the last day in the reportPeriod that you specify or else a fatal error returns. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2025-01-11"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. This report type supports only one marketplaceId per report. If you specify multiple marketplaces, a fatal error returns and report generation fails."; readonly items: { readonly type: "string"; }; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; }; }; }; readonly dataByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/SearchQueryPerformanceData"; }; }; }; readonly definitions: { readonly SearchQueryPerformanceData: { readonly type: "object"; readonly description: "Contains search query performance data at the ASIN level."; readonly examples: readonly [{ readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B123456789"; readonly searchQueryData: { readonly searchQuery: "wireless headphones"; readonly searchQueryScore: 5; readonly searchQueryVolume: 15000; }; readonly impressionData: { readonly totalQueryImpressionCount: 10000; readonly asinImpressionCount: 765; readonly asinImpressionShare: 0.0765; }; readonly clickData: { readonly totalClickCount: 1000; readonly totalClickRate: 0.1; readonly asinClickCount: 50; readonly asinClickShare: 0.05; readonly totalMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingClickCount: 200; readonly totalOneDayShippingClickCount: 300; readonly totalTwoDayShippingClickCount: 500; }; readonly cartAddData: { readonly totalCartAddCount: 200; readonly totalCartAddRate: 0.02; readonly asinCartAddCount: 10; readonly asinCartAddShare: 0.05; readonly totalMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingCartAddCount: 40; readonly totalOneDayShippingCartAddCount: 60; readonly totalTwoDayShippingCartAddCount: 100; }; readonly purchaseData: { readonly totalPurchaseCount: 100; readonly totalPurchaseRate: 0.01; readonly asinPurchaseCount: 5; readonly asinPurchaseShare: 0.05; readonly totalMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingPurchaseCount: 20; readonly totalOneDayShippingPurchaseCount: 30; readonly totalTwoDayShippingPurchaseCount: 50; }; }, { readonly startDate: "2025-01-05"; readonly endDate: "2025-01-11"; readonly asin: "B987654321"; readonly searchQueryData: { readonly searchQuery: "wireless headphones"; readonly searchQueryScore: 5; readonly searchQueryVolume: 15000; }; readonly impressionData: { readonly totalQueryImpressionCount: 10000; readonly asinImpressionCount: 765; readonly asinImpressionShare: 0.0765; }; readonly clickData: { readonly totalClickCount: 1000; readonly totalClickRate: 0.1; readonly asinClickCount: 50; readonly asinClickShare: 0.05; readonly totalMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianClickPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingClickCount: 200; readonly totalOneDayShippingClickCount: 300; readonly totalTwoDayShippingClickCount: 500; }; readonly cartAddData: { readonly totalCartAddCount: 200; readonly totalCartAddRate: 0.02; readonly asinCartAddCount: 10; readonly asinCartAddShare: 0.05; readonly totalMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianCartAddPrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingCartAddCount: 40; readonly totalOneDayShippingCartAddCount: 60; readonly totalTwoDayShippingCartAddCount: 100; }; readonly purchaseData: { readonly totalPurchaseCount: 100; readonly totalPurchaseRate: 0.01; readonly asinPurchaseCount: 5; readonly asinPurchaseShare: 0.05; readonly totalMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly asinMedianPurchasePrice: { readonly amount: 19.99; readonly currencyCode: "USD"; }; readonly totalSameDayShippingPurchaseCount: 20; readonly totalOneDayShippingPurchaseCount: 30; readonly totalTwoDayShippingPurchaseCount: 50; }; }]; readonly required: readonly ["startDate", "endDate", "asin", "searchQueryData", "impressionData", "clickData", "cartAddData", "purchaseData"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the data for the ASIN that you specify."; readonly examples: readonly ["2025-01-05"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the data for the ASIN that you specify."; readonly examples: readonly ["2025-01-11"]; }; readonly asin: { readonly type: "string"; readonly description: "A space-separated list of ASINs for which you can request the report. There is a 200-character limit."; readonly examples: readonly ["B123456789 B987654321"]; }; readonly searchQueryData: { readonly $ref: "#/definitions/SearchQueryData"; }; readonly impressionData: { readonly $ref: "#/definitions/SearchQueryPerformanceImpressionData"; }; readonly clickData: { readonly $ref: "#/definitions/SearchQueryPerformanceClickData"; }; readonly cartAddData: { readonly $ref: "#/definitions/SearchQueryPerformanceCartAddData"; }; readonly purchaseData: { readonly $ref: "#/definitions/SearchQueryPerformancePurchaseData"; }; }; }; readonly SearchQueryData: { readonly type: "object"; readonly description: "The search query data."; readonly required: readonly ["searchQuery", "searchQueryScore", "searchQueryVolume"]; readonly properties: { readonly searchQuery: { readonly type: "string"; readonly description: "A buying customer’s search query that is relevant to your branded catalog."; readonly examples: readonly ["wireless headphones"]; }; readonly searchQueryScore: { readonly type: "integer"; readonly description: "The rank for a search query in comparison to other queries for the ASIN. The ranking mechanism measures overall performance (the highest rank is 1)."; readonly examples: readonly [5]; }; readonly searchQueryVolume: { readonly type: "integer"; readonly description: "The number of times customers search for a query at a select time period."; readonly examples: readonly [15000]; }; }; }; readonly SearchQueryPerformanceImpressionData: { readonly type: "object"; readonly description: "The search query performance impression data."; readonly required: readonly ["totalQueryImpressionCount", "asinImpressionCount", "asinImpressionShare"]; readonly properties: { readonly totalQueryImpressionCount: { readonly type: "integer"; readonly description: "The total number of impressions that originate from the search results page for all ASINs with the current query."; readonly examples: readonly [10000]; }; readonly asinImpressionCount: { readonly type: "integer"; readonly description: "The total number of impressions that originate from the search results page for the current ASIN with the current query."; readonly examples: readonly [765]; }; readonly asinImpressionShare: { readonly type: "number"; readonly description: "The fraction of impressions for the ASIN in comparison to the total impression count for the query."; readonly examples: readonly [0.0765]; }; }; }; readonly SearchQueryPerformanceClickData: { readonly type: "object"; readonly description: "The search query performance click data."; readonly required: readonly ["totalClickCount", "totalClickRate", "asinClickCount", "asinClickShare", "totalMedianClickPrice", "asinMedianClickPrice", "totalSameDayShippingClickCount", "totalOneDayShippingClickCount", "totalTwoDayShippingClickCount"]; readonly properties: { readonly totalClickCount: { readonly type: "integer"; readonly description: "For a search query, the number of ASIN clicks that originate from the search results page for any ASIN."; readonly examples: readonly [1000]; }; readonly totalClickRate: { readonly type: "number"; readonly description: "For a search query, the number of clicks divided by the search query volume."; readonly examples: readonly [0.1]; }; readonly asinClickCount: { readonly type: "integer"; readonly description: "For a search query, the number of clicks for the current ASIN."; readonly examples: readonly [50]; }; readonly asinClickShare: { readonly type: "number"; readonly description: "The fraction of clicks for the current ASIN in comparison to the total click count for the query."; readonly examples: readonly [0.05]; }; readonly totalMedianClickPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly asinMedianClickPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly totalSameDayShippingClickCount: { readonly type: "integer"; readonly description: "The number of times customers click on any ASIN with the same-day delivery message from the search results page for the specific query."; readonly examples: readonly [200]; }; readonly totalOneDayShippingClickCount: { readonly type: "integer"; readonly description: "The number of times customers click on any ASIN with the one-day delivery message from the search results page for the specific query."; readonly examples: readonly [300]; }; readonly totalTwoDayShippingClickCount: { readonly type: "integer"; readonly description: "The number of times customers click on any ASIN with the two-day delivery message from the search results page for the specific query."; readonly examples: readonly [500]; }; }; }; readonly SearchQueryPerformanceCartAddData: { readonly type: "object"; readonly description: "The search query performance cart add data."; readonly required: readonly ["totalCartAddCount", "totalCartAddRate", "asinCartAddCount", "asinCartAddShare", "totalMedianCartAddPrice", "asinMedianCartAddPrice", "totalSameDayShippingCartAddCount", "totalOneDayShippingCartAddCount", "totalTwoDayShippingCartAddCount"]; readonly properties: { readonly totalCartAddCount: { readonly type: "integer"; readonly description: "For a search query, the number of cart-adds that originate from the search result page across all ASINs."; readonly examples: readonly [200]; }; readonly totalCartAddRate: { readonly type: "number"; readonly description: "For a search query, the number of cart-adds across all ASINs divided by the search query volume."; readonly examples: readonly [0.02]; }; readonly asinCartAddCount: { readonly type: "integer"; readonly description: "For a search query, the number of cart-adds for the ASIN that originates from the search results page."; readonly examples: readonly [10]; }; readonly asinCartAddShare: { readonly type: "number"; readonly description: "The fraction of cart-adds for the ASIN in comparison to the total cart-add count for the query."; readonly examples: readonly [0.05]; }; readonly totalMedianCartAddPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly asinMedianCartAddPrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly totalSameDayShippingCartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add any ASIN with the same-day delivery message to a cart from the search results page for the specific query."; readonly examples: readonly [40]; }; readonly totalOneDayShippingCartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add any ASIN with the one-day delivery message to a cart from the search results page for the specific query."; readonly examples: readonly [60]; }; readonly totalTwoDayShippingCartAddCount: { readonly type: "integer"; readonly description: "The number of times customers add any ASIN with the two-day delivery message to a cart from the search results page for the specific query."; readonly examples: readonly [100]; }; }; }; readonly SearchQueryPerformancePurchaseData: { readonly type: "object"; readonly description: "The search query performance purchase data."; readonly required: readonly ["totalPurchaseCount", "totalPurchaseRate", "asinPurchaseCount", "asinPurchaseShare", "totalMedianPurchasePrice", "asinMedianPurchasePrice", "totalSameDayShippingPurchaseCount", "totalOneDayShippingPurchaseCount", "totalTwoDayShippingPurchaseCount"]; readonly properties: { readonly totalPurchaseCount: { readonly type: "integer"; readonly description: "For a search query, the number of purchases that originate from the search result for any ASIN."; readonly examples: readonly [100]; }; readonly totalPurchaseRate: { readonly type: "number"; readonly description: "For a search query, the number of purchases divided by the search query volume."; readonly examples: readonly [0.01]; }; readonly asinPurchaseCount: { readonly type: "integer"; readonly description: "For a search query, the number of purchases for the current ASIN."; readonly examples: readonly [5]; }; readonly asinPurchaseShare: { readonly type: "number"; readonly description: "The fraction of purchase actions for the ASIN in comparison to the total purchase count for the query."; readonly examples: readonly [0.05]; }; readonly totalMedianPurchasePrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly asinMedianPurchasePrice: { readonly $ref: "#/definitions/CurrencyAmount"; }; readonly totalSameDayShippingPurchaseCount: { readonly type: "integer"; readonly description: "The number of times customers purchase any ASIN with the same-day delivery message from the search results page for the specific query."; readonly examples: readonly [20]; }; readonly totalOneDayShippingPurchaseCount: { readonly type: "integer"; readonly description: "The number of times customers purchase any ASIN with a one-day delivery message from the search results page for the specific query."; readonly examples: readonly [30]; }; readonly totalTwoDayShippingPurchaseCount: { readonly type: "integer"; readonly description: "The number of times customers purchase any ASIN with a two-day delivery message from the search results page for the specific query."; readonly examples: readonly [50]; }; }; }; readonly CurrencyAmount: { readonly type: "object"; readonly description: "Represents an amount of money in a specific currency."; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The monetary amount."; readonly examples: readonly [19.99]; }; readonly currencyCode: { readonly type: "string"; readonly pattern: "[A-Z]{3}"; readonly description: "The 3-letter currency code, in ISO 4217 format."; readonly examples: readonly ["USD"]; }; }; }; }; }; type SellingPartnerSearchQueryPerformanceReport = FromSchema; //#endregion //#region src/reports/selling-partner-search-terms-report.d.ts declare const sellingPartnerSearchTermsReport: { readonly type: "object"; readonly description: "The Search Terms report shares data on the top-3 clicked ASINs by search keyword and department for a marketplace. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER. Requests cannot span multiple periods. For example, a request at WEEK level could not start on 2021-06-06 and end on 2021-06-19 as this would span two weeks."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-12"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly dataByDepartmentAndSearchTerm: readonly [{ readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B123456789"; readonly clickShareRank: 1; readonly clickShare: 0.0771; readonly conversionShare: 0.0874; }, { readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B987654321"; readonly clickShareRank: 2; readonly clickShare: 0.0726; readonly conversionShare: 0.0974; }, { readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B897654321"; readonly clickShareRank: 3; readonly clickShare: 0.0405; readonly conversionShare: 0.0854; }, { readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B123454321"; readonly clickShareRank: 1; readonly clickShare: 0.0567; readonly conversionShare: 0.123; }, { readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B567898765"; readonly clickShareRank: 2; readonly clickShare: 0.0371; readonly conversionShare: 0.0854; }, { readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B135797531"; readonly clickShareRank: 3; readonly clickShare: 0.0205; readonly conversionShare: 0.0469; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B1212134343"; readonly clickShareRank: 1; readonly clickShare: 0.1118; readonly conversionShare: 0.0974; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B1313145454"; readonly clickShareRank: 2; readonly clickShare: 0.0767; readonly conversionShare: 0.0743; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B1414156565"; readonly clickShareRank: 3; readonly clickShare: 0.0734; readonly conversionShare: 0; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B2323254545"; readonly clickShareRank: 1; readonly clickShare: 0.0677; readonly conversionShare: 0.0582; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B2424276767"; readonly clickShareRank: 2; readonly clickShare: 0.0411; readonly conversionShare: 0.0031; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B2525287878"; readonly clickShareRank: 3; readonly clickShare: 0.0374; readonly conversionShare: 0.1429; }]; }]; readonly required: readonly ["reportSpecification", "dataByDepartmentAndSearchTerm"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-12"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly enum: readonly ["GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod."; readonly required: readonly ["reportPeriod"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER."; readonly enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER"]; }; }; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH and QUARTER reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH and QUARTER reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-12"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to one marketplaceId."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly dataByDepartmentAndSearchTerm: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/DetailsByDepartmentAndSearchTerm"; }; }; }; readonly definitions: { readonly DetailsByDepartmentAndSearchTerm: { readonly type: "object"; readonly description: "Contains search term analytics by department name and search term."; readonly examples: readonly [{ readonly departmentName: "Amazon.com"; readonly searchTerm: "search term rank one"; readonly searchFrequencyRank: 1; readonly clickedAsin: "B123456789"; readonly clickShareRank: 1; readonly clickShare: 0.0771; readonly conversionShare: 0.0874; }, { readonly departmentName: "Beauty"; readonly searchTerm: "beauty search term rank two"; readonly searchFrequencyRank: 2; readonly clickedAsin: "B2424276767"; readonly clickShareRank: 2; readonly clickShare: 0.1411; readonly conversionShare: 0.0031; }]; readonly required: readonly ["departmentName", "searchTerm", "searchFrequencyRank", "clickedAsin", "clickShareRank", "clickShare", "conversionShare"]; readonly properties: { readonly departmentName: { readonly type: "string"; readonly description: "The name of the Amazon search department the searchTerm was searched within. For example, customers may search across all of Amazon.com or within the Beauty department within Amazon.com."; readonly examples: readonly ["Amazon.com", "Beauty", "Books"]; }; readonly searchTerm: { readonly type: "string"; readonly description: "The term the customer used when searching for products."; readonly examples: readonly ["christmas day gifts", "hiking shoes"]; }; readonly searchFrequencyRank: { readonly type: "integer"; readonly description: "The relative ranking of the searchTerm within a departmentName based on frequency of searches for the specified reportPeriod."; readonly minimum: 1; readonly examples: readonly [1, 2]; }; readonly clickedAsin: { readonly type: "string"; readonly description: "The Amazon Standard Identification Number of a product that the customer clicked on after using the searchTerm within a departmentName."; readonly examples: readonly ["B123456789", "B987654321"]; }; readonly clickShareRank: { readonly type: "integer"; readonly description: "The relative ranking of the clickedAsin based on clickShare."; readonly minimum: 1; readonly examples: readonly [1, 2]; }; readonly clickShare: { readonly type: "number"; readonly description: "The fraction of clicks that the product received compared to the total clicks for the searchTerm within the departmentName for the specified reportPeriod. Multiply the value by 100 to represent as a percentage."; readonly minimum: 0; readonly maximum: 1; readonly examples: readonly [0.123, 0.0765]; }; readonly conversionShare: { readonly type: "number"; readonly minimum: 0; readonly maximum: 1; readonly description: "The fraction of conversions that the product achieved in comparison to the total conversions that resulted from the departmentName and searchTerm in the respective reportPeriod. For example, if overall conversions for searchTerm=batteries was 98, and the conversions for clickedAsin were 13, conversionShare would be 13/98=0.1327. Multiply by 100 to express as a percentage."; readonly examples: readonly [0.0854, 0.0123]; }; }; }; }; }; type SellingPartnerSearchTermsReport = FromSchema; //#endregion //#region src/reports/vendor-coupon-report.d.ts declare const vendorCouponReport: { readonly type: "object"; readonly description: "This report contains data to help vendors optimize their coupons and adjust their advertising strategies. This report supports start dates up to two years before the current date."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_COUPON_PERFORMANCE_REPORT"; readonly reportOptions: { readonly campaignStartDateFrom: "2021-11-01T15:33:26Z"; readonly campaignStartDateTo: "2021-11-30T15:33:26Z"; }; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly campaigns: readonly [{ readonly campaignId: "AMZHYHN65T7OH"; readonly campaignName: "Thanksgiving 2021"; readonly vendorCode: "ABCDE"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly creationDateTime: "2021-11-01T12:34:56Z"; readonly lastUpdatedDateTime: "2021-12-16T09:44:35Z"; readonly isSubscribeAndSave: false; readonly budgetType: "PER_INDIVIDUAL_COUPON"; readonly totalClips: 13; readonly totalRedemptions: 1; readonly currencyCode: "USD"; readonly coupons: readonly [{ readonly couponId: "A2NW32V27GZS2T"; readonly name: "Product $40 Off"; readonly websiteMessage: "Save on BrandX Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly isOncePerCustomer: true; readonly customerSegment: "All (Default)"; readonly clips: 13; readonly redemptions: 1; readonly budget: 10000; readonly totalDiscount: 40; readonly budgetSpent: 42.29; readonly budgetRemaining: 9957.71; readonly budgetPercentageUsed: 0.4; readonly asins: readonly [{ readonly asin: "B08XJWMYR5"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; }, { readonly asin: "B07Z7XTQKZ"; readonly discountType: "AMOUNT_OFF_LIST_PRICE"; readonly discountAmount: 4.99; }]; }]; }]; }]; readonly required: readonly ["reportSpecification", "campaigns"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly examples: readonly [{ readonly reportType: "GET_COUPON_PERFORMANCE_REPORT"; readonly reportOptions: { readonly campaignStartDateFrom: "2021-11-01T15:33:26Z"; readonly campaignStartDateTo: "2021-11-30T15:33:26Z"; }; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly examples: readonly ["GET_COUPON_PERFORMANCE_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters campaignStartDateFrom and campaignStartDateTo."; readonly required: readonly ["campaignStartDateFrom", "campaignStartDateTo"]; readonly properties: { readonly campaignStartDateFrom: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC used for selecting coupons to report on. All coupons with a start date-time that falls within the range will be included."; readonly examples: readonly ["2021-11-01T15:33:26Z"]; }; readonly campaignStartDateTo: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC used for selecting coupons to report on. All coupons with a start date-time that falls within the range will be included."; readonly examples: readonly ["2021-11-30T15:33:26Z"]; }; }; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Marketplace IDs as specified in the report request."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; readonly description: "The marketplace ID."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; }; }; }; readonly campaigns: { readonly type: "array"; readonly description: "List of included campaigns."; readonly items: { readonly $ref: "#/definitions/DetailsByCampaign"; }; }; }; readonly definitions: { readonly DetailsByCampaign: { readonly type: "object"; readonly description: "Contains details about a campaign and every included coupon."; readonly examples: readonly [{ readonly campaignId: "AMZHYHN65T7OH"; readonly campaignName: "Thanksgiving 2021"; readonly vendorCode: "ABCDE"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly creationDateTime: "2021-11-01T12:34:56Z"; readonly lastUpdatedDateTime: "2021-12-16T09:44:35Z"; readonly isSubscribeAndSave: false; readonly budgetType: "PER_INDIVIDUAL_COUPON"; readonly totalClips: 13; readonly totalRedemptions: 1; readonly currencyCode: "USD"; readonly coupons: readonly [{ readonly couponId: "A2NW32V27GZS2T"; readonly name: "Product $40 Off"; readonly websiteMessage: "Save on BrandX Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly isOncePerCustomer: true; readonly customerSegment: "All (Default)"; readonly clips: 13; readonly redemptions: 1; readonly budget: 10000; readonly totalDiscount: 40; readonly budgetSpent: 42.29; readonly budgetRemaining: 9957.71; readonly budgetPercentageUsed: 0.4; readonly asins: readonly [{ readonly asin: "B08XJWMYR5"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; }, { readonly asin: "B07Z7XTQKZ"; readonly discountType: "AMOUNT_OFF_LIST_PRICE"; readonly discountAmount: 4.99; }]; }]; }, { readonly campaignId: "AMZHYHN65T7OH"; readonly campaignName: "Thanksgiving 2021"; readonly vendorCode: "ABCDE"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly creationDateTime: "2021-11-01T12:34:56Z"; readonly lastUpdatedDateTime: "2021-12-16T09:44:35Z"; readonly isSubscribeAndSave: false; readonly budgetType: "SHARED_BUDGET"; readonly totalClips: 80; readonly totalRedemptions: 36; readonly currencyCode: "USD"; readonly totalBudget: 5000; readonly totalBudgetSpent: 127.85; readonly totalBudgetRemaining: 4872.15; readonly coupons: readonly [{ readonly couponId: "A2NW32V27GZS2T"; readonly name: "B07KKXTNK1 $20, 11.26-11.29"; readonly websiteMessage: "Save on BrandY Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly isOncePerCustomer: false; readonly customerSegment: "All (Default)"; readonly clips: 21; readonly redemptions: 8; readonly totalDiscount: 36.49; readonly budgetSpent: 40.7; readonly budgetPercentageUsed: 0.8; readonly asins: readonly [{ readonly asin: "B07KKXTNK1"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 25; }]; }, { readonly couponId: "A2NW32V27GZS2T"; readonly name: "B08W3JHG19 $20, 11.26-11.29"; readonly couponVendorCode: "ABCDE"; readonly websiteMessage: "Save on BrandZ Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly isOncePerCustomer: false; readonly customerSegment: "All (Default)"; readonly clips: 59; readonly redemptions: 28; readonly totalDiscount: 74.88; readonly budgetSpent: 87.15; readonly budgetPercentageUsed: 1.7; readonly asins: readonly [{ readonly asin: "B08W3JHG19"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; }]; }]; }]; readonly required: readonly ["campaignId", "campaignName", "vendorCode", "marketplaceId", "creationDateTime", "lastUpdatedDateTime", "isSubscribeAndSave", "budgetType", "totalClips", "totalRedemptions", "coupons"]; readonly properties: { readonly campaignId: { readonly type: "string"; readonly description: "Unique identifier of the campaign."; readonly examples: readonly ["AMZHYHN65T7OH"]; }; readonly campaignName: { readonly type: "string"; readonly description: "Name given to the campaign."; readonly examples: readonly ["Thanksgiving 2021"]; }; readonly vendorCode: { readonly type: "string"; readonly description: "The vendor code associated with the campaign."; readonly examples: readonly ["ABCDE"]; }; readonly marketplaceId: { readonly type: "string"; readonly description: "The marketplace the campaign is running in."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly creationDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Campaign creation date-time in UTC."; readonly examples: readonly ["2021-11-01T12:34:56Z"]; }; readonly lastUpdatedDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The latest date-time the campaign data in this report was updated. May be up to 24 hours before the current date-time."; readonly examples: readonly ["2021-12-16T09:44:35Z"]; }; readonly isSubscribeAndSave: { readonly type: "boolean"; readonly description: "Whether or not the campaign is a Subscribe and Save offer."; }; readonly budgetType: { readonly type: "string"; readonly description: "Whether the budget is allocated independently for each coupon or shared among all coupons."; readonly enum: readonly ["PER_INDIVIDUAL_COUPON", "SHARED_BUDGET"]; }; readonly totalClips: { readonly type: "integer"; readonly description: "Total number of times a coupon in the campaign has been applied on the product page, equal to the sum of all coupon clips."; readonly minimum: 0; readonly examples: readonly [80]; }; readonly totalRedemptions: { readonly type: "integer"; readonly description: "Total number of times a coupon in the campaign has been used for a purchase, equal to the sum of all coupon redemptions."; readonly minimum: 0; readonly examples: readonly [36]; }; readonly currencyCode: { readonly type: "string"; readonly description: "ISO 4217 currency code of all currency values in the campaign."; readonly examples: readonly ["USD"]; }; readonly totalBudget: { readonly type: "number"; readonly description: "Total budget allocated to the campaign. Currency value. Only present when budgetType is SHARED_BUDGET."; readonly minimum: 0; readonly examples: readonly [5000]; }; readonly totalBudgetSpent: { readonly type: "number"; readonly description: "Total amount spent by the vendor on the campaign, including clip fees and redemption fees, equal to the sum of all coupon budgetSpent. Currency value. Only present when budgetType is SHARED_BUDGET."; readonly minimum: 0; readonly examples: readonly [127.85]; }; readonly totalBudgetRemaining: { readonly type: "number"; readonly description: "The budget remaining for the campaign, equal to totalBudget minus totalBudgetSpent. Currency value. Only present when budgetType is SHARED_BUDGET."; readonly minimum: 0; readonly examples: readonly [4872.15]; }; readonly coupons: { readonly type: "array"; readonly description: "A list of included coupons and their details."; readonly items: { readonly $ref: "#/definitions/CouponDetails"; }; }; }; }; readonly CouponDetails: { readonly type: "object"; readonly description: "Contains details about a coupon."; readonly examples: readonly [{ readonly couponId: "A2NW32V27GZS2T"; readonly name: "Product $40 Off"; readonly websiteMessage: "Save on BrandX Product"; readonly startDateTime: "2021-11-26T05:59:59Z"; readonly endDateTime: "2021-11-29T23:59:59Z"; readonly isOncePerCustomer: true; readonly customerSegment: "All (Default)"; readonly clips: 13; readonly redemptions: 1; readonly budget: 10000; readonly totalDiscount: 40; readonly budgetSpent: 42.29; readonly budgetRemaining: 9957.71; readonly budgetPercentageUsed: 0.4; readonly asins: readonly [{ readonly asin: "B08XJWMYR5"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; }, { readonly asin: "B07Z7XTQKZ"; readonly discountType: "AMOUNT_OFF_LIST_PRICE"; readonly discountAmount: 5; }]; }]; readonly required: readonly ["couponId", "startDateTime", "endDateTime", "isOncePerCustomer", "customerSegment", "clips", "redemptions", "totalDiscount", "budgetSpent", "budgetPercentageUsed", "asins"]; readonly properties: { readonly couponId: { readonly type: "string"; readonly description: "Unique identifier of the coupon."; readonly examples: readonly ["A2NW32V27GZS2T"]; }; readonly name: { readonly type: "string"; readonly description: "The name given to the coupon."; readonly examples: readonly ["Product $40 Off"]; }; readonly websiteMessage: { readonly type: "string"; readonly description: "Message displayed with the coupon on the product page."; readonly examples: readonly ["Save on BrandX Product"]; }; readonly startDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Coupon start date-time in UTC."; readonly examples: readonly ["2021-11-26T05:59:59Z"]; }; readonly endDateTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "Coupon end date-time in UTC."; readonly examples: readonly ["2021-11-29T23:59:59Z"]; }; readonly isOncePerCustomer: { readonly type: "boolean"; readonly description: "Whether or not the coupon can only be redeemed once per customer account."; }; readonly customerSegment: { readonly type: "string"; readonly description: "The customer segment that the coupon is available to."; readonly examples: readonly ["All (Default)", "Amazon Prime", "Amazon Student"]; }; readonly clips: { readonly type: "integer"; readonly description: "Number of times the coupon has been applied on the product page."; readonly minimum: 0; readonly examples: readonly [13]; }; readonly redemptions: { readonly type: "integer"; readonly description: "Number of times the coupon has been used for a purchase. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [1]; }; readonly budget: { readonly type: "number"; readonly description: "Budget allocated to the coupon. Currency value. Only present when campaign budgetType is PER_INDIVIDUAL_COUPON."; readonly minimum: 0; readonly examples: readonly [10000]; }; readonly totalDiscount: { readonly type: "number"; readonly description: "Total amount saved by customers redeeming the coupon. Currency value. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [40]; }; readonly budgetSpent: { readonly type: "number"; readonly description: "Total amount spent by the vendor on the coupon, including clip fees and redemption fees. Currency value. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [42.29]; }; readonly budgetRemaining: { readonly type: "number"; readonly description: "Budget remaining for the coupon, equal to budget minus budgetSpent. Currency value. Only present when campaign budgetType is PER_INDIVIDUAL_COUPON. Represents a gross value, including purchases that were returned or cancelled."; readonly minimum: 0; readonly examples: readonly [9957.71]; }; readonly budgetPercentageUsed: { readonly type: "number"; readonly description: "Percentage of the allocated budget that has been spent, equal to the budgetSpent divided by budget or campaign totalBudget as appropriate."; readonly minimum: 0; readonly maximum: 100; readonly examples: readonly [0.4]; }; readonly asins: { readonly type: "array"; readonly description: "Discount details of the products associated with the coupon."; readonly items: { readonly $ref: "#/definitions/AsinDetails"; }; }; }; }; readonly AsinDetails: { readonly type: "object"; readonly description: "Contains details about an asin."; readonly examples: readonly [{ readonly asin: "B08XJWMYR5"; readonly discountType: "PERCENT_OFF_LIST_PRICE"; readonly discountAmount: 10; }, { readonly asin: "B07Z7XTQKZ"; readonly discountType: "AMOUNT_OFF_LIST_PRICE"; readonly discountAmount: 4.99; }]; readonly required: readonly ["asin", "discountType", "discountAmount"]; readonly properties: { readonly asin: { readonly type: "string"; readonly description: "Asin of the product."; readonly examples: readonly ["B08XJWMYR5"]; }; readonly discountType: { readonly type: "string"; readonly description: "Whether the discount is given as a fixed amount or a percentage off the list price."; readonly enum: readonly ["PERCENT_OFF_LIST_PRICE", "AMOUNT_OFF_LIST_PRICE"]; }; readonly discountAmount: { readonly type: "number"; readonly description: "Discount amount the customer receives on the product. Reflects a percentage when discountType is PERCENT_OFF_LIST_PRICE and a currency value when discountType is AMOUNT_OFF_LIST_PRICE."; readonly minimum: 0; readonly examples: readonly [10]; }; }; }; }; }; type VendorCouponReport = FromSchema; //#endregion //#region src/reports/vendor-forecasting-report.d.ts declare const vendorForecastingReport: { readonly type: "object"; readonly description: "Forecast customer demand of your products for production and inventory planning purposes."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_FORECASTING_REPORT"; readonly reportOptions: { readonly sellingProgram: "RETAIL"; }; readonly lastUpdatedDate: "2021-06-20"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly forecastByAsin: readonly [{ readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-06-20"; readonly endDate: "2021-06-26"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-06-27"; readonly endDate: "2021-07-03"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-07-04"; readonly endDate: "2021-07-10"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-07-11"; readonly endDate: "2021-07-17"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-07-18"; readonly endDate: "2021-07-24"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-07-25"; readonly endDate: "2021-07-31"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-08-01"; readonly endDate: "2021-08-07"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-08-08"; readonly endDate: "2021-08-14"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-08-15"; readonly endDate: "2021-08-21"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-08-22"; readonly endDate: "2021-08-28"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-08-29"; readonly endDate: "2021-09-04"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-09-05"; readonly endDate: "2021-09-11"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-09-12"; readonly endDate: "2021-09-18"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-09-19"; readonly endDate: "2021-09-25"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-09-26"; readonly endDate: "2021-10-02"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-10-03"; readonly endDate: "2021-10-09"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-10-10"; readonly endDate: "2021-10-16"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-10-17"; readonly endDate: "2021-10-23"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-10-24"; readonly endDate: "2021-10-30"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-10-31"; readonly endDate: "2021-11-06"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-11-07"; readonly endDate: "2021-11-13"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-11-14"; readonly endDate: "2021-11-20"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-11-21"; readonly endDate: "2021-11-27"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-11-28"; readonly endDate: "2021-12-04"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }, { readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-12-05"; readonly endDate: "2021-12-11"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.9; readonly p80ForecastUnits: 30.3; readonly p90ForecastUnits: 300.7; }]; }]; readonly required: readonly ["reportSpecification", "forecastByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "The report input summary which includes the marketplace, selling program, and last updated date."; readonly examples: readonly [{ readonly reportType: "GET_VENDOR_FORECASTING_REPORT"; readonly reportOptions: { readonly sellingProgram: "RETAIL"; }; readonly lastUpdatedDate: "2021-06-20"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "lastUpdatedDate", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly enum: readonly ["GET_VENDOR_FORECASTING_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as sellingProgram."; readonly examples: readonly [{ readonly sellingProgram: "RETAIL"; }]; readonly required: readonly ["sellingProgram"]; readonly properties: { readonly sellingProgram: { readonly type: "string"; readonly description: "The selling program."; readonly enum: readonly ["RETAIL", "FRESH"]; }; }; }; readonly lastUpdatedDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date when the report was last updated. Follows the ISO 8601 Date format of YYYY-MM-DD."; readonly examples: readonly ["2021-06-20"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly forecastByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/ForecastByAsin"; }; }; }; readonly definitions: { readonly ForecastByAsin: { readonly type: "object"; readonly description: "Describes forecast units for a particular ASIN for a specific period of time in the future."; readonly examples: readonly [{ readonly forecastGenerationDate: "2021-06-06"; readonly asin: "B123456789"; readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly meanForecastUnits: 3.1; readonly p70ForecastUnits: 3.7; readonly p80ForecastUnits: 30.2; readonly p90ForecastUnits: 300.8; }]; readonly required: readonly ["forecastGenerationDate", "asin", "startDate", "endDate", "meanForecastUnits", "p70ForecastUnits", "p80ForecastUnits", "p90ForecastUnits"]; readonly properties: { readonly forecastGenerationDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date that the forecast was generated."; readonly examples: readonly ["2021-06-06"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the time period being forecasted. The forecasted time period includes this date."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the time period being forecasted. The forecasted time period includes this date."; readonly examples: readonly ["2021-06-12"]; }; readonly meanForecastUnits: { readonly type: "number"; readonly minimum: 0; readonly description: "The average amount of forecast units that Amazon has predicted for this date range. This means that, on average, Amazon predicts that this many stock units will be purchased during this date range."; readonly examples: readonly [1.25]; }; readonly p70ForecastUnits: { readonly type: "number"; readonly minimum: 0; readonly description: "The 70th percentile of forecast units that Amazon has predicted for this date range. This means that Amazon has forecasted a 70% probability that the ASIN will not run out of stock during the date range if this many units of inventory are present at the start of the date range."; readonly examples: readonly [2.25]; }; readonly p80ForecastUnits: { readonly type: "number"; readonly minimum: 0; readonly description: "The 80th percentile of forecast units that Amazon has predicted for this date range. This means that Amazon has forecasted an 80% probability that the ASIN will not run out of stock during the date range if this many units of inventory are present at the start of the date range."; readonly examples: readonly [3.25]; }; readonly p90ForecastUnits: { readonly type: "number"; readonly minimum: 0; readonly description: "The 90th percentile of forecast units that Amazon has predicted for this date range. This means that Amazon has forecasted a 90% probability that the ASIN will not run out of stock during the date range if this many units of inventory are present at the start of the date range."; readonly examples: readonly [4.25]; }; }; }; }; }; type VendorForecastingReport = FromSchema; //#endregion //#region src/reports/vendor-inventory-report.d.ts declare const vendorInventoryReport: { readonly type: "object"; readonly description: "This report shares inventory data of a vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods. For example, if the customer specified reportPeriod=WEEK and a dataStartTime and dataEndTime that are 3 weeks apart, the report would contain data for each of those 3 contiguous weeks."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_INVENTORY_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; readonly distributorView: "MANUFACTURING"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly inventoryAggregate: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly vendorConfirmationRate: 0.88; readonly netReceivedInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 278; readonly openPurchaseOrderUnits: 123; readonly averageVendorLeadTimeDays: 10.2; readonly sellThroughRate: 0.88; readonly unfilledCustomerOrderedUnits: 12; readonly sellableOnHandInventoryCost: { readonly amount: 43123.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 5490; readonly unsellableOnHandInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 881; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 123.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 2234; readonly unhealthyInventoryCost: { readonly amount: 123.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 114; readonly procurableProductOutOfStockRate: 0.72; readonly uft: 0.19; readonly receiveFillRate: 0.67; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly vendorConfirmationRate: 0.98; readonly netReceivedInventoryCost: { readonly amount: 4335.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 123; readonly openPurchaseOrderUnits: 422; readonly averageVendorLeadTimeDays: 5.2; readonly sellThroughRate: 0.98; readonly unfilledCustomerOrderedUnits: 3; readonly sellableOnHandInventoryCost: { readonly amount: 43123.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 4490; readonly unsellableOnHandInventoryCost: { readonly amount: 3345.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 881; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 323.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 2234; readonly unhealthyInventoryCost: { readonly amount: 323.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 314; readonly procurableProductOutOfStockRate: 0.73; readonly uft: 0.18; readonly receiveFillRate: 0.77; }]; readonly inventoryByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly vendorConfirmationRate: 0.88; readonly netReceivedInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 278; readonly openPurchaseOrderUnits: 123; readonly averageVendorLeadTimeDays: 10.2; readonly sellThroughRate: 0.88; readonly unfilledCustomerOrderedUnits: 12; readonly sellableOnHandInventoryCost: { readonly amount: 43123.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 5490; readonly unsellableOnHandInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 881; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 123.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 2234; readonly unhealthyInventoryCost: { readonly amount: 123.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 114; readonly procurableProductOutOfStockRate: 0.47; readonly uft: 0.26; readonly receiveFillRate: 0.98; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly vendorConfirmationRate: 0.22; readonly netReceivedInventoryCost: { readonly amount: 235.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 78; readonly openPurchaseOrderUnits: 23; readonly averageVendorLeadTimeDays: 1.2; readonly sellThroughRate: 0.28; readonly unfilledCustomerOrderedUnits: 1; readonly sellableOnHandInventoryCost: { readonly amount: 123.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 590; readonly unsellableOnHandInventoryCost: { readonly amount: 245.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 81; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 13.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 234; readonly unhealthyInventoryCost: { readonly amount: 23.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 14; readonly procurableProductOutOfStockRate: 0.25; readonly uft: 0.49; readonly receiveFillRate: 0.81; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B123456789"; readonly vendorConfirmationRate: 0.12; readonly netReceivedInventoryCost: { readonly amount: 2325.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 728; readonly openPurchaseOrderUnits: 13; readonly averageVendorLeadTimeDays: 15.2; readonly sellThroughRate: 0.128; readonly unfilledCustomerOrderedUnits: 12; readonly sellableOnHandInventoryCost: { readonly amount: 1223.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 90; readonly unsellableOnHandInventoryCost: { readonly amount: 1245.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 811; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 123.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 2134; readonly unhealthyInventoryCost: { readonly amount: 231.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 141; readonly procurableProductOutOfStockRate: 0.89; readonly uft: 0.67; readonly receiveFillRate: 0.45; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B987654321"; readonly vendorConfirmationRate: 0.412; readonly netReceivedInventoryCost: { readonly amount: 1325.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 7228; readonly openPurchaseOrderUnits: 113; readonly averageVendorLeadTimeDays: 5.2; readonly sellThroughRate: 1.128; readonly unfilledCustomerOrderedUnits: 122; readonly sellableOnHandInventoryCost: { readonly amount: 12223.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 900; readonly unsellableOnHandInventoryCost: { readonly amount: 11245.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 1811; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 1123.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 1134; readonly unhealthyInventoryCost: { readonly amount: 2231.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 241; readonly procurableProductOutOfStockRate: 0.33; readonly uft: 0.22; readonly receiveFillRate: 0.11; }]; }]; readonly required: readonly ["reportSpecification", "inventoryAggregate", "inventoryByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "The report summary including a reporting date range, distributor view, selling program, and last updated date in the input."; readonly examples: readonly [{ readonly reportType: "GET_VENDOR_INVENTORY_REPORT"; readonly reportOptions: { readonly distributorView: "MANUFACTURING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "lastUpdatedDate", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The type of report."; readonly enum: readonly ["GET_VENDOR_INVENTORY_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod, distributorView, and sellingProgram."; readonly examples: readonly [{ readonly distributorView: "MANUFACTURING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; }]; readonly required: readonly ["distributorView", "reportPeriod", "sellingProgram"]; readonly properties: { readonly distributorView: { readonly type: "string"; readonly description: "The distributor view."; readonly enum: readonly ["MANUFACTURING", "SOURCING"]; }; readonly reportPeriod: { readonly type: "string"; readonly description: "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR."; readonly enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]; }; readonly sellingProgram: { readonly type: "string"; readonly description: "The selling program."; readonly enum: readonly ["RETAIL", "FRESH"]; }; }; }; readonly lastUpdatedDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date when the report was last updated. Follows the ISO 8601 Date format of YYYY-MM-DD."; readonly examples: readonly ["2021-06-20"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account (each selling partner account belongs to only one marketplaceId)."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly inventoryAggregate: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/InventoryAggregate"; }; }; readonly inventoryByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/InventoryByAsin"; }; }; }; readonly definitions: { readonly InventoryAggregate: { readonly type: "object"; readonly description: "Describes the aggregated inventory metrics for all ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly vendorConfirmationRate: 0.88; readonly netReceivedInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 278; readonly openPurchaseOrderUnits: 123; readonly averageVendorLeadTimeDays: 10.2; readonly sellThroughRate: 0.88; readonly unfilledCustomerOrderedUnits: 12; readonly sellableOnHandInventoryCost: { readonly amount: 43123.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 5490; readonly unsellableOnHandInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 881; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 123.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 2234; readonly unhealthyInventoryCost: { readonly amount: 123.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 114; }]; readonly required: readonly ["startDate", "endDate", "netReceivedInventoryCost", "netReceivedInventoryUnits", "openPurchaseOrderUnits", "sellableOnHandInventoryCost", "sellableOnHandInventoryUnits"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the aggregated data."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the aggregated data."; readonly examples: readonly ["2021-06-12"]; }; readonly procurableProductOutOfStockRate: { readonly type: "number"; readonly minimum: 0; readonly description: "The out of stock rate on all products that are procurable. This is calculated by out of stock glance views on a procurable ASIN divided by the total glance views."; readonly examples: readonly [0.28, 0.92]; }; readonly uft: { readonly type: "number"; readonly minimum: 0; readonly description: "The percentage of time an ASIN is available to be shipped to the customer from a fulfillment center, versus the selection Amazon intended to carry."; readonly examples: readonly [0.88, 1]; }; readonly receiveFillRate: { readonly type: "number"; readonly minimum: 0; readonly description: "The purchase order units received by Amazon in comparison to the purchase order units confirmed by the vendor. This is calculated as the received quantity divided by the confirmed quantity."; readonly examples: readonly [1, 0.12]; }; readonly vendorConfirmationRate: { readonly type: "number"; readonly minimum: 0; readonly description: "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested."; readonly examples: readonly [0.88, 1.12]; }; readonly netReceivedInventoryCost: { readonly $ref: "#/definitions/Amount"; readonly description: "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received."; }; readonly netReceivedInventoryUnits: { readonly type: "integer"; readonly description: "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received."; readonly examples: readonly [25]; }; readonly openPurchaseOrderUnits: { readonly type: "integer"; readonly description: "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested."; readonly examples: readonly [123]; }; readonly averageVendorLeadTimeDays: { readonly type: "number"; readonly minimum: 0; readonly description: "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers."; readonly examples: readonly [10.12]; }; readonly sellThroughRate: { readonly type: "number"; readonly description: "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers."; readonly examples: readonly [0.88]; }; readonly unfilledCustomerOrderedUnits: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of units that have been ordered (or pre-ordered) but have not yet shipped."; readonly examples: readonly [114]; }; readonly sellableOnHandInventoryCost: { readonly $ref: "#/definitions/Amount"; readonly description: "The cost of the inventory in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall."; }; readonly sellableOnHandInventoryUnits: { readonly type: "integer"; readonly description: "The number of units in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall."; readonly examples: readonly [5490]; }; readonly unsellableOnHandInventoryCost: { readonly $ref: "#/definitions/PositiveAmount"; readonly description: "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window."; }; readonly unsellableOnHandInventoryUnits: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window."; readonly examples: readonly [881]; }; readonly aged90PlusDaysSellableInventoryCost: { readonly $ref: "#/definitions/Amount"; readonly description: "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. "; }; readonly aged90PlusDaysSellableInventoryUnits: { readonly type: "integer"; readonly description: "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon."; readonly examples: readonly [2234]; }; readonly unhealthyInventoryCost: { readonly $ref: "#/definitions/PositiveAmount"; readonly description: "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand."; }; readonly unhealthyInventoryUnits: { readonly minimum: 0; readonly type: "integer"; readonly description: "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand."; readonly examples: readonly [114]; }; }; }; readonly InventoryByAsin: { readonly type: "object"; readonly description: "Describes ASIN-aggregated inventory metrics for the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly vendorConfirmationRate: 0.88; readonly netReceivedInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly netReceivedInventoryUnits: 278; readonly openPurchaseOrderUnits: 123; readonly averageVendorLeadTimeDays: 10.2; readonly sellThroughRate: 0.88; readonly unfilledCustomerOrderedUnits: 12; readonly sellableOnHandInventoryCost: { readonly amount: 43123.99; readonly currencyCode: "USD"; }; readonly sellableOnHandInventoryUnits: 5490; readonly unsellableOnHandInventoryCost: { readonly amount: 2345.5; readonly currencyCode: "USD"; }; readonly unsellableOnHandInventoryUnits: 881; readonly aged90PlusDaysSellableInventoryCost: { readonly amount: 123.5; readonly currencyCode: "USD"; }; readonly aged90PlusDaysSellableInventoryUnits: 2234; readonly unhealthyInventoryCost: { readonly amount: 123.45; readonly currencyCode: "USD"; }; readonly unhealthyInventoryUnits: 114; }]; readonly required: readonly ["startDate", "endDate", "asin", "netReceivedInventoryCost", "netReceivedInventoryUnits", "openPurchaseOrderUnits", "sellableOnHandInventoryCost", "sellableOnHandInventoryUnits"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the aggregated data."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the aggregated data."; readonly examples: readonly ["2021-06-12"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly vendorConfirmationRate: { readonly type: "number"; readonly minimum: 0; readonly description: "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested."; readonly examples: readonly [0.88, 1.12]; }; readonly netReceivedInventoryCost: { readonly $ref: "#/definitions/Amount"; readonly description: "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received."; }; readonly netReceivedInventoryUnits: { readonly type: "integer"; readonly description: "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received."; readonly examples: readonly [25]; }; readonly openPurchaseOrderUnits: { readonly type: "integer"; readonly description: "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested."; readonly examples: readonly [123]; }; readonly averageVendorLeadTimeDays: { readonly type: "number"; readonly minimum: 0; readonly description: "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers."; readonly examples: readonly [10.12]; }; readonly sellThroughRate: { readonly type: "number"; readonly description: "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers."; readonly examples: readonly [0.88]; }; readonly unfilledCustomerOrderedUnits: { readonly type: "integer"; readonly minimum: 0; readonly description: "Number of units that have been ordered (or pre-ordered) but have not yet shipped."; readonly examples: readonly [114]; }; readonly sellableOnHandInventoryCost: { readonly $ref: "#/definitions/Amount"; readonly description: "The cost of the inventory in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall."; }; readonly sellableOnHandInventoryUnits: { readonly type: "integer"; readonly description: "The number of units in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall."; readonly examples: readonly [5490]; }; readonly unsellableOnHandInventoryCost: { readonly $ref: "#/definitions/PositiveAmount"; readonly description: "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window."; }; readonly unsellableOnHandInventoryUnits: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window."; readonly examples: readonly [881]; }; readonly aged90PlusDaysSellableInventoryCost: { readonly $ref: "#/definitions/Amount"; readonly description: "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. "; }; readonly aged90PlusDaysSellableInventoryUnits: { readonly type: "integer"; readonly description: "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon."; readonly examples: readonly [2234]; }; readonly unhealthyInventoryCost: { readonly $ref: "#/definitions/PositiveAmount"; readonly description: "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand."; }; readonly unhealthyInventoryUnits: { readonly minimum: 0; readonly type: "integer"; readonly description: "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand."; readonly examples: readonly [114]; }; }; }; readonly Amount: { readonly type: "object"; readonly examples: readonly [{ readonly amount: -10; readonly currencyCode: "USD"; }, { readonly amount: 0; readonly currencyCode: "USD"; }, { readonly amount: 20; readonly currencyCode: "EUR"; }]; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The amount."; readonly examples: readonly [20]; }; readonly currencyCode: { readonly type: "string"; readonly description: "Currency code of the amount. In ISO 4217 format."; readonly examples: readonly ["USD", "EUR", "AUD", "JPY"]; }; }; }; readonly PositiveAmount: { readonly type: "object"; readonly examples: readonly [{ readonly amount: 0; readonly currencyCode: "USD"; }, { readonly amount: 20; readonly currencyCode: "EUR"; }]; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly minimum: 0; readonly description: "The amount."; readonly examples: readonly [20]; }; readonly currencyCode: { readonly type: "string"; readonly description: "Currency code of the amount. In ISO 4217 format."; readonly examples: readonly ["USD", "EUR", "AUD", "JPY"]; }; }; }; }; }; type VendorInventoryReport = FromSchema; //#endregion //#region src/reports/vendor-net-pure-product-margin-report.d.ts declare const vendorNetPureProductMarginReport: { readonly type: "object"; readonly description: "The Net Pure Product Margin report shares data with vendors on Amazon's profit margin selling the vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly netPureProductMarginAggregate: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly netPureProductMargin: 0.1234; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly netPureProductMargin: 0.1234; }]; readonly netPureProductMarginByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly netPureProductMargin: 0.1234; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly netPureProductMargin: 0.1234; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B123456789"; readonly netPureProductMargin: 0.1234; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B987654321"; readonly netPureProductMargin: 0.1234; }]; }]; readonly required: readonly ["reportSpecification", "netPureProductMarginAggregate", "netPureProductMarginByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "The report summary including the specified reporting date range and the last updated date in the input."; readonly examples: readonly [{ readonly reportType: "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "lastUpdatedDate", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly enum: readonly ["GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod."; readonly required: readonly ["reportPeriod"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "Determines the period by which data in the report is aggregated. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR."; readonly enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]; }; }; }; readonly lastUpdatedDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date when the report was last updated. Follows the ISO 8601 Date format of YYYY-MM-DD."; readonly examples: readonly ["2021-06-20"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the vendor account. Each vendor account belongs to only one marketplaceId."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly netPureProductMarginAggregate: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/NetPureProductMarginAggregateDetails"; }; }; readonly netPureProductMarginByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/NetPureProductMarginDetailsByAsin"; }; }; }; readonly definitions: { readonly NetPureProductMarginAggregateDetails: { readonly type: "object"; readonly description: "Describes the aggregated net pure product margin for ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly netPureProductMargin: 0.1234; }]; readonly required: readonly ["startDate", "endDate", "netPureProductMargin"]; readonly properties: { readonly startDate: { readonly description: "The start date of the aggregated data."; readonly type: "string"; readonly format: "date"; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly description: "The end date of the aggregated data."; readonly type: "string"; readonly format: "date"; readonly examples: readonly ["2021-06-12"]; }; readonly netPureProductMargin: { readonly description: "A measure of Amazon's profitability considering Amazon's wholesale cost and vendor-funded cooperative marketing funds: (Product Revenue – Product COGS – Vendor Funded Coop) / Product Revenue. The value is a fraction with values between 0 and 1. To represent as a percentage, multiply the value by 100."; readonly type: "number"; readonly examples: readonly [0.1234]; }; }; }; readonly NetPureProductMarginDetailsByAsin: { readonly type: "object"; readonly description: "Describes the aggregated ASIN-level net pure product margin for ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly netPureProductMargin: 0.1234; }]; readonly required: readonly ["startDate", "endDate", "asin", "netPureProductMargin"]; readonly properties: { readonly startDate: { readonly description: "The start date of the aggregated ASIN-level data."; readonly type: "string"; readonly format: "date"; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly description: "The end date of the aggregated ASIN-level data."; readonly type: "string"; readonly format: "date"; readonly examples: readonly ["2021-06-12"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly netPureProductMargin: { readonly description: "A measure of Amazon's profitability considering Amazon's wholesale cost and vendor-funded cooperative marketing funds: (Product Revenue – Product COGS – Vendor Funded Coop) / Product Revenue. The value is a fraction with values between 0 and 1. To represent as a percentage, multiply the value by 100."; readonly type: "number"; readonly examples: readonly [0.1234]; }; }; }; }; }; type VendorNetPureProductMarginReport = FromSchema; //#endregion //#region src/reports/vendor-real-time-inventory-report.d.ts declare const vendorRealTimeInventoryReport: { readonly type: "object"; readonly description: "This report shares inventory data at an ASIN level, aggregated to an hourly granularity. Requests can span multiple date range periods, including the current day."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_REAL_TIME_INVENTORY_REPORT"; readonly dataStartTime: "2022-10-01T00:00:00Z"; readonly dataEndTime: "2022-10-01T02:00:00Z"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly reportData: readonly [{ readonly startTime: "2022-10-01T00:00:00Z"; readonly endTime: "2022-10-01T01:00:00Z"; readonly asin: "B123456789"; readonly highlyAvailableInventory: 270; }, { readonly startTime: "2022-10-01T00:00:00Z"; readonly endTime: "2022-10-01T01:00:00Z"; readonly asin: "B987654321"; readonly highlyAvailableInventory: 650; }, { readonly startTime: "2022-10-01T01:00:00Z"; readonly endTime: "2022-10-01T02:00:00Z"; readonly asin: "B123456789"; readonly highlyAvailableInventory: 250; }, { readonly startTime: "2022-10-01T01:00:00Z"; readonly endTime: "2022-10-01T02:00:00Z"; readonly asin: "B987654321"; readonly highlyAvailableInventory: 550; }]; }]; readonly required: readonly ["reportSpecification", "reportData"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly required: readonly ["reportType", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly enum: readonly ["GET_VENDOR_REAL_TIME_INVENTORY_REPORT"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. Start time can be up to 168 hours before the time of the request."; readonly examples: readonly ["2022-10-01T00:00:00Z", "2022-10-31T23:59:59Z"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. End time should not be more than 24 hours from the start time."; readonly examples: readonly ["2022-10-01T00:00:00Z", "2022-10-31T23:59:59Z"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Marketplace IDs as specified in the report request."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly reportData: { readonly type: "array"; readonly description: "List of ASIN and inventory count combinations."; readonly items: { readonly $ref: "#/definitions/ReportData"; }; }; }; readonly definitions: { readonly ReportData: { readonly type: "object"; readonly description: "Contains details about ASIN and inventory count combinations for the specified time range."; readonly required: readonly ["startTime", "endTime", "asin", "highlyAvailableInventory"]; readonly properties: { readonly startTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC representing the beginning of the hour for this object."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T08:00:00Z"]; }; readonly endTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC representing the end of the hour for this object."; readonly examples: readonly ["2022-04-20T21:00:00Z", "2022-04-20T09:00:00Z"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number (ASIN)."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly highlyAvailableInventory: { readonly type: "integer"; readonly minimum: 0; readonly description: "The number of units available to be sold on the website, based on units in Amazon fulfillment centers that are in sellable condition less units in customer shopping carts or otherwise bound for other orders (e.g. known subscribe-and-save orders)."; readonly examples: readonly [75, 4790]; }; }; }; }; }; type VendorRealTimeInventoryReport = FromSchema; //#endregion //#region src/reports/vendor-real-time-sales-report.d.ts declare const vendorRealTimeSalesReport: { readonly type: "object"; readonly description: "This report shares sales data at an ASIN level, aggregated to an hourly granularity. Requests can span multiple date range periods. For example, if the customer specified dataStartTime and dataEndTime span three hours, the report would contain data for each complete hour within the time span."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_REAL_TIME_SALES_REPORT"; readonly dataStartTime: "2022-04-20T20:00:00Z"; readonly dataEndTime: "2022-04-20T21:00:00Z"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; readonly reportOptions: { readonly currencyCode: "USD"; }; }; readonly reportData: readonly [{ readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00ABCD123"; readonly orderedUnits: 1; readonly orderedRevenue: 167.14; }, { readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00ABCD456"; readonly orderedUnits: 0; readonly orderedRevenue: 0; }, { readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00ABCD789"; readonly orderedUnits: 0; readonly orderedRevenue: 0; }, { readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00LMNO789"; readonly orderedUnits: 1; readonly orderedRevenue: 65.99; }, { readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00LMNO456"; readonly orderedUnits: 1; readonly orderedRevenue: 50.99; }, { readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00LMNO147"; readonly orderedUnits: 2; readonly orderedRevenue: 103.98; }, { readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00LMNO963"; readonly orderedUnits: 1; readonly orderedRevenue: 64.53; }]; }]; readonly required: readonly ["reportSpecification", "reportData"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly required: readonly ["reportType", "dataStartTime", "dataEndTime", "marketplaceIds", "reportOptions"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The type of the report."; readonly enum: readonly ["GET_VENDOR_REAL_TIME_SALES_REPORT"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T20:59:59Z"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T20:10:00Z"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Marketplace IDs as specified in the report request."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as currencyCode."; readonly required: readonly ["currencyCode"]; readonly properties: { readonly currencyCode: { readonly type: "string"; readonly description: "Currency code of the amount. In ISO 4217 format."; readonly examples: readonly ["USD", "EUR", "AUD", "JPY"]; }; }; }; }; }; readonly reportData: { readonly type: "array"; readonly description: "List of hour and ASIN combinations."; readonly items: { readonly $ref: "#/definitions/reportData"; }; }; }; readonly definitions: { readonly reportData: { readonly type: "object"; readonly description: "Contains details about hour and ASIN combinations for the specified time range."; readonly required: readonly ["startTime", "endTime", "asin", "orderedUnits", "orderedRevenue"]; readonly properties: { readonly startTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC representing the beginning of the hour for this object."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T08:00:00Z"]; }; readonly endTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC representing the end of the hour for this object."; readonly examples: readonly ["2022-04-20T21:00:00Z", "2022-04-20T09:00:00Z"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number (ASIN)."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly orderedUnits: { readonly type: "integer"; readonly description: "Number of units ordered by Amazon customers. This number can be negative if there are more cancellations than orders."; readonly examples: readonly [75, -12]; }; readonly orderedRevenue: { readonly type: "number"; readonly description: "Ordered Product Sales in the specified hour as of the time the report is generated. Adjustments are made for cancellations."; readonly examples: readonly [20]; }; }; }; }; }; type VendorRealTimeSalesReport = FromSchema; //#endregion //#region src/reports/vendor-real-time-traffic-report.d.ts declare const vendorRealTimeTrafficReport: { readonly type: "object"; readonly description: "This report shares data on the customer traffic to the detail pages of the vendor's items with an hourly granularity. Requests can span multiple date range periods. For example, if the customer specified dataStartTime and dataEndTime span three hours, the report would contain data for each complete hour within the time span."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_REAL_TIME_TRAFFIC_REPORT"; readonly dataStartTime: "2022-04-20T20:00:00Z"; readonly dataEndTime: "2022-04-20T21:00:00Z"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly reportData: readonly [{ readonly startTime: "2022-04-20T20:00:00Z"; readonly endTime: "2022-04-20T21:00:00Z"; readonly asin: "B00ABCD123"; readonly glanceViews: 75; }]; }]; readonly required: readonly ["reportSpecification", "reportData"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "Summarizes the original report request."; readonly required: readonly ["reportType", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The type of the report."; readonly enum: readonly ["GET_VENDOR_REAL_TIME_TRAFFIC_REPORT"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T20:59:59Z"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. End time should be at least 60 minutes earlier than the time of the request."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T20:10:00Z"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "Marketplace IDs as specified in the report request."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly reportData: { readonly type: "array"; readonly description: "List of hour and ASIN combinations."; readonly items: { readonly $ref: "#/definitions/ReportData"; }; }; }; readonly definitions: { readonly ReportData: { readonly type: "object"; readonly description: "Contains details about hour and ASIN combinations for the specified time range."; readonly required: readonly ["startTime", "endTime", "asin", "glanceViews"]; readonly properties: { readonly startTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The start of a date-time range in UTC representing the beginning of the hour for this object."; readonly examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T08:00:00Z"]; }; readonly endTime: { readonly type: "string"; readonly format: "date-time"; readonly description: "The end of a date-time range in UTC representing the end of the hour for this object."; readonly examples: readonly ["2022-04-20T21:00:00Z", "2022-04-20T09:00:00Z"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number (ASIN)."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly glanceViews: { readonly type: "integer"; readonly description: "The number of customer views of the product detail page for this ASIN."; readonly minimum: 0; readonly examples: readonly [75]; }; }; }; }; }; type VendorRealTimeTrafficReport = FromSchema; //#endregion //#region src/reports/vendor-sales-report.d.ts declare const vendorSalesReport: { readonly type: "object"; readonly description: "This report shares data on the sales performance of vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_SALES_REPORT"; readonly reportOptions: { readonly distributorView: "MANUFACTURING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly salesAggregate: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 1500; readonly currencyCode: "USD"; }; readonly orderedUnits: 75; readonly shippedCogs: { readonly amount: 90; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 200; readonly currencyCode: "USD"; }; readonly shippedUnits: 10; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly orderedUnits: 0; readonly shippedCogs: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedUnits: 0; }]; readonly salesByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 1000; readonly currencyCode: "USD"; }; readonly orderedUnits: 25; readonly shippedCogs: { readonly amount: 50; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 150; readonly currencyCode: "USD"; }; readonly shippedUnits: 5; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 500; readonly currencyCode: "USD"; }; readonly orderedUnits: 50; readonly shippedCogs: { readonly amount: 40; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 50; readonly currencyCode: "USD"; }; readonly shippedUnits: 5; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B123456789"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly orderedUnits: 0; readonly shippedCogs: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedUnits: 0; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B987654321"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly orderedUnits: 0; readonly shippedCogs: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 0; readonly currencyCode: "USD"; }; readonly shippedUnits: 0; }]; }, { readonly reportSpecification: { readonly reportType: "GET_VENDOR_SALES_REPORT"; readonly reportOptions: { readonly distributorView: "MANUFACTURING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "FRESH"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly salesAggregate: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly orderedRevenue: { readonly amount: 1500; readonly currencyCode: "USD"; }; readonly orderedUnits: 75; readonly shippedCogs: { readonly amount: 90; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 200; readonly currencyCode: "USD"; }; readonly shippedUnits: 10; }]; readonly salesByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly orderedRevenue: { readonly amount: 1500; readonly currencyCode: "USD"; }; readonly orderedUnits: 75; readonly shippedCogs: { readonly amount: 90; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 200; readonly currencyCode: "USD"; }; readonly shippedUnits: 10; }]; }, { readonly reportSpecification: { readonly reportType: "GET_VENDOR_SALES_REPORT"; readonly reportOptions: { readonly distributorView: "SOURCING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-12"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly salesAggregate: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly customerReturns: 0; readonly shippedCogs: { readonly amount: 90; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 200; readonly currencyCode: "USD"; }; readonly shippedUnits: 10; }]; readonly salesByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly customerReturns: 0; readonly shippedCogs: { readonly amount: 50; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 150; readonly currencyCode: "USD"; }; readonly shippedUnits: 5; }, { readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B987654321"; readonly customerReturns: 0; readonly shippedCogs: { readonly amount: 40; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 50; readonly currencyCode: "USD"; }; readonly shippedUnits: 5; }]; }]; readonly required: readonly ["reportSpecification", "salesAggregate", "salesByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "The report summary including reporting date range, distributor view, selling program, and last updated date in the input."; readonly examples: readonly [{ readonly reportType: "GET_VENDOR_SALES_REPORT"; readonly reportOptions: { readonly distributorView: "MANUFACTURING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "lastUpdatedDate", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The report type."; readonly enum: readonly ["GET_VENDOR_SALES_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod, distributorView, and sellingProgram."; readonly examples: readonly [{ readonly distributorView: "MANUFACTURING"; readonly reportPeriod: "WEEK"; readonly sellingProgram: "RETAIL"; }]; readonly required: readonly ["distributorView", "reportPeriod", "sellingProgram"]; readonly properties: { readonly distributorView: { readonly type: "string"; readonly description: "The distributor view."; readonly enum: readonly ["MANUFACTURING", "SOURCING"]; }; readonly reportPeriod: { readonly type: "string"; readonly description: "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR."; readonly enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]; }; readonly sellingProgram: { readonly type: "string"; readonly description: "The selling program."; readonly enum: readonly ["RETAIL", "BUSINESS", "FRESH"]; }; }; }; readonly lastUpdatedDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date when the report was last updated. Follows the ISO 8601 Date format of YYYY-MM-DD."; readonly examples: readonly ["2021-06-20"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly salesAggregate: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/SalesAggregate"; }; }; readonly salesByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/SalesByAsin"; }; }; }; readonly definitions: { readonly SalesAggregate: { readonly type: "object"; readonly description: "Describes aggregated sales metrics for ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 1500; readonly currencyCode: "USD"; }; readonly orderedUnits: 75; readonly shippedCogs: { readonly amount: 90; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 200; readonly currencyCode: "USD"; }; readonly shippedUnits: 10; }]; readonly required: readonly ["startDate", "endDate", "shippedCogs", "shippedRevenue", "shippedUnits"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the aggregated data."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the aggregated data."; readonly examples: readonly ["2021-06-12"]; }; readonly customerReturns: { readonly type: "integer"; readonly minimum: 0; readonly description: "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS."; readonly examples: readonly [0]; }; readonly orderedRevenue: { readonly $ref: "#/definitions/Amount"; readonly description: "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING."; }; readonly orderedUnits: { readonly type: "integer"; readonly description: "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING."; readonly minimum: 0; readonly examples: readonly [75]; }; readonly shippedCogs: { readonly $ref: "#/definitions/Amount"; readonly description: "Revenue based on the cost of goods sold. Adjustments are made for returns."; }; readonly shippedRevenue: { readonly $ref: "#/definitions/Amount"; readonly description: "Revenue based on units shipped in the selected time frame. Adjustments are made for returns."; }; readonly shippedUnits: { readonly type: "integer"; readonly description: "Number of units shipped to Amazon customers."; readonly minimum: 0; readonly examples: readonly [10]; }; }; }; readonly SalesByAsin: { readonly type: "object"; readonly description: "Describes aggregated ASIN-level sales metrics for ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly customerReturns: 0; readonly orderedRevenue: { readonly amount: 1000; readonly currencyCode: "USD"; }; readonly orderedUnits: 25; readonly shippedCogs: { readonly amount: 50; readonly currencyCode: "USD"; }; readonly shippedRevenue: { readonly amount: 150; readonly currencyCode: "USD"; }; readonly shippedUnits: 5; }]; readonly required: readonly ["startDate", "endDate", "asin", "shippedCogs", "shippedRevenue", "shippedUnits"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the aggregated ASIN-level data."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the aggregated ASIN-level data."; readonly examples: readonly ["2021-06-12"]; }; readonly asin: { readonly description: "The Amazon Standard Identification Number."; readonly type: "string"; readonly examples: readonly ["B123456789"]; }; readonly customerReturns: { readonly type: "integer"; readonly description: "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS."; readonly minimum: 0; readonly examples: readonly [0]; }; readonly orderedRevenue: { readonly $ref: "#/definitions/Amount"; readonly description: "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING"; }; readonly orderedUnits: { readonly type: "integer"; readonly description: "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING"; readonly minimum: 0; readonly examples: readonly [25]; }; readonly shippedCogs: { readonly $ref: "#/definitions/Amount"; readonly description: "Revenue based on the cost of goods sold. Adjustments are made for returns."; }; readonly shippedRevenue: { readonly $ref: "#/definitions/Amount"; readonly description: "Revenue based on units shipped in the selected time frame. Adjustments are made for returns."; }; readonly shippedUnits: { readonly type: "integer"; readonly description: "Number of units shipped to Amazon customers."; readonly minimum: 0; readonly examples: readonly [5]; }; }; }; readonly Amount: { readonly type: "object"; readonly examples: readonly [{ readonly amount: 0; readonly currencyCode: "USD"; }, { readonly amount: 20; readonly currencyCode: "EUR"; }]; readonly required: readonly ["amount", "currencyCode"]; readonly properties: { readonly amount: { readonly type: "number"; readonly description: "The amount."; readonly examples: readonly [20]; }; readonly currencyCode: { readonly type: "string"; readonly description: "Currency code of the amount. In ISO 4217 format."; readonly examples: readonly ["USD", "EUR", "AUD", "JPY"]; }; }; }; }; }; type VendorSalesReport = FromSchema; //#endregion //#region src/reports/vendor-traffic-report.d.ts declare const vendorTrafficReport: { readonly type: "object"; readonly description: "This report shares data on the customer traffic to the detail pages of the vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available for different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods."; readonly examples: readonly [{ readonly reportSpecification: { readonly reportType: "GET_VENDOR_TRAFFIC_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }; readonly trafficAggregate: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly glanceViews: 100; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly glanceViews: 250; }]; readonly trafficByAsin: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly glanceViews: 100; }, { readonly startDate: "2021-06-13"; readonly endDate: "2021-06-19"; readonly asin: "B123456789"; readonly glanceViews: 250; }]; }]; readonly required: readonly ["reportSpecification", "trafficAggregate", "trafficByAsin"]; readonly properties: { readonly reportSpecification: { readonly type: "object"; readonly description: "The report summary including the specified reporting date range and the last updated date in the input."; readonly examples: readonly [{ readonly reportType: "GET_VENDOR_TRAFFIC_REPORT"; readonly reportOptions: { readonly reportPeriod: "WEEK"; }; readonly lastUpdatedDate: "2021-06-20"; readonly dataStartTime: "2021-06-06"; readonly dataEndTime: "2021-06-19"; readonly marketplaceIds: readonly ["ATVPDKIKX0DER"]; }]; readonly required: readonly ["reportType", "reportOptions", "lastUpdatedDate", "dataStartTime", "dataEndTime", "marketplaceIds"]; readonly properties: { readonly reportType: { readonly type: "string"; readonly description: "The type of report."; readonly enum: readonly ["GET_VENDOR_TRAFFIC_REPORT"]; }; readonly reportOptions: { readonly type: "object"; readonly description: "Report options specifying parameters such as reportPeriod."; readonly examples: readonly [{ readonly reportPeriod: "WEEK"; }]; readonly required: readonly ["reportPeriod"]; readonly properties: { readonly reportPeriod: { readonly type: "string"; readonly description: "The granularity of the data in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR."; readonly enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"]; }; }; }; readonly lastUpdatedDate: { readonly type: "string"; readonly format: "date"; readonly description: "The date when the report was last updated. Follows the ISO 8601 date format of YYYY-MM-DD."; readonly examples: readonly ["2021-06-20"]; }; readonly dataStartTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod or else a fatal error is returned. For example, dataStartTime must be a Sunday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-06"]; }; readonly dataEndTime: { readonly type: "string"; readonly format: "date"; readonly description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod or else a fatal error is returned. For example, dataEndTime must be a Saturday for the WEEK reportPeriod."; readonly examples: readonly ["2021-06-19"]; }; readonly marketplaceIds: { readonly type: "array"; readonly description: "This parameter must match the marketplaceId of the selling partner account (each selling partner account belongs to one and only one marketplaceId)."; readonly examples: readonly [readonly ["ATVPDKIKX0DER"]]; readonly items: { readonly type: "string"; }; }; }; }; readonly trafficAggregate: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/TrafficAggregate"; }; }; readonly trafficByAsin: { readonly type: "array"; readonly items: { readonly $ref: "#/definitions/TrafficByAsin"; }; }; }; readonly definitions: { readonly TrafficAggregate: { readonly type: "object"; readonly description: "Describes aggregated traffic metrics for ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly glanceViews: 100; }]; readonly required: readonly ["startDate", "endDate", "glanceViews"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly format: "date"; readonly description: "The start date of the aggregated data."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly format: "date"; readonly description: "The end date of the aggregated data."; readonly examples: readonly ["2021-06-12"]; }; readonly glanceViews: { readonly type: "integer"; readonly minimum: 0; readonly description: "Customer views of the vendor's product detail pages."; readonly examples: readonly [100]; }; }; }; readonly TrafficByAsin: { readonly type: "object"; readonly description: "Describes aggregated ASIN-level traffic metrics for ASINs in the vendor's account."; readonly examples: readonly [{ readonly startDate: "2021-06-06"; readonly endDate: "2021-06-12"; readonly asin: "B123456789"; readonly glanceViews: 100; }]; readonly required: readonly ["startDate", "endDate", "asin", "glanceViews"]; readonly properties: { readonly startDate: { readonly type: "string"; readonly description: "The start date of the aggregated ASIN-level data."; readonly examples: readonly ["2021-06-06"]; }; readonly endDate: { readonly type: "string"; readonly description: "The end date of the aggregated ASIN-level data."; readonly examples: readonly ["2021-06-12"]; }; readonly asin: { readonly type: "string"; readonly description: "The Amazon Standard Identification Number."; readonly examples: readonly ["B123456789"]; }; readonly glanceViews: { readonly type: "integer"; readonly description: "The number of customer views of the product detail page."; readonly minimum: 0; readonly examples: readonly [100]; }; }; }; }; }; type VendorTrafficReport = FromSchema; declare namespace index_d_exports$2 { export { AccountHealthReport20201118, B2bProductOpportunitiesNotYetOnAmazonReport20201119, B2bProductOpportunitiesRecommendedForYouReport20201119, EndUserDataReport, MarketplaceAsinPageViewMetrics, PromotionReport, SellerCouponReport, SellerSalesAndTrafficReport, SellingPartnerMarketBasketAnalysisReport, SellingPartnerRepeatPurchaseReport, SellingPartnerSearchCatalogPerformanceReport, SellingPartnerSearchQueryPerformanceReport, SellingPartnerSearchTermsReport, VendorCouponReport, VendorForecastingReport, VendorInventoryReport, VendorNetPureProductMarginReport, VendorRealTimeInventoryReport, VendorRealTimeSalesReport, VendorRealTimeTrafficReport, VendorSalesReport, VendorTrafficReport, accountHealthReport20201118, b2bProductOpportunitiesNotYetOnAmazonReport20201119, b2bProductOpportunitiesRecommendedForYouReport20201119, endUserDataReport, marketplaceAsinPageViewMetrics, promotionReport, sellerCouponReport, sellerSalesAndTrafficReport, sellingPartnerMarketBasketAnalysisReport, sellingPartnerRepeatPurchaseReport, sellingPartnerSearchCatalogPerformanceReport, sellingPartnerSearchQueryPerformanceReport, sellingPartnerSearchTermsReport, vendorCouponReport, vendorForecastingReport, vendorInventoryReport, vendorNetPureProductMarginReport, vendorRealTimeInventoryReport, vendorRealTimeSalesReport, vendorRealTimeTrafficReport, vendorSalesReport, vendorTrafficReport }; } //#endregion export { index_d_exports as Feeds, index_d_exports$1 as Notifications, index_d_exports$2 as Reports }; //# sourceMappingURL=index.d.cts.map