@sp-api-sdk/catalog-items-api-2022-04-01
Version:
Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the Catalog Items API Use Case Guide.
1,130 lines (1,083 loc) • 60.3 kB
TypeScript
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
import * as axios from 'axios';
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
interface AWSv4Configuration {
options?: {
region?: string;
service?: string;
};
credentials?: {
accessKeyId?: string;
secretAccessKey?: string;
sessionToken?: string;
};
}
interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
awsv4?: AWSv4Configuration;
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
declare class Configuration {
/**
* parameter for apiKey security
* @param name security name
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*/
username?: string;
/**
* parameter for basic security
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* parameter for aws4 signature security
* @param {Object} AWS4Signature - AWS4 Signature security
* @param {string} options.region - aws region
* @param {string} options.service - name of the service.
* @param {string} credentials.accessKeyId - aws access key id
* @param {string} credentials.secretAccessKey - aws access key
* @param {string} credentials.sessionToken - aws session token
* @memberof Configuration
*/
awsv4?: AWSv4Configuration;
/**
* override base path
*/
basePath?: string;
/**
* override server index
*/
serverIndex?: number;
/**
* base options for axios calls
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param?: ConfigurationParameters);
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
isJsonMime(mime: string): boolean;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
interface RequestArgs {
url: string;
options: RawAxiosRequestConfig;
}
declare class BaseAPI {
protected basePath: string;
protected axios: AxiosInstance;
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* A brand that you can use to refine your search.
*/
interface BrandRefinement {
/**
* The estimated number of results that would be returned if you refine your search by the specified `brandName`.
*/
'numberOfResults': number;
/**
* The brand name that you can use to refine your search.
*/
'brandName': string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* A classification that you can use to refine your search.
*/
interface ClassificationRefinement {
/**
* The estimated number of results that would be returned if you refine your search by the specified `classificationId`.
*/
'numberOfResults': number;
/**
* Display name for the classification.
*/
'displayName': string;
/**
* The identifier of the classification that you can use to refine your search.
*/
'classificationId': string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* The value of an individual dimension for an Amazon catalog item or item package.
*/
interface Dimension {
/**
* Unit of measurement for the dimension value.
*/
'unit'?: string;
/**
* Numeric value of the dimension.
*/
'value'?: number;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Dimensions of an Amazon catalog item or item in its packaging.
*/
interface Dimensions {
'height'?: Dimension;
'length'?: Dimension;
'weight'?: Dimension;
'width'?: Dimension;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* A list of error responses returned when a request is unsuccessful.
*/
interface ErrorList {
/**
* A list of error responses returned when a request is unsuccessful.
*/
'errors': Array<Error>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Classification (browse node) for an Amazon catalog item.
*/
interface ItemBrowseClassification {
/**
* Display name for the classification.
*/
'displayName': string;
/**
* Identifier of the classification.
*/
'classificationId': string;
'parent'?: ItemBrowseClassification;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Classifications (browse nodes) that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
*/
interface ItemBrowseClassificationsByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
/**
* Classifications (browse nodes) that are associated with the item in the Amazon catalog.
*/
'classifications'?: Array<ItemBrowseClassification>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Dimensions that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
*/
interface ItemDimensionsByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
'item'?: Dimensions;
'package'?: Dimensions;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* The identifier that is associated with the item in the Amazon catalog, such as a UPC or EAN identifier.
*/
interface ItemIdentifier {
/**
* Type of identifier, such as UPC, EAN, or ISBN.
*/
'identifierType': string;
/**
* Identifier of the item.
*/
'identifier': string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Identifiers that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
*/
interface ItemIdentifiersByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier.
*/
'marketplaceId': string;
/**
* Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`.
*/
'identifiers': Array<ItemIdentifier>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Image for an item in the Amazon catalog.
*/
interface ItemImage {
/**
* Variant of the image, such as `MAIN` or `PT01`.
*/
'variant': ItemImageVariantEnum;
/**
* URL for the image.
*/
'link': string;
/**
* Height of the image in pixels.
*/
'height': number;
/**
* Width of the image in pixels.
*/
'width': number;
}
declare const ItemImageVariantEnum: {
readonly Main: "MAIN";
readonly Pt01: "PT01";
readonly Pt02: "PT02";
readonly Pt03: "PT03";
readonly Pt04: "PT04";
readonly Pt05: "PT05";
readonly Pt06: "PT06";
readonly Pt07: "PT07";
readonly Pt08: "PT08";
readonly Swch: "SWCH";
};
type ItemImageVariantEnum = typeof ItemImageVariantEnum[keyof typeof ItemImageVariantEnum];
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Images for an item in the Amazon catalog, grouped by `marketplaceId`.
*/
interface ItemImagesByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
/**
* Images for an item in the Amazon catalog, grouped by `marketplaceId`.
*/
'images': Array<ItemImage>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Product type that is associated with the Amazon catalog item, grouped by `marketplaceId`.
*/
interface ItemProductTypeByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId'?: string;
/**
* Name of the product type that is associated with the Amazon catalog item.
*/
'productType'?: string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* The variation theme is a list of Amazon catalog item attributes that define the variation family.
*/
interface ItemVariationTheme {
/**
* Names of the Amazon catalog item attributes that are associated with the variation theme.
*/
'attributes'?: Array<string>;
/**
* Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family.
*/
'theme'?: string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Relationship details for an Amazon catalog item.
*/
interface ItemRelationship {
/**
* ASINs of the related items that are children of this item.
*/
'childAsins'?: Array<string>;
/**
* ASINs of the related items that are parents of this item.
*/
'parentAsins'?: Array<string>;
'variationTheme'?: ItemVariationTheme;
/**
* Type of relationship.
*/
'type': ItemRelationshipTypeEnum;
}
declare const ItemRelationshipTypeEnum: {
readonly Variation: "VARIATION";
readonly PackageHierarchy: "PACKAGE_HIERARCHY";
};
type ItemRelationshipTypeEnum = typeof ItemRelationshipTypeEnum[keyof typeof ItemRelationshipTypeEnum];
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Relationship details for the Amazon catalog item for the specified Amazon `marketplaceId`.
*/
interface ItemRelationshipsByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
/**
* Relationships for the item.
*/
'relationships': Array<ItemRelationship>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Sales rank of an Amazon catalog item.
*/
interface ItemClassificationSalesRank {
/**
* Identifier of the classification that is associated with the sales rank.
*/
'classificationId': string;
/**
* Name of the sales rank.
*/
'title': string;
/**
* Corresponding Amazon retail website URL for the sales category.
*/
'link'?: string;
/**
* Sales rank.
*/
'rank': number;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Sales rank of an Amazon catalog item, grouped by website display group.
*/
interface ItemDisplayGroupSalesRank {
/**
* Name of the website display group that is associated with the sales rank
*/
'websiteDisplayGroup': string;
/**
* Name of the sales rank.
*/
'title': string;
/**
* Corresponding Amazon retail website URL for the sales rank.
*/
'link'?: string;
/**
* Sales rank.
*/
'rank': number;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Sales ranks of an Amazon catalog item, grouped by `marketplaceId`.
*/
interface ItemSalesRanksByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
/**
* Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification.
*/
'classificationRanks'?: Array<ItemClassificationSalesRank>;
/**
* Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group.
*/
'displayGroupRanks'?: Array<ItemDisplayGroupSalesRank>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Role of an individual contributor in the creation of an item, such as author or actor.
*/
interface ItemContributorRole {
/**
* Display name of the role in the requested locale, such as `Author` or `Actor`.
*/
'displayName'?: string;
/**
* Role value for the Amazon catalog item, such as `author` or `actor`.
*/
'value': string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Individual contributor to the creation of an item, such as an author or actor.
*/
interface ItemContributor {
'role': ItemContributorRole;
/**
* Name of the contributor, such as `Jane Austen`.
*/
'value': string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Information about an Amazon catalog item for the indicated `marketplaceId`.
*/
interface ItemSummaryByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
/**
* When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature.
*/
'adultProduct'?: boolean;
/**
* When `true`, the Amazon catalog item is autographed.
*/
'autographed'?: boolean;
/**
* Name of the brand that is associated with the Amazon catalog item.
*/
'brand'?: string;
'browseClassification'?: ItemBrowseClassification;
/**
* The color that is associated with the Amazon catalog item.
*/
'color'?: string;
/**
* Individual contributors to the creation of the item, such as the authors or actors.
*/
'contributors'?: Array<ItemContributor>;
/**
* Classification type that is associated with the Amazon catalog item.
*/
'itemClassification'?: ItemSummaryByMarketplaceItemClassificationEnum;
/**
* The name that is associated with the Amazon catalog item.
*/
'itemName'?: string;
/**
* The name of the manufacturer that is associated with the Amazon catalog item.
*/
'manufacturer'?: string;
/**
* When true, the item is classified as memorabilia.
*/
'memorabilia'?: boolean;
/**
* The model number that is associated with the Amazon catalog item.
*/
'modelNumber'?: string;
/**
* The quantity of the Amazon catalog item within one package.
*/
'packageQuantity'?: number;
/**
* The part number that is associated with the Amazon catalog item.
*/
'partNumber'?: string;
/**
* The earliest date on which the Amazon catalog item can be shipped to customers.
*/
'releaseDate'?: string;
/**
* The name of the size of the Amazon catalog item.
*/
'size'?: string;
/**
* The name of the style that is associated with the Amazon catalog item.
*/
'style'?: string;
/**
* When true, the Amazon catalog item is eligible for trade-in.
*/
'tradeInEligible'?: boolean;
/**
* The identifier of the website display group that is associated with the Amazon catalog item.
*/
'websiteDisplayGroup'?: string;
/**
* The display name of the website display group that is associated with the Amazon catalog item.
*/
'websiteDisplayGroupName'?: string;
}
declare const ItemSummaryByMarketplaceItemClassificationEnum: {
readonly BaseProduct: "BASE_PRODUCT";
readonly Other: "OTHER";
readonly ProductBundle: "PRODUCT_BUNDLE";
readonly VariationParent: "VARIATION_PARENT";
};
type ItemSummaryByMarketplaceItemClassificationEnum = typeof ItemSummaryByMarketplaceItemClassificationEnum[keyof typeof ItemSummaryByMarketplaceItemClassificationEnum];
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* The product category or subcategory that is associated with an Amazon catalog item.
*/
interface ItemVendorDetailsCategory {
/**
* The display name of the product category or subcategory.
*/
'displayName'?: string;
/**
* The code that identifies the product category or subcategory.
*/
'value'?: string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* The vendor details that are associated with an Amazon catalog item for the specified `marketplaceId`.
*/
interface ItemVendorDetailsByMarketplace {
/**
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
*/
'marketplaceId': string;
/**
* The brand code that is associated with an Amazon catalog item.
*/
'brandCode'?: string;
/**
* The manufacturer code that is associated with an Amazon catalog item.
*/
'manufacturerCode'?: string;
/**
* The parent vendor code of the manufacturer code.
*/
'manufacturerCodeParent'?: string;
'productCategory'?: ItemVendorDetailsCategory;
/**
* The product group that is associated with an Amazon catalog item.
*/
'productGroup'?: string;
'productSubcategory'?: ItemVendorDetailsCategory;
/**
* The replenishment category that is associated with an Amazon catalog item.
*/
'replenishmentCategory'?: ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum;
}
declare const ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum: {
readonly Allocated: "ALLOCATED";
readonly BasicReplenishment: "BASIC_REPLENISHMENT";
readonly InSeason: "IN_SEASON";
readonly LimitedReplenishment: "LIMITED_REPLENISHMENT";
readonly ManufacturerOutOfStock: "MANUFACTURER_OUT_OF_STOCK";
readonly NewProduct: "NEW_PRODUCT";
readonly NonReplenishable: "NON_REPLENISHABLE";
readonly NonStockupable: "NON_STOCKUPABLE";
readonly Obsolete: "OBSOLETE";
readonly PlannedReplenishment: "PLANNED_REPLENISHMENT";
};
type ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum = typeof ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum[keyof typeof ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum];
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* An item in the Amazon catalog.
*/
interface Item {
/**
* The unique identifier of an item in the Amazon catalog.
*/
'asin': string;
/**
* A JSON object containing structured item attribute data that is keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions that you can get from the [Product Type Definitions API](https://developer-docs.amazon.com/sp-api/reference/product-type-definitions-v2020-09-01).
*/
'attributes'?: {
[key: string]: any;
};
/**
* An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.
*/
'classifications'?: Array<ItemBrowseClassificationsByMarketplace>;
/**
* An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
*/
'dimensions'?: Array<ItemDimensionsByMarketplace>;
/**
* Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.
*/
'identifiers'?: Array<ItemIdentifiersByMarketplace>;
/**
* The images for an item in the Amazon catalog.
*/
'images'?: Array<ItemImagesByMarketplace>;
/**
* Product types that are associated with the Amazon catalog item.
*/
'productTypes'?: Array<ItemProductTypeByMarketplace>;
/**
* Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).
*/
'relationships'?: Array<ItemRelationshipsByMarketplace>;
/**
* Sales ranks of an Amazon catalog item.
*/
'salesRanks'?: Array<ItemSalesRanksByMarketplace>;
/**
* Summaries of Amazon catalog items.
*/
'summaries'?: Array<ItemSummaryByMarketplace>;
/**
* The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.
*/
'vendorDetails'?: Array<ItemVendorDetailsByMarketplace>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Pagination occurs when a request produces a response that exceeds the `pageSize`. This means that the response is divided into individual pages. To retrieve the next page or the previous page of results, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. There is no `nextToken` in the pagination object on the last page.
*/
interface Pagination {
/**
* A token that you can use to retrieve the next page.
*/
'nextToken'?: string;
/**
* A token that you can use to retrieve the previous page.
*/
'previousToken'?: string;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Optional fields that you can use to refine your search results.
*/
interface Refinements {
/**
* A list of brands you can use to refine your search.
*/
'brands': Array<BrandRefinement>;
/**
* A list of classifications you can use to refine your search.
*/
'classifications': Array<ClassificationRefinement>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Items in the Amazon catalog and search-related metadata.
*/
interface ItemSearchResults {
/**
* For searches that are based on `identifiers`, `numberOfResults` is the total number of Amazon catalog items found. For searches that are based on `keywords`, `numberOfResults` is the estimated total number of Amazon catalog items that are matched by the search query. Only results up to the page count limit are returned per request regardless of the number found. **Note:** The maximum number of items (ASINs) that can be returned and paged through is 1,000.
*/
'numberOfResults': number;
'pagination'?: Pagination;
'refinements'?: Refinements;
/**
* A list of items from the Amazon catalog.
*/
'items': Array<Item>;
}
/**
* Selling Partner API for Catalog Items
* Use the Selling Partner API for Catalog Items to retrieve information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/: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.
*/
/**
* Error response returned when the request is unsuccessful.
*/
interface ModelError {
/**
* An error code that identifies the type of error that occurred.
*/
'code': string;
/**
* A message that describes the error condition.
*/
'message': string;
/**
* Additional details that can help the caller understand or fix the issue.
*/
'details'?: string;
}
/**
* CatalogItemsApi - axios parameter creator
*/
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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
* @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
* @param {string} [locale] The locale for which you want to retrieve 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<string>} [keywords] A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
* @param {Array<string>} [brandNames] A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
* @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
* @param {number} [pageSize] The number of results to include on each page.
* @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results.
* @param {string} [keywordsLocale] The language of the keywords that are included in queries based on `keywords`. 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<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* CatalogItemsApi - functional programming interface
*/
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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
* @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
/**
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
* @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
* @param {string} [locale] The locale for which you want to retrieve 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<string>} [keywords] A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
* @param {Array<string>} [brandNames] A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
* @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
* @param {number} [pageSize] The number of results to include on each page.
* @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results.
* @param {string} [keywordsLocale] The language of the keywords that are included in queries based on `keywords`. 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<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemSearchResults>>;
};
/**
* CatalogItemsApi - factory interface
*/
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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business dema