@sp-api-sdk/catalog-items-api-2022-04-01 1.1.0

package/dist/types/src/api-model/models/item-classification-sales-rank.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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, 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 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;
+}

package/dist/types/src/api-model/models/item-dimension.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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, 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 dimension value of an Amazon catalog item or item package.
+ * @export
+ * @interface ItemDimension
+ */
+export interface ItemDimension {
+    /**
+     * Measurement unit of the dimension value.
+     * @type {string}
+     * @memberof ItemDimension
+     */
+    unit?: string;
+    /**
+     * Numeric dimension value.
+     * @type {number}
+     * @memberof ItemDimension
+     */
+    value?: number;
+}

package/dist/types/src/api-model/models/item-dimensions-by-marketplace.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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, 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.
+ */
+import { ItemDimensions } from './item-dimensions';
+/**
+ * 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 {ItemDimensions}
+     * @memberof ItemDimensionsByMarketplace
+     */
+    item?: ItemDimensions;
+    /**
+     *
+     * @type {ItemDimensions}
+     * @memberof ItemDimensionsByMarketplace
+     */
+    _package?: ItemDimensions;
+}

package/dist/types/src/api-model/models/item-dimensions.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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, 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.
+ */
+import { ItemDimension } from './item-dimension';
+/**
+ * Dimensions of an Amazon catalog item or item in its packaging.
+ * @export
+ * @interface ItemDimensions
+ */
+export interface ItemDimensions {
+    /**
+     *
+     * @type {ItemDimension}
+     * @memberof ItemDimensions
+     */
+    height?: ItemDimension;
+    /**
+     *
+     * @type {ItemDimension}
+     * @memberof ItemDimensions
+     */
+    length?: ItemDimension;
+    /**
+     *
+     * @type {ItemDimension}
+     * @memberof ItemDimensions
+     */
+    weight?: ItemDimension;
+    /**
+     *
+     * @type {ItemDimension}
+     * @memberof ItemDimensions
+     */
+    width?: ItemDimension;
+}

package/dist/types/src/api-model/models/item-display-group-sales-rank.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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, 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 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;
+}

package/dist/types/src/api-model/models/item-identifier.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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, 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.
+ */
+/**
+ * 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;
+}

package/dist/types/src/api-model/models/item-identifiers-by-marketplace.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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, 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.
+ */
+import { ItemIdentifier } from './item-identifier';
+/**
+ * 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<ItemIdentifier>}
+     * @memberof ItemIdentifiersByMarketplace
+     */
+    identifiers: Array<ItemIdentifier>;
+}

package/dist/types/src/api-model/models/item-image.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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, 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.
+ * @export
+ * @interface ItemImage
+ */
+export interface ItemImage {
+    /**
+     * Variant of the image, such as `MAIN` or `PT01`.
+     * @type {string}
+     * @memberof ItemImage
+     */
+    variant: ItemImageVariantEnum;
+    /**
+     * 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"
+}

package/dist/types/src/api-model/models/item-images-by-marketplace.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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, 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.
+ */
+import { ItemImage } from './item-image';
+/**
+ * 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<ItemImage>}
+     * @memberof ItemImagesByMarketplace
+     */
+    images: Array<ItemImage>;
+}

package/dist/types/src/api-model/models/item-product-type-by-marketplace.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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, 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 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;
+}

package/dist/types/src/api-model/models/item-relationship.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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, 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.
+ */
+import { ItemVariationTheme } from './item-variation-theme';
+/**
+ * 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<string>}
+     * @memberof ItemRelationship
+     */
+    childAsins?: Array<string>;
+    /**
+     * Identifiers (ASINs) of the related items that are parents of this item.
+     * @type {Array<string>}
+     * @memberof ItemRelationship
+     */
+    parentAsins?: Array<string>;
+    /**
+     *
+     * @type {ItemVariationTheme}
+     * @memberof ItemRelationship
+     */
+    variationTheme?: ItemVariationTheme;
+    /**
+     * Type of relationship.
+     * @type {string}
+     * @memberof ItemRelationship
+     */
+    type: ItemRelationshipTypeEnum;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ItemRelationshipTypeEnum {
+    Variation = "VARIATION",
+    PackageHierarchy = "PACKAGE_HIERARCHY"
+}

package/dist/types/src/api-model/models/item-relationships-by-marketplace.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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, 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.
+ */
+import { ItemRelationship } from './item-relationship';
+/**
+ * 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<ItemRelationship>}
+     * @memberof ItemRelationshipsByMarketplace
+     */
+    relationships: Array<ItemRelationship>;
+}

package/dist/types/src/api-model/models/item-sales-ranks-by-marketplace.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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, 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.
+ */
+import { ItemClassificationSalesRank } from './item-classification-sales-rank';
+import { ItemDisplayGroupSalesRank } from './item-display-group-sales-rank';
+/**
+ * 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<ItemClassificationSalesRank>}
+     * @memberof ItemSalesRanksByMarketplace
+     */
+    classificationRanks?: Array<ItemClassificationSalesRank>;
+    /**
+     * Sales ranks of an Amazon catalog item for an Amazon marketplace by website display group.
+     * @type {Array<ItemDisplayGroupSalesRank>}
+     * @memberof ItemSalesRanksByMarketplace
+     */
+    displayGroupRanks?: Array<ItemDisplayGroupSalesRank>;
+}

package/dist/types/src/api-model/models/item-search-results.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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, 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.
+ */
+import { Item } from './item';
+import { Pagination } from './pagination';
+import { Refinements } from './refinements';
+/**
+ * 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<Item>}
+     * @memberof ItemSearchResults
+     */
+    items: Array<Item>;
+}

package/dist/types/src/api-model/models/item-summary-by-marketplace.d.ts

@@ -0,0 +1,107 @@
+/**
+ * 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, 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.
+ */
+import { ItemBrowseClassification } from './item-browse-classification';
+/**
+ * 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
+     */
+    brand?: string;
+    /**
+     *
+     * @type {ItemBrowseClassification}
+     * @memberof ItemSummaryByMarketplace
+     */
+    browseClassification?: ItemBrowseClassification;
+    /**
+     * Name of the color associated with an Amazon catalog item.
+     * @type {string}
+     * @memberof ItemSummaryByMarketplace
+     */
+    color?: string;
+    /**
+     * Classification type associated with the Amazon catalog item.
+     * @type {string}
+     * @memberof ItemSummaryByMarketplace
+     */
+    itemClassification?: ItemSummaryByMarketplaceItemClassificationEnum;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Name of the website display group associated with an Amazon catalog item.
+     * @type {string}
+     * @memberof ItemSummaryByMarketplace
+     */
+    websiteDisplayGroup?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ItemSummaryByMarketplaceItemClassificationEnum {
+    BaseProduct = "BASE_PRODUCT",
+    Other = "OTHER",
+    ProductBundle = "PRODUCT_BUNDLE",
+    VariationParent = "VARIATION_PARENT"
+}