/** * Selling Partner API for Catalog Items * The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * * @export * @interface ASINIdentifier */ export interface ASINIdentifier { /** * A marketplace identifier. * @type {string} * @memberof ASINIdentifier */ MarketplaceId: string; /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof ASINIdentifier */ ASIN: string; } /** * The attributes of the item. * @export * @interface AttributeSetListType */ export interface AttributeSetListType { /** * The actor attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Actor?: Array; /** * The artist attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Artist?: Array; /** * The aspect ratio attribute of the item. * @type {string} * @memberof AttributeSetListType */ AspectRatio?: string; /** * The audience rating attribute of the item. * @type {string} * @memberof AttributeSetListType */ AudienceRating?: string; /** * The author attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Author?: Array; /** * The back finding attribute of the item. * @type {string} * @memberof AttributeSetListType */ BackFinding?: string; /** * The band material type attribute of the item. * @type {string} * @memberof AttributeSetListType */ BandMaterialType?: string; /** * The binding attribute of the item. * @type {string} * @memberof AttributeSetListType */ Binding?: string; /** * The Bluray region attribute of the item. * @type {string} * @memberof AttributeSetListType */ BlurayRegion?: string; /** * The brand attribute of the item. * @type {string} * @memberof AttributeSetListType */ Brand?: string; /** * The CERO age rating attribute of the item. * @type {string} * @memberof AttributeSetListType */ CeroAgeRating?: string; /** * The chain type attribute of the item. * @type {string} * @memberof AttributeSetListType */ ChainType?: string; /** * The clasp type attribute of the item. * @type {string} * @memberof AttributeSetListType */ ClaspType?: string; /** * The color attribute of the item. * @type {string} * @memberof AttributeSetListType */ Color?: string; /** * The CPU manufacturer attribute of the item. * @type {string} * @memberof AttributeSetListType */ CpuManufacturer?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ CpuSpeed?: DecimalWithUnits; /** * The CPU type attribute of the item. * @type {string} * @memberof AttributeSetListType */ CpuType?: string; /** * The creator attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Creator?: Array; /** * The department attribute of the item. * @type {string} * @memberof AttributeSetListType */ Department?: string; /** * The director attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Director?: Array; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ DisplaySize?: DecimalWithUnits; /** * The edition attribute of the item. * @type {string} * @memberof AttributeSetListType */ Edition?: string; /** * The episode sequence attribute of the item. * @type {string} * @memberof AttributeSetListType */ EpisodeSequence?: string; /** * The ESRB age rating attribute of the item. * @type {string} * @memberof AttributeSetListType */ EsrbAgeRating?: string; /** * The feature attributes of the item * @type {Array} * @memberof AttributeSetListType */ Feature?: Array; /** * The flavor attribute of the item. * @type {string} * @memberof AttributeSetListType */ Flavor?: string; /** * The format attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Format?: Array; /** * The gem type attributes of the item. * @type {Array} * @memberof AttributeSetListType */ GemType?: Array; /** * The genre attribute of the item. * @type {string} * @memberof AttributeSetListType */ Genre?: string; /** * The golf club flex attribute of the item. * @type {string} * @memberof AttributeSetListType */ GolfClubFlex?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ GolfClubLoft?: DecimalWithUnits; /** * The hand orientation attribute of the item. * @type {string} * @memberof AttributeSetListType */ HandOrientation?: string; /** * The hard disk interface attribute of the item. * @type {string} * @memberof AttributeSetListType */ HardDiskInterface?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ HardDiskSize?: DecimalWithUnits; /** * The hardware platform attribute of the item. * @type {string} * @memberof AttributeSetListType */ HardwarePlatform?: string; /** * The hazardous material type attribute of the item. * @type {string} * @memberof AttributeSetListType */ HazardousMaterialType?: string; /** * * @type {DimensionType} * @memberof AttributeSetListType */ ItemDimensions?: DimensionType; /** * The adult product attribute of the item. * @type {boolean} * @memberof AttributeSetListType */ IsAdultProduct?: boolean; /** * The autographed attribute of the item. * @type {boolean} * @memberof AttributeSetListType */ IsAutographed?: boolean; /** * The is eligible for trade in attribute of the item. * @type {boolean} * @memberof AttributeSetListType */ IsEligibleForTradeIn?: boolean; /** * The is memorabilia attribute of the item. * @type {boolean} * @memberof AttributeSetListType */ IsMemorabilia?: boolean; /** * The issues per year attribute of the item. * @type {string} * @memberof AttributeSetListType */ IssuesPerYear?: string; /** * The item part number attribute of the item. * @type {string} * @memberof AttributeSetListType */ ItemPartNumber?: string; /** * The label attribute of the item. * @type {string} * @memberof AttributeSetListType */ Label?: string; /** * The languages attribute of the item. * @type {Array} * @memberof AttributeSetListType */ Languages?: Array; /** * The legal disclaimer attribute of the item. * @type {string} * @memberof AttributeSetListType */ LegalDisclaimer?: string; /** * * @type {Price} * @memberof AttributeSetListType */ ListPrice?: Price; /** * The manufacturer attribute of the item. * @type {string} * @memberof AttributeSetListType */ Manufacturer?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ ManufacturerMaximumAge?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ ManufacturerMinimumAge?: DecimalWithUnits; /** * The manufacturer parts warranty description attribute of the item. * @type {string} * @memberof AttributeSetListType */ ManufacturerPartsWarrantyDescription?: string; /** * The material type attributes of the item. * @type {Array} * @memberof AttributeSetListType */ MaterialType?: Array; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ MaximumResolution?: DecimalWithUnits; /** * The media type attributes of the item. * @type {Array} * @memberof AttributeSetListType */ MediaType?: Array; /** * The metal stamp attribute of the item. * @type {string} * @memberof AttributeSetListType */ MetalStamp?: string; /** * The metal type attribute of the item. * @type {string} * @memberof AttributeSetListType */ MetalType?: string; /** * The model attribute of the item. * @type {string} * @memberof AttributeSetListType */ Model?: string; /** * The number of discs attribute of the item. * @type {number} * @memberof AttributeSetListType */ NumberOfDiscs?: number; /** * The number of issues attribute of the item. * @type {number} * @memberof AttributeSetListType */ NumberOfIssues?: number; /** * The number of items attribute of the item. * @type {number} * @memberof AttributeSetListType */ NumberOfItems?: number; /** * The number of pages attribute of the item. * @type {number} * @memberof AttributeSetListType */ NumberOfPages?: number; /** * The number of tracks attribute of the item. * @type {number} * @memberof AttributeSetListType */ NumberOfTracks?: number; /** * The operating system attributes of the item. * @type {Array} * @memberof AttributeSetListType */ OperatingSystem?: Array; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ OpticalZoom?: DecimalWithUnits; /** * * @type {DimensionType} * @memberof AttributeSetListType */ PackageDimensions?: DimensionType; /** * The package quantity attribute of the item. * @type {number} * @memberof AttributeSetListType */ PackageQuantity?: number; /** * The part number attribute of the item. * @type {string} * @memberof AttributeSetListType */ PartNumber?: string; /** * The PEGI rating attribute of the item. * @type {string} * @memberof AttributeSetListType */ PegiRating?: string; /** * The platform attributes of the item. * @type {Array} * @memberof AttributeSetListType */ Platform?: Array; /** * The processor count attribute of the item. * @type {number} * @memberof AttributeSetListType */ ProcessorCount?: number; /** * The product group attribute of the item. * @type {string} * @memberof AttributeSetListType */ ProductGroup?: string; /** * The product type name attribute of the item. * @type {string} * @memberof AttributeSetListType */ ProductTypeName?: string; /** * The product type subcategory attribute of the item. * @type {string} * @memberof AttributeSetListType */ ProductTypeSubcategory?: string; /** * The publication date attribute of the item. * @type {string} * @memberof AttributeSetListType */ PublicationDate?: string; /** * The publisher attribute of the item. * @type {string} * @memberof AttributeSetListType */ Publisher?: string; /** * The region code attribute of the item. * @type {string} * @memberof AttributeSetListType */ RegionCode?: string; /** * The release date attribute of the item. * @type {string} * @memberof AttributeSetListType */ ReleaseDate?: string; /** * The ring size attribute of the item. * @type {string} * @memberof AttributeSetListType */ RingSize?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ RunningTime?: DecimalWithUnits; /** * The shaft material attribute of the item. * @type {string} * @memberof AttributeSetListType */ ShaftMaterial?: string; /** * The scent attribute of the item. * @type {string} * @memberof AttributeSetListType */ Scent?: string; /** * The season sequence attribute of the item. * @type {string} * @memberof AttributeSetListType */ SeasonSequence?: string; /** * The Seikodo product code attribute of the item. * @type {string} * @memberof AttributeSetListType */ SeikodoProductCode?: string; /** * The size attribute of the item. * @type {string} * @memberof AttributeSetListType */ Size?: string; /** * The size per pearl attribute of the item. * @type {string} * @memberof AttributeSetListType */ SizePerPearl?: string; /** * * @type {Image} * @memberof AttributeSetListType */ SmallImage?: Image; /** * The studio attribute of the item. * @type {string} * @memberof AttributeSetListType */ Studio?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ SubscriptionLength?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ SystemMemorySize?: DecimalWithUnits; /** * The system memory type attribute of the item. * @type {string} * @memberof AttributeSetListType */ SystemMemoryType?: string; /** * The theatrical release date attribute of the item. * @type {string} * @memberof AttributeSetListType */ TheatricalReleaseDate?: string; /** * The title attribute of the item. * @type {string} * @memberof AttributeSetListType */ Title?: string; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ TotalDiamondWeight?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof AttributeSetListType */ TotalGemWeight?: DecimalWithUnits; /** * The warranty attribute of the item. * @type {string} * @memberof AttributeSetListType */ Warranty?: string; /** * * @type {Price} * @memberof AttributeSetListType */ WeeeTaxValue?: Price; } /** * * @export * @interface Categories */ export interface Categories { /** * The identifier for the product category (or browse node). * @type {string} * @memberof Categories */ ProductCategoryId?: string; /** * The name of the product category (or browse node). * @type {string} * @memberof Categories */ ProductCategoryName?: string; /** * The parent product category. * @type {object} * @memberof Categories */ parent?: object; } /** * The creator type attribute of an item. * @export * @interface CreatorType */ export interface CreatorType { /** * The value of the attribute. * @type {string} * @memberof CreatorType */ value?: string; /** * The role of the value. * @type {string} * @memberof CreatorType */ Role?: string; } /** * The decimal value and unit. * @export * @interface DecimalWithUnits */ export interface DecimalWithUnits { /** * The decimal value. * @type {number} * @memberof DecimalWithUnits */ value?: number; /** * The unit of the decimal value. * @type {string} * @memberof DecimalWithUnits */ Units?: string; } /** * The dimension type attribute of an item. * @export * @interface DimensionType */ export interface DimensionType { /** * * @type {DecimalWithUnits} * @memberof DimensionType */ Height?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof DimensionType */ Length?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof DimensionType */ Width?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof DimensionType */ Weight?: DecimalWithUnits; } /** * * @export * @interface GetCatalogItemResponse */ export interface GetCatalogItemResponse { /** * * @type {Item} * @memberof GetCatalogItemResponse */ payload?: Item; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetCatalogItemResponse */ errors?: Array; } /** * * @export * @interface IdentifierType */ export interface IdentifierType { /** * * @type {ASINIdentifier} * @memberof IdentifierType */ MarketplaceASIN?: ASINIdentifier; /** * * @type {SellerSKUIdentifier} * @memberof IdentifierType */ SKUIdentifier?: SellerSKUIdentifier; } /** * The image attribute of the item. * @export * @interface Image */ export interface Image { /** * The image URL attribute of the item. * @type {string} * @memberof Image */ URL?: string; /** * * @type {DecimalWithUnits} * @memberof Image */ Height?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof Image */ Width?: DecimalWithUnits; } /** * An item in the Amazon catalog. * @export * @interface Item */ export interface Item { /** * * @type {IdentifierType} * @memberof Item */ Identifiers: IdentifierType; /** * A list of attributes for the item. * @type {Array} * @memberof Item */ AttributeSets?: Array; /** * A list of variation relationship information, if applicable for the item. * @type {Array} * @memberof Item */ Relationships?: Array; /** * A list of sales rank information for the item by category. * @type {Array} * @memberof Item */ SalesRankings?: Array; } /** * The language type attribute of an item. * @export * @interface LanguageType */ export interface LanguageType { /** * The name attribute of the item. * @type {string} * @memberof LanguageType */ Name?: string; /** * The type attribute of the item. * @type {string} * @memberof LanguageType */ Type?: string; /** * The audio format attribute of the item. * @type {string} * @memberof LanguageType */ AudioFormat?: string; } /** * * @export * @interface ListCatalogCategoriesResponse */ export interface ListCatalogCategoriesResponse { /** * * @type {Array} * @memberof ListCatalogCategoriesResponse */ payload?: Array; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof ListCatalogCategoriesResponse */ errors?: Array; } /** * * @export * @interface ListCatalogItemsResponse */ export interface ListCatalogItemsResponse { /** * * @type {ListMatchingItemsResponse} * @memberof ListCatalogItemsResponse */ payload?: ListMatchingItemsResponse; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof ListCatalogItemsResponse */ errors?: Array; } /** * * @export * @interface ListMatchingItemsResponse */ export interface ListMatchingItemsResponse { /** * A list of items. * @type {Array} * @memberof ListMatchingItemsResponse */ Items?: Array; } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition in a human-readable form. * @type {string} * @memberof ModelError */ message: string; /** * Additional information that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The price attribute of the item. * @export * @interface Price */ export interface Price { /** * The amount. * @type {number} * @memberof Price */ Amount?: number; /** * The currency code of the amount. * @type {string} * @memberof Price */ CurrencyCode?: string; } /** * Specific variations of the item. * @export * @interface RelationshipType */ export interface RelationshipType { /** * * @type {IdentifierType} * @memberof RelationshipType */ Identifiers?: IdentifierType; /** * The color variation of the item. * @type {string} * @memberof RelationshipType */ Color?: string; /** * The edition variation of the item. * @type {string} * @memberof RelationshipType */ Edition?: string; /** * The flavor variation of the item. * @type {string} * @memberof RelationshipType */ Flavor?: string; /** * The gem type variations of the item. * @type {Array} * @memberof RelationshipType */ GemType?: Array; /** * The golf club flex variation of an item. * @type {string} * @memberof RelationshipType */ GolfClubFlex?: string; /** * The hand orientation variation of an item. * @type {string} * @memberof RelationshipType */ HandOrientation?: string; /** * The hardware platform variation of an item. * @type {string} * @memberof RelationshipType */ HardwarePlatform?: string; /** * The material type variations of an item. * @type {Array} * @memberof RelationshipType */ MaterialType?: Array; /** * The metal type variation of an item. * @type {string} * @memberof RelationshipType */ MetalType?: string; /** * The model variation of an item. * @type {string} * @memberof RelationshipType */ Model?: string; /** * The operating system variations of an item. * @type {Array} * @memberof RelationshipType */ OperatingSystem?: Array; /** * The product type subcategory variation of an item. * @type {string} * @memberof RelationshipType */ ProductTypeSubcategory?: string; /** * The ring size variation of an item. * @type {string} * @memberof RelationshipType */ RingSize?: string; /** * The shaft material variation of an item. * @type {string} * @memberof RelationshipType */ ShaftMaterial?: string; /** * The scent variation of an item. * @type {string} * @memberof RelationshipType */ Scent?: string; /** * The size variation of an item. * @type {string} * @memberof RelationshipType */ Size?: string; /** * The size per pearl variation of an item. * @type {string} * @memberof RelationshipType */ SizePerPearl?: string; /** * * @type {DecimalWithUnits} * @memberof RelationshipType */ GolfClubLoft?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof RelationshipType */ TotalDiamondWeight?: DecimalWithUnits; /** * * @type {DecimalWithUnits} * @memberof RelationshipType */ TotalGemWeight?: DecimalWithUnits; /** * The package quantity variation of an item. * @type {number} * @memberof RelationshipType */ PackageQuantity?: number; /** * * @type {DimensionType} * @memberof RelationshipType */ ItemDimensions?: DimensionType; } /** * * @export * @interface SalesRankType */ export interface SalesRankType { /** * Identifies the item category from which the sales rank is taken. * @type {string} * @memberof SalesRankType */ ProductCategoryId: string; /** * The sales rank of the item within the item category. * @type {number} * @memberof SalesRankType */ Rank: number; } /** * * @export * @interface SellerSKUIdentifier */ export interface SellerSKUIdentifier { /** * A marketplace identifier. * @type {string} * @memberof SellerSKUIdentifier */ MarketplaceId: string; /** * The seller identifier submitted for the operation. * @type {string} * @memberof SellerSKUIdentifier */ SellerId: string; /** * The seller stock keeping unit (SKU) of the item. * @type {string} * @memberof SellerSKUIdentifier */ SellerSKU: string; } /** * CatalogApi - axios parameter creator * @export */ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => { /** * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item. * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCatalogItem: (marketplaceId: string, asin: string, options?: any) => Promise; /** * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item. * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item. * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogCategories: (marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: any) => Promise; /** * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which items are returned. * @param {string} [query] Keyword(s) to use to search for items in the catalog. Example: \'harry potter books\'. * @param {string} [queryContextId] An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. * @param {string} [sellerSKU] Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {string} [uPC] A 12-digit bar code used for retail packaging. * @param {string} [eAN] A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. * @param {string} [iSBN] The unique commercial book identifier used to identify books internationally. * @param {string} [jAN] A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogItems: (marketplaceId: string, query?: string, queryContextId?: string, sellerSKU?: string, uPC?: string, eAN?: string, iSBN?: string, jAN?: string, options?: any) => Promise; }; /** * CatalogApi - functional programming interface * @export */ export declare const CatalogApiFp: (configuration?: Configuration) => { /** * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item. * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCatalogItem(marketplaceId: string, asin: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item. * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item. * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogCategories(marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which items are returned. * @param {string} [query] Keyword(s) to use to search for items in the catalog. Example: \'harry potter books\'. * @param {string} [queryContextId] An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. * @param {string} [sellerSKU] Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {string} [uPC] A 12-digit bar code used for retail packaging. * @param {string} [eAN] A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. * @param {string} [iSBN] The unique commercial book identifier used to identify books internationally. * @param {string} [jAN] A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogItems(marketplaceId: string, query?: string, queryContextId?: string, sellerSKU?: string, uPC?: string, eAN?: string, iSBN?: string, jAN?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CatalogApi - factory interface * @export */ export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item. * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCatalogItem(marketplaceId: string, asin: string, options?: any): AxiosPromise; /** * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for the item. * @param {string} [aSIN] The Amazon Standard Identification Number (ASIN) of the item. * @param {string} [sellerSKU] Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogCategories(marketplaceId: string, aSIN?: string, sellerSKU?: string, options?: any): AxiosPromise; /** * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which items are returned. * @param {string} [query] Keyword(s) to use to search for items in the catalog. Example: \'harry potter books\'. * @param {string} [queryContextId] An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. * @param {string} [sellerSKU] Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {string} [uPC] A 12-digit bar code used for retail packaging. * @param {string} [eAN] A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. * @param {string} [iSBN] The unique commercial book identifier used to identify books internationally. * @param {string} [jAN] A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCatalogItems(marketplaceId: string, query?: string, queryContextId?: string, sellerSKU?: string, uPC?: string, eAN?: string, iSBN?: string, jAN?: string, options?: any): AxiosPromise; }; /** * Request parameters for getCatalogItem operation in CatalogApi. * @export * @interface CatalogApiGetCatalogItemRequest */ export interface CatalogApiGetCatalogItemRequest { /** * A marketplace identifier. Specifies the marketplace for the item. * @type {string} * @memberof CatalogApiGetCatalogItem */ readonly marketplaceId: string; /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof CatalogApiGetCatalogItem */ readonly asin: string; } /** * Request parameters for listCatalogCategories operation in CatalogApi. * @export * @interface CatalogApiListCatalogCategoriesRequest */ export interface CatalogApiListCatalogCategoriesRequest { /** * A marketplace identifier. Specifies the marketplace for the item. * @type {string} * @memberof CatalogApiListCatalogCategories */ readonly marketplaceId: string; /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof CatalogApiListCatalogCategories */ readonly aSIN?: string; /** * Used to identify items in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @type {string} * @memberof CatalogApiListCatalogCategories */ readonly sellerSKU?: string; } /** * Request parameters for listCatalogItems operation in CatalogApi. * @export * @interface CatalogApiListCatalogItemsRequest */ export interface CatalogApiListCatalogItemsRequest { /** * A marketplace identifier. Specifies the marketplace for which items are returned. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly marketplaceId: string; /** * Keyword(s) to use to search for items in the catalog. Example: \'harry potter books\'. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly query?: string; /** * An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly queryContextId?: string; /** * Used to identify an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly sellerSKU?: string; /** * A 12-digit bar code used for retail packaging. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly uPC?: string; /** * A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly eAN?: string; /** * The unique commercial book identifier used to identify books internationally. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly iSBN?: string; /** * A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. * @type {string} * @memberof CatalogApiListCatalogItems */ readonly jAN?: string; } /** * CatalogApi - object-oriented interface * @export * @class CatalogApi * @extends {BaseAPI} */ export declare class CatalogApi extends BaseAPI { /** * Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on this operation should migrate to the latest version to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogApi */ getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: any): Promise>; /** * Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CatalogApiListCatalogCategoriesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogApi */ listCatalogCategories(requestParameters: CatalogApiListCatalogCategoriesRequest, options?: any): Promise>; /** * Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of the [Selling Partner API for Catalog Items v2022-04-01](doc:catalog-items-api-v2022-04-01-reference). Integrations that rely on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to make calls to it. * @param {CatalogApiListCatalogItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogApi */ listCatalogItems(requestParameters: CatalogApiListCatalogItemsRequest, options?: any): Promise>; }