/** * Selling Partner API for Catalog Items * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, see the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2020-12-01-use-case-guide). * * The version of the OpenAPI document: 2020-12-01 * * * 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'; /** * Description of a brand that can be used to get more fine-grained search results. * @export * @interface BrandRefinement */ export interface BrandRefinement { /** * The estimated number of results that would still be returned if refinement key applied. * @type {number} * @memberof BrandRefinement */ numberOfResults: number; /** * Brand name. For display and can be used as a search refinement. * @type {string} * @memberof BrandRefinement */ brandName: string; } /** * Description of a classification that can be used to get more fine-grained search results. * @export * @interface ClassificationRefinement */ export interface ClassificationRefinement { /** * The estimated number of results that would still be returned if refinement key applied. * @type {number} * @memberof ClassificationRefinement */ numberOfResults: number; /** * Display name for the classification. * @type {string} * @memberof ClassificationRefinement */ displayName: string; /** * Identifier for the classification that can be used for search refinement purposes. * @type {string} * @memberof ClassificationRefinement */ classificationId: string; } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * * @type {Array} * @memberof ErrorList */ errors: Array; } /** * An item in the Amazon catalog. * @export * @interface Item */ export interface Item { /** * Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog. * @type {string} * @memberof Item */ asin: string; /** * A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners and conform to the related product type definitions available in the Selling Partner API for Product Type Definitions. * @type {object} * @memberof Item */ attributes?: object; /** * Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers. * @type {Array} * @memberof Item */ identifiers?: Array; /** * Images for an item in the Amazon catalog. All image variants are provided to brand owners. Otherwise, a thumbnail of the \"MAIN\" image variant is provided. * @type {Array} * @memberof Item */ images?: Array; /** * Product types associated with the Amazon catalog item. * @type {Array} * @memberof Item */ productTypes?: Array; /** * Sales ranks of an Amazon catalog item. * @type {Array} * @memberof Item */ salesRanks?: Array; /** * Summary details of an Amazon catalog item. * @type {Array} * @memberof Item */ summaries?: Array; /** * Variation details by marketplace for an Amazon catalog item (variation relationships). * @type {Array} * @memberof Item */ variations?: Array; /** * Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only. * @type {Array} * @memberof Item */ vendorDetails?: Array; } /** * Identifier associated with the item in the Amazon catalog, such as a UPC or EAN identifier. * @export * @interface ItemIdentifier */ export interface ItemIdentifier { /** * Type of identifier, such as UPC, EAN, or ISBN. * @type {string} * @memberof ItemIdentifier */ identifierType: string; /** * Identifier. * @type {string} * @memberof ItemIdentifier */ identifier: string; } /** * Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace. * @export * @interface ItemIdentifiersByMarketplace */ export interface ItemIdentifiersByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemIdentifiersByMarketplace */ marketplaceId: string; /** * Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace. * @type {Array} * @memberof ItemIdentifiersByMarketplace */ identifiers: Array; } /** * Image for an item in the Amazon catalog. * @export * @interface ItemImage */ export interface ItemImage { /** * Variant of the image, such as MAIN or PT01. * @type {string} * @memberof ItemImage */ variant: ItemImageVariantEnum | 'MAIN' | 'PT01' | 'PT02' | 'PT03' | 'PT04' | 'PT05' | 'PT06' | 'PT07' | 'PT08' | 'SWCH'; /** * Link, or URL, for the image. * @type {string} * @memberof ItemImage */ link: string; /** * Height of the image in pixels. * @type {number} * @memberof ItemImage */ height: number; /** * Width of the image in pixels. * @type {number} * @memberof ItemImage */ width: number; } /** * @export * @enum {string} */ export declare enum ItemImageVariantEnum { Main = "MAIN", Pt01 = "PT01", Pt02 = "PT02", Pt03 = "PT03", Pt04 = "PT04", Pt05 = "PT05", Pt06 = "PT06", Pt07 = "PT07", Pt08 = "PT08", Swch = "SWCH" } /** * Images for an item in the Amazon catalog for the indicated Amazon marketplace. * @export * @interface ItemImagesByMarketplace */ export interface ItemImagesByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemImagesByMarketplace */ marketplaceId: string; /** * Images for an item in the Amazon catalog for the indicated Amazon marketplace. * @type {Array} * @memberof ItemImagesByMarketplace */ images: Array; } /** * Product type associated with the Amazon catalog item for the indicated Amazon marketplace. * @export * @interface ItemProductTypeByMarketplace */ export interface ItemProductTypeByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemProductTypeByMarketplace */ marketplaceId?: string; /** * Name of the product type associated with the Amazon catalog item. * @type {string} * @memberof ItemProductTypeByMarketplace */ productType?: string; } /** * Sales rank of an Amazon catalog item. * @export * @interface ItemSalesRank */ export interface ItemSalesRank { /** * Title, or name, of the sales rank. * @type {string} * @memberof ItemSalesRank */ title: string; /** * Corresponding Amazon retail website link, or URL, for the sales rank. * @type {string} * @memberof ItemSalesRank */ link?: string; /** * Sales rank value. * @type {number} * @memberof ItemSalesRank */ rank: number; } /** * Sales ranks of an Amazon catalog item for the indicated Amazon marketplace. * @export * @interface ItemSalesRanksByMarketplace */ export interface ItemSalesRanksByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemSalesRanksByMarketplace */ marketplaceId: string; /** * Sales ranks of an Amazon catalog item for an Amazon marketplace. * @type {Array} * @memberof ItemSalesRanksByMarketplace */ ranks: Array; } /** * Items in the Amazon catalog and search related metadata. * @export * @interface ItemSearchResults */ export interface ItemSearchResults { /** * The estimated total number of products matched by the search query (only results up to the page count limit will be returned per request regardless of the number found). Note: The maximum number of items (ASINs) that can be returned and paged through is 1000. * @type {number} * @memberof ItemSearchResults */ numberOfResults: number; /** * * @type {Pagination} * @memberof ItemSearchResults */ pagination: Pagination; /** * * @type {Refinements} * @memberof ItemSearchResults */ refinements: Refinements; /** * A list of items from the Amazon catalog. * @type {Array} * @memberof ItemSearchResults */ items: Array; } /** * Summary details of an Amazon catalog item for the indicated Amazon marketplace. * @export * @interface ItemSummaryByMarketplace */ export interface ItemSummaryByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemSummaryByMarketplace */ marketplaceId: string; /** * Name of the brand associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ brandName?: string; /** * Identifier of the browse node associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ browseNode?: string; /** * Name of the color associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ colorName?: string; /** * Name, or title, associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ itemName?: string; /** * Name of the manufacturer associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ manufacturer?: string; /** * Model number associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ modelNumber?: string; /** * Name of the size associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ sizeName?: string; /** * Name of the style associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ styleName?: string; } /** * Variation details for the Amazon catalog item for the indicated Amazon marketplace. * @export * @interface ItemVariationsByMarketplace */ export interface ItemVariationsByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemVariationsByMarketplace */ marketplaceId: string; /** * Identifiers (ASINs) of the related items. * @type {Array} * @memberof ItemVariationsByMarketplace */ asins: Array; /** * Type of variation relationship of the Amazon catalog item in the request to the related item(s): \"PARENT\" or \"CHILD\". * @type {string} * @memberof ItemVariationsByMarketplace */ variationType: ItemVariationsByMarketplaceVariationTypeEnum | 'PARENT' | 'CHILD'; } /** * @export * @enum {string} */ export declare enum ItemVariationsByMarketplaceVariationTypeEnum { Parent = "PARENT", Child = "CHILD" } /** * Vendor details associated with an Amazon catalog item for the indicated Amazon marketplace. * @export * @interface ItemVendorDetailsByMarketplace */ export interface ItemVendorDetailsByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ marketplaceId: string; /** * Brand code associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ brandCode?: string; /** * Product category associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ categoryCode?: string; /** * Manufacturer code associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ manufacturerCode?: string; /** * Parent vendor code of the manufacturer code. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ manufacturerCodeParent?: string; /** * Product group associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ productGroup?: string; /** * Replenishment category associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ replenishmentCategory?: ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum | 'ALLOCATED' | 'BASIC_REPLENISHMENT' | 'IN_SEASON' | 'LIMITED_REPLENISHMENT' | 'MANUFACTURER_OUT_OF_STOCK' | 'NEW_PRODUCT' | 'NON_REPLENISHABLE' | 'NON_STOCKUPABLE' | 'OBSOLETE' | 'PLANNED_REPLENISHMENT'; /** * Product subcategory associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ subcategoryCode?: string; } /** * @export * @enum {string} */ export declare enum ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum { Allocated = "ALLOCATED", BasicReplenishment = "BASIC_REPLENISHMENT", InSeason = "IN_SEASON", LimitedReplenishment = "LIMITED_REPLENISHMENT", ManufacturerOutOfStock = "MANUFACTURER_OUT_OF_STOCK", NewProduct = "NEW_PRODUCT", NonReplenishable = "NON_REPLENISHABLE", NonStockupable = "NON_STOCKUPABLE", Obsolete = "OBSOLETE", PlannedReplenishment = "PLANNED_REPLENISHMENT" } /** * 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. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object. * @export * @interface Pagination */ export interface Pagination { /** * A token that can be used to fetch the next page. * @type {string} * @memberof Pagination */ nextToken?: string; /** * A token that can be used to fetch the previous page. * @type {string} * @memberof Pagination */ previousToken?: string; } /** * Search refinements. * @export * @interface Refinements */ export interface Refinements { /** * Brand search refinements. * @type {Array} * @memberof Refinements */ brands: Array; /** * Classification search refinements. * @type {Array} * @memberof Refinements */ classifications: Array; } /** * CatalogApi - axios parameter creator * @export */ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @param {Array<'attributes' | 'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCatalogItem: (asin: string, marketplaceIds: Array, includedData?: Array<"attributes" | "identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails">, locale?: string, options?: any) => Promise; /** * Search for and return a list of Amazon catalog items and associated information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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 {Array} keywords A comma-delimited list of words or item identifiers to search the Amazon catalog for. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array<'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. * @param {Array} [brandNames] A comma-delimited list of brand names to limit the search to. * @param {Array} [classificationIds] A comma-delimited list of classification identifiers to limit the search to. * @param {number} [pageSize] Number of results to be returned per page. * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results. * @param {string} [keywordsLocale] The language the keywords are provided in. Defaults to the primary locale of the marketplace. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCatalogItems: (keywords: Array, marketplaceIds: Array, includedData?: Array<"identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails">, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, locale?: string, options?: any) => Promise; }; /** * CatalogApi - functional programming interface * @export */ export declare const CatalogApiFp: (configuration?: Configuration) => { /** * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @param {Array<'attributes' | 'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCatalogItem(asin: string, marketplaceIds: Array, includedData?: Array<"attributes" | "identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails">, locale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for and return a list of Amazon catalog items and associated information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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 {Array} keywords A comma-delimited list of words or item identifiers to search the Amazon catalog for. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array<'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. * @param {Array} [brandNames] A comma-delimited list of brand names to limit the search to. * @param {Array} [classificationIds] A comma-delimited list of classification identifiers to limit the search to. * @param {number} [pageSize] Number of results to be returned per page. * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results. * @param {string} [keywordsLocale] The language the keywords are provided in. Defaults to the primary locale of the marketplace. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCatalogItems(keywords: Array, marketplaceIds: Array, includedData?: Array<"identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails">, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, locale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CatalogApi - factory interface * @export */ export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @param {Array<'attributes' | 'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCatalogItem(asin: string, marketplaceIds: Array, includedData?: Array<"attributes" | "identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails">, locale?: string, options?: any): AxiosPromise; /** * Search for and return a list of Amazon catalog items and associated information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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 {Array} keywords A comma-delimited list of words or item identifiers to search the Amazon catalog for. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array<'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: summaries. * @param {Array} [brandNames] A comma-delimited list of brand names to limit the search to. * @param {Array} [classificationIds] A comma-delimited list of classification identifiers to limit the search to. * @param {number} [pageSize] Number of results to be returned per page. * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results. * @param {string} [keywordsLocale] The language the keywords are provided in. Defaults to the primary locale of the marketplace. * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCatalogItems(keywords: Array, marketplaceIds: Array, includedData?: Array<"identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails">, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, locale?: string, options?: any): AxiosPromise; }; /** * Request parameters for getCatalogItem operation in CatalogApi. * @export * @interface CatalogApiGetCatalogItemRequest */ export interface CatalogApiGetCatalogItemRequest { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof CatalogApiGetCatalogItem */ readonly asin: string; /** * A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. * @type {Array} * @memberof CatalogApiGetCatalogItem */ readonly marketplaceIds: Array; /** * A comma-delimited list of data sets to include in the response. Default: summaries. * @type {Array<'attributes' | 'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} * @memberof CatalogApiGetCatalogItem */ readonly includedData?: Array<'attributes' | 'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>; /** * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @type {string} * @memberof CatalogApiGetCatalogItem */ readonly locale?: string; } /** * Request parameters for searchCatalogItems operation in CatalogApi. * @export * @interface CatalogApiSearchCatalogItemsRequest */ export interface CatalogApiSearchCatalogItemsRequest { /** * A comma-delimited list of words or item identifiers to search the Amazon catalog for. * @type {Array} * @memberof CatalogApiSearchCatalogItems */ readonly keywords: Array; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof CatalogApiSearchCatalogItems */ readonly marketplaceIds: Array; /** * A comma-delimited list of data sets to include in the response. Default: summaries. * @type {Array<'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>} * @memberof CatalogApiSearchCatalogItems */ readonly includedData?: Array<'identifiers' | 'images' | 'productTypes' | 'salesRanks' | 'summaries' | 'variations' | 'vendorDetails'>; /** * A comma-delimited list of brand names to limit the search to. * @type {Array} * @memberof CatalogApiSearchCatalogItems */ readonly brandNames?: Array; /** * A comma-delimited list of classification identifiers to limit the search to. * @type {Array} * @memberof CatalogApiSearchCatalogItems */ readonly classificationIds?: Array; /** * Number of results to be returned per page. * @type {number} * @memberof CatalogApiSearchCatalogItems */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. * @type {string} * @memberof CatalogApiSearchCatalogItems */ readonly pageToken?: string; /** * The language the keywords are provided in. Defaults to the primary locale of the marketplace. * @type {string} * @memberof CatalogApiSearchCatalogItems */ readonly keywordsLocale?: string; /** * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @type {string} * @memberof CatalogApiSearchCatalogItems */ readonly locale?: string; } /** * CatalogApi - object-oriented interface * @export * @class CatalogApi * @extends {BaseAPI} */ export declare class CatalogApi extends BaseAPI { /** * Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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 {CatalogApiGetCatalogItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogApi */ getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: any): Promise>; /** * Search for and return a list of Amazon catalog items and associated information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 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 {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogApi */ searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: any): Promise>; }