/** * Catalog Items v2022-04-01 * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide). * * The version of the OpenAPI document: 2022-04-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; } /** * Individual dimension value of an Amazon catalog item or item package. * @export * @interface Dimension */ export interface Dimension { /** * Measurement unit of the dimension value. * @type {string} * @memberof Dimension */ unit?: string; /** * Numeric dimension value. * @type {number} * @memberof Dimension */ value?: number; } /** * Dimensions of an Amazon catalog item or item in its packaging. * @export * @interface Dimensions */ export interface Dimensions { /** * * @type {Dimension} * @memberof Dimensions */ height?: Dimension; /** * * @type {Dimension} * @memberof Dimensions */ length?: Dimension; /** * * @type {Dimension} * @memberof Dimensions */ weight?: Dimension; /** * * @type {Dimension} * @memberof Dimensions */ width?: Dimension; } /** * 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 conform to the related product type definitions available in the Selling Partner API for Product Type Definitions. * @type {object} * @memberof Item */ attributes?: object; /** * Array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace. * @type {Array} * @memberof Item */ classifications?: Array; /** * Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace. * @type {Array} * @memberof Item */ dimensions?: Array; /** * 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. * @type {Array} * @memberof Item */ images?: Array; /** * Product types associated with the Amazon catalog item. * @type {Array} * @memberof Item */ productTypes?: Array; /** * Relationships by marketplace for an Amazon catalog item (for example, variations). * @type {Array} * @memberof Item */ relationships?: 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; /** * Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only. * @type {Array} * @memberof Item */ vendorDetails?: Array; } /** * Classification (browse node) associated with an Amazon catalog item. * @export * @interface ItemBrowseClassification */ export interface ItemBrowseClassification { /** * Display name for the classification (browse node). * @type {string} * @memberof ItemBrowseClassification */ displayName: string; /** * Identifier of the classification (browse node identifier). * @type {string} * @memberof ItemBrowseClassification */ classificationId: string; /** * * @type {ItemBrowseClassification} * @memberof ItemBrowseClassification */ parent?: ItemBrowseClassification; } /** * Classifications (browse nodes) associated with the item in the Amazon catalog for the indicated Amazon marketplace. * @export * @interface ItemBrowseClassificationsByMarketplace */ export interface ItemBrowseClassificationsByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemBrowseClassificationsByMarketplace */ marketplaceId: string; /** * Classifications (browse nodes) associated with the item in the Amazon catalog for the indicated Amazon marketplace. * @type {Array} * @memberof ItemBrowseClassificationsByMarketplace */ classifications?: Array; } /** * Sales rank of an Amazon catalog item by classification. * @export * @interface ItemClassificationSalesRank */ export interface ItemClassificationSalesRank { /** * Identifier of the classification associated with the sales rank. * @type {string} * @memberof ItemClassificationSalesRank */ classificationId: string; /** * Title, or name, of the sales rank. * @type {string} * @memberof ItemClassificationSalesRank */ title: string; /** * Corresponding Amazon retail website link, or URL, for the sales rank. * @type {string} * @memberof ItemClassificationSalesRank */ link?: string; /** * Sales rank value. * @type {number} * @memberof ItemClassificationSalesRank */ rank: number; } /** * Individual contributor to the creation of an item, such as an author or actor. * @export * @interface ItemContributor */ export interface ItemContributor { /** * * @type {ItemContributorRole} * @memberof ItemContributor */ role: ItemContributorRole; /** * Name of the contributor, such as Jane Austen. * @type {string} * @memberof ItemContributor */ value: string; } /** * Role of an individual contributor in the creation of an item, such as author or actor. * @export * @interface ItemContributorRole */ export interface ItemContributorRole { /** * Display name of the role in the requested locale, such as Author or Actor. * @type {string} * @memberof ItemContributorRole */ displayName?: string; /** * Role value for the Amazon catalog item, such as author or actor. * @type {string} * @memberof ItemContributorRole */ value: string; } /** * Dimensions associated with the item in the Amazon catalog for the indicated Amazon marketplace. * @export * @interface ItemDimensionsByMarketplace */ export interface ItemDimensionsByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemDimensionsByMarketplace */ marketplaceId: string; /** * * @type {Dimensions} * @memberof ItemDimensionsByMarketplace */ item?: Dimensions; /** * * @type {Dimensions} * @memberof ItemDimensionsByMarketplace */ _package?: Dimensions; } /** * Sales rank of an Amazon catalog item by website display group. * @export * @interface ItemDisplayGroupSalesRank */ export interface ItemDisplayGroupSalesRank { /** * Name of the website display group associated with the sales rank * @type {string} * @memberof ItemDisplayGroupSalesRank */ websiteDisplayGroup: string; /** * Title, or name, of the sales rank. * @type {string} * @memberof ItemDisplayGroupSalesRank */ title: string; /** * Corresponding Amazon retail website link, or URL, for the sales rank. * @type {string} * @memberof ItemDisplayGroupSalesRank */ link?: string; /** * Sales rank value. * @type {number} * @memberof ItemDisplayGroupSalesRank */ rank: number; } /** * 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; } /** * Relationship details for an Amazon catalog item. * @export * @interface ItemRelationship */ export interface ItemRelationship { /** * Identifiers (ASINs) of the related items that are children of this item. * @type {Array} * @memberof ItemRelationship */ childAsins?: Array; /** * Identifiers (ASINs) of the related items that are parents of this item. * @type {Array} * @memberof ItemRelationship */ parentAsins?: Array; /** * * @type {ItemVariationTheme} * @memberof ItemRelationship */ variationTheme?: ItemVariationTheme; /** * Type of relationship. * @type {string} * @memberof ItemRelationship */ type: ItemRelationshipTypeEnum | 'VARIATION' | 'PACKAGE_HIERARCHY'; } /** * @export * @enum {string} */ export declare enum ItemRelationshipTypeEnum { Variation = "VARIATION", PackageHierarchy = "PACKAGE_HIERARCHY" } /** * Relationship details for the Amazon catalog item for the indicated Amazon marketplace. * @export * @interface ItemRelationshipsByMarketplace */ export interface ItemRelationshipsByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemRelationshipsByMarketplace */ marketplaceId: string; /** * Relationships for the item. * @type {Array} * @memberof ItemRelationshipsByMarketplace */ relationships: Array; } /** * 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 by classification. * @type {Array} * @memberof ItemSalesRanksByMarketplace */ classificationRanks?: Array; /** * Sales ranks of an Amazon catalog item for an Amazon marketplace by website display group. * @type {Array} * @memberof ItemSalesRanksByMarketplace */ displayGroupRanks?: Array; } /** * Items in the Amazon catalog and search related metadata. * @export * @interface ItemSearchResults */ export interface ItemSearchResults { /** * For `identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items 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; /** * Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature. * @type {boolean} * @memberof ItemSummaryByMarketplace */ adultProduct?: boolean; /** * Identifies an Amazon catalog item is autographed by a player or celebrity. * @type {boolean} * @memberof ItemSummaryByMarketplace */ autographed?: boolean; /** * Name of the brand associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ brand?: string; /** * * @type {ItemBrowseClassification} * @memberof ItemSummaryByMarketplace */ browseClassification?: ItemBrowseClassification; /** * Name of the color associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ color?: string; /** * Individual contributors to the creation of an item, such as the authors or actors. * @type {Array} * @memberof ItemSummaryByMarketplace */ contributors?: Array; /** * Classification type associated with the Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ itemClassification?: ItemSummaryByMarketplaceItemClassificationEnum | 'BASE_PRODUCT' | 'OTHER' | 'PRODUCT_BUNDLE' | 'VARIATION_PARENT'; /** * 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; /** * Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment. * @type {boolean} * @memberof ItemSummaryByMarketplace */ memorabilia?: boolean; /** * Model number associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ modelNumber?: string; /** * Quantity of an Amazon catalog item in one package. * @type {number} * @memberof ItemSummaryByMarketplace */ packageQuantity?: number; /** * Part number associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ partNumber?: string; /** * First date on which an Amazon catalog item is shippable to customers. * @type {string} * @memberof ItemSummaryByMarketplace */ releaseDate?: string; /** * Name of the size associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ size?: string; /** * Name of the style associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ style?: string; /** * Identifies an Amazon catalog item is eligible for trade-in. * @type {boolean} * @memberof ItemSummaryByMarketplace */ tradeInEligible?: boolean; /** * Identifier of the website display group associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ websiteDisplayGroup?: string; /** * Display name of the website display group associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ websiteDisplayGroupName?: string; } /** * @export * @enum {string} */ export declare enum ItemSummaryByMarketplaceItemClassificationEnum { BaseProduct = "BASE_PRODUCT", Other = "OTHER", ProductBundle = "PRODUCT_BUNDLE", VariationParent = "VARIATION_PARENT" } /** * Variation theme indicating the combination of Amazon item catalog attributes that define the variation family. * @export * @interface ItemVariationTheme */ export interface ItemVariationTheme { /** * Names of the Amazon catalog item attributes associated with the variation theme. * @type {Array} * @memberof ItemVariationTheme */ attributes?: Array; /** * Variation theme indicating the combination of Amazon item catalog attributes that define the variation family. * @type {string} * @memberof ItemVariationTheme */ theme?: string; } /** * 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; /** * 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; /** * * @type {ItemVendorDetailsCategory} * @memberof ItemVendorDetailsByMarketplace */ productCategory?: ItemVendorDetailsCategory; /** * Product group associated with an Amazon catalog item. * @type {string} * @memberof ItemVendorDetailsByMarketplace */ productGroup?: string; /** * * @type {ItemVendorDetailsCategory} * @memberof ItemVendorDetailsByMarketplace */ productSubcategory?: ItemVendorDetailsCategory; /** * 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'; } /** * @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" } /** * Product category or subcategory associated with an Amazon catalog item. * @export * @interface ItemVendorDetailsCategory */ export interface ItemVendorDetailsCategory { /** * Display name of the product category or subcategory * @type {string} * @memberof ItemVendorDetailsCategory */ displayName?: string; /** * Value (code) of the product category or subcategory. * @type {string} * @memberof ItemVendorDetailsCategory */ value?: string; } /** * 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; } /** * CatalogItemsApi - axios parameter creator * @export */ export declare const CatalogItemsApiAxiosParamCreator: (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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary getCatalogItem * @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' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | '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" | "classifications" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails">, locale?: string, options?: any) => Promise; /** * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary searchCatalogItems * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. * @param {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | '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 {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @param {Array} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. * @param {Array} [brandNames] A comma-delimited list of brand names to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @param {Array} [classificationIds] A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @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 of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCatalogItems: (marketplaceIds: Array, identifiers?: Array, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC", includedData?: Array<"attributes" | "classifications" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails">, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any) => Promise; }; /** * CatalogItemsApi - functional programming interface * @export */ export declare const CatalogItemsApiFp: (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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary getCatalogItem * @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' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | '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" | "classifications" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails">, locale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary searchCatalogItems * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. * @param {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | '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 {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @param {Array} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. * @param {Array} [brandNames] A comma-delimited list of brand names to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @param {Array} [classificationIds] A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @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 of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCatalogItems(marketplaceIds: Array, identifiers?: Array, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC", includedData?: Array<"attributes" | "classifications" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails">, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CatalogItemsApi - factory interface * @export */ export declare const CatalogItemsApiFactory: (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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary getCatalogItem * @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' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | '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" | "classifications" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails">, locale?: string, options?: any): AxiosPromise; /** * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary searchCatalogItems * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {Array} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. * @param {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | '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 {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @param {Array} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. * @param {Array} [brandNames] A comma-delimited list of brand names to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @param {Array} [classificationIds] A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @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 of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchCatalogItems(marketplaceIds: Array, identifiers?: Array, identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC", includedData?: Array<"attributes" | "classifications" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails">, locale?: string, sellerId?: string, keywords?: Array, brandNames?: Array, classificationIds?: Array, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: any): AxiosPromise; }; /** * Request parameters for getCatalogItem operation in CatalogItemsApi. * @export * @interface CatalogItemsApiGetCatalogItemRequest */ export interface CatalogItemsApiGetCatalogItemRequest { /** * The Amazon Standard Identification Number (ASIN) of the item. * @type {string} * @memberof CatalogItemsApiGetCatalogItem */ 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 CatalogItemsApiGetCatalogItem */ readonly marketplaceIds: Array; /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} * @memberof CatalogItemsApiGetCatalogItem */ readonly includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>; /** * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @type {string} * @memberof CatalogItemsApiGetCatalogItem */ readonly locale?: string; } /** * Request parameters for searchCatalogItems operation in CatalogItemsApi. * @export * @interface CatalogItemsApiSearchCatalogItemsRequest */ export interface CatalogItemsApiSearchCatalogItemsRequest { /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof CatalogItemsApiSearchCatalogItems */ readonly marketplaceIds: Array; /** * A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`. * @type {Array} * @memberof CatalogItemsApiSearchCatalogItems */ readonly identifiers?: Array; /** * Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided. * @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} * @memberof CatalogItemsApiSearchCatalogItems */ readonly identifiersType?: 'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'; /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} * @memberof CatalogItemsApiSearchCatalogItems */ readonly includedData?: Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>; /** * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. * @type {string} * @memberof CatalogItemsApiSearchCatalogItems */ readonly locale?: string; /** * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`. * @type {string} * @memberof CatalogItemsApiSearchCatalogItems */ readonly sellerId?: string; /** * A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`. * @type {Array} * @memberof CatalogItemsApiSearchCatalogItems */ readonly keywords?: Array; /** * A comma-delimited list of brand names to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @type {Array} * @memberof CatalogItemsApiSearchCatalogItems */ readonly brandNames?: Array; /** * A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`. * @type {Array} * @memberof CatalogItemsApiSearchCatalogItems */ readonly classificationIds?: Array; /** * Number of results to be returned per page. * @type {number} * @memberof CatalogItemsApiSearchCatalogItems */ readonly pageSize?: number; /** * A token to fetch a certain page when there are multiple pages worth of results. * @type {string} * @memberof CatalogItemsApiSearchCatalogItems */ readonly pageToken?: string; /** * The language of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`. * @type {string} * @memberof CatalogItemsApiSearchCatalogItems */ readonly keywordsLocale?: string; } /** * CatalogItemsApi - object-oriented interface * @export * @class CatalogItemsApi * @extends {BaseAPI} */ export declare class CatalogItemsApi 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary getCatalogItem * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogItemsApi */ getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: any): Promise>; /** * Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @summary searchCatalogItems * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CatalogItemsApi */ searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: any): Promise>; }