@sp-api-sdk/schemas

JSON schemas and TypeScript types for the Amazon Selling Partner API (SP-API)

Documentation

Learn more about the Selling Partner API by visiting the official documentation.

Also, see the generated documentation.

Installing

npm install @sp-api-sdk/schemas
Copy

Overview

This package exposes JSON schemas and their corresponding TypeScript types for Selling Partner API Feeds, Notifications, and Reports. These schemas are auto-generated from the official Amazon models.

Each schema is exported as a const object (usable at runtime for validation) along with a TypeScript type (inferred via json-schema-to-ts).

Usage

JSON schema (runtime)

import {Reports} from '@sp-api-sdk/schemas'

// Use the JSON schema for validation
console.log(Reports.vendorInventoryReport)
Copy

TypeScript type

import {Reports} from '@sp-api-sdk/schemas'

const report = (await getVendorInventoryReportData()) as Reports.VendorInventoryReport
Copy

Available Schemas

Feeds (3 schemas)

• listingsFeedMessageSchemaV2 / ListingsFeedMessageSchemaV2
• listingsFeedProcessingReportSchemaV2 / ListingsFeedProcessingReportSchemaV2
• listingsFeedSchemaV2 / ListingsFeedSchemaV2

Notifications (22 schemas)

• anyOfferChangedNotification / AnyOfferChangedNotification
• b2bAnyOfferChangedNotification / B2bAnyOfferChangedNotification
• brandedItemContentChangeNotification / BrandedItemContentChangeNotification
• dataKioskQueryProcessingFinishedNotification / DataKioskQueryProcessingFinishedNotification
• detailPageTrafficEventNotification / DetailPageTrafficEventNotification
• fbaInventoryAvailabilityChangeNotification / FBAInventoryAvailabilityChangeNotification
• fbaOutboundShipmentStatusNotification / FBAOutboundShipmentStatusNotification
• feedProcessingFinishedNotification / FeedProcessingFinishedNotification
• feePromotionNotification / FeePromotionNotification
• fulfillmentOrderStatusNotification / FulfillmentOrderStatusNotification
• itemInventoryEventChangeNotification / ItemInventoryEventChangeNotification
• itemProductTypeChangeNotification / ItemProductTypeChangeNotification
• itemSalesEventChangeNotification / ItemSalesEventChangeNotification
• listingsItemIssuesChangeNotification / ListingsItemIssuesChangeNotification
• listingsItemIssuesChangeNotification20231213 / ListingsItemIssuesChangeNotification20231213
• listingsItemMfnQuantityChange / ListingsItemMfnQuantityChange
• listingsItemStatusChangeNotification / ListingsItemStatusChangeNotification
• orderChangeNotification / OrderChangeNotification
• pricingHealthNotification / PricingHealthNotification
• productTypeDefinitionsChangeNotification / ProductTypeDefinitionsChangeNotification
• reportProcessingFinishedNotification / ReportProcessingFinishedNotification
• transactionUpdateNotification / TransactionUpdateNotification

Reports (22 schemas)

• accountHealthReport20201118 / AccountHealthReport20201118
• b2bProductOpportunitiesNotYetOnAmazonReport20201119 / B2bProductOpportunitiesNotYetOnAmazonReport20201119
• b2bProductOpportunitiesRecommendedForYouReport20201119 / B2bProductOpportunitiesRecommendedForYouReport20201119
• endUserDataReport / EndUserDataReport
• marketplaceAsinPageViewMetrics / MarketplaceAsinPageViewMetrics
• promotionReport / PromotionReport
• sellerCouponReport / SellerCouponReport
• sellerSalesAndTrafficReport / SellerSalesAndTrafficReport
• sellingPartnerMarketBasketAnalysisReport / SellingPartnerMarketBasketAnalysisReport
• sellingPartnerRepeatPurchaseReport / SellingPartnerRepeatPurchaseReport
• sellingPartnerSearchCatalogPerformanceReport / SellingPartnerSearchCatalogPerformanceReport
• sellingPartnerSearchQueryPerformanceReport / SellingPartnerSearchQueryPerformanceReport
• sellingPartnerSearchTermsReport / SellingPartnerSearchTermsReport
• vendorCouponReport / VendorCouponReport
• vendorForecastingReport / VendorForecastingReport
• vendorInventoryReport / VendorInventoryReport
• vendorNetPureProductMarginReport / VendorNetPureProductMarginReport
• vendorRealTimeInventoryReport / VendorRealTimeInventoryReport
• vendorRealTimeSalesReport / VendorRealTimeSalesReport
• vendorRealTimeTrafficReport / VendorRealTimeTrafficReport
• vendorSalesReport / VendorSalesReport
• vendorTrafficReport / VendorTrafficReport

License

MIT

Miscellaneous

    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
Copy