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

package/dist/types/src/api-model/models/item-variation-theme.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.
+ */
+/**
+ * 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<string>}
+     * @memberof ItemVariationTheme
+     */
+    attributes?: Array<string>;
+    /**
+     * Variation theme indicating the combination of Amazon item catalog attributes that define the variation family.
+     * @type {string}
+     * @memberof ItemVariationTheme
+     */
+    theme?: string;
+}

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

@@ -0,0 +1,83 @@
+/**
+ * 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 { ItemVendorDetailsCategory } from './item-vendor-details-category';
+/**
+ * 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;
+}
+/**
+    * @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"
+}

package/dist/types/src/api-model/models/item-vendor-details-category.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 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;
+}

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

@@ -0,0 +1,86 @@
+/**
+ * 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 { ItemDimensionsByMarketplace } from './item-dimensions-by-marketplace';
+import { ItemIdentifiersByMarketplace } from './item-identifiers-by-marketplace';
+import { ItemImagesByMarketplace } from './item-images-by-marketplace';
+import { ItemProductTypeByMarketplace } from './item-product-type-by-marketplace';
+import { ItemRelationshipsByMarketplace } from './item-relationships-by-marketplace';
+import { ItemSalesRanksByMarketplace } from './item-sales-ranks-by-marketplace';
+import { ItemSummaryByMarketplace } from './item-summary-by-marketplace';
+import { ItemVendorDetailsByMarketplace } from './item-vendor-details-by-marketplace';
+/**
+ * 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;
+    /**
+     *
+     * @type {ItemDimensionsByMarketplace}
+     * @memberof Item
+     */
+    dimensions?: ItemDimensionsByMarketplace;
+    /**
+     * Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.
+     * @type {Array<ItemIdentifiersByMarketplace>}
+     * @memberof Item
+     */
+    identifiers?: Array<ItemIdentifiersByMarketplace>;
+    /**
+     * Images for an item in the Amazon catalog.
+     * @type {Array<ItemImagesByMarketplace>}
+     * @memberof Item
+     */
+    images?: Array<ItemImagesByMarketplace>;
+    /**
+     * Product types associated with the Amazon catalog item.
+     * @type {Array<ItemProductTypeByMarketplace>}
+     * @memberof Item
+     */
+    productTypes?: Array<ItemProductTypeByMarketplace>;
+    /**
+     * Relationships by marketplace for an Amazon catalog item (for example, variations).
+     * @type {Array<ItemRelationshipsByMarketplace>}
+     * @memberof Item
+     */
+    relationships?: Array<ItemRelationshipsByMarketplace>;
+    /**
+     * Sales ranks of an Amazon catalog item.
+     * @type {Array<ItemSalesRanksByMarketplace>}
+     * @memberof Item
+     */
+    salesRanks?: Array<ItemSalesRanksByMarketplace>;
+    /**
+     * Summary details of an Amazon catalog item.
+     * @type {Array<ItemSummaryByMarketplace>}
+     * @memberof Item
+     */
+    summaries?: Array<ItemSummaryByMarketplace>;
+    /**
+     * Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only.
+     * @type {Array<ItemVendorDetailsByMarketplace>}
+     * @memberof Item
+     */
+    vendorDetails?: Array<ItemVendorDetailsByMarketplace>;
+}

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

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

package/dist/types/src/api-model/models/pagination.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.
+ */
+/**
+ * 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;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { BrandRefinement } from './brand-refinement';
+import { ClassificationRefinement } from './classification-refinement';
+/**
+ * Search refinements.
+ * @export
+ * @interface Refinements
+ */
+export interface Refinements {
+    /**
+     * Brand search refinements.
+     * @type {Array<BrandRefinement>}
+     * @memberof Refinements
+     */
+    brands: Array<BrandRefinement>;
+    /**
+     * Classification search refinements.
+     * @type {Array<ClassificationRefinement>}
+     * @memberof Refinements
+     */
+    classifications: Array<ClassificationRefinement>;
+}

package/dist/types/src/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
+import { CatalogApi } from './api-model';
+export declare const clientRateLimits: RateLimit[];
+export declare class CatalogItemsApiClient extends CatalogApi {
+    constructor(configuration: ClientConfiguration);
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@sp-api-sdk/catalog-items-api-2022-04-01",
+  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
+  "description": "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.",
+  "version": "1.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "typedocMain": "./index.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "check:ts": "yarn tsc --noEmit",
+    "build:cjs": "tsc -p tsconfig.json",
+    "build:es": "tsc -p tsconfig.es.json",
+    "build": "yarn build:cjs && yarn build:es",
+    "clean": "rimraf dist",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@sp-api-sdk/auth": "^1.9.17",
+    "@sp-api-sdk/common": "^1.9.3",
+    "axios": "^0.27.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bizon/selling-partner-api-sdk.git",
+    "directory": "clients/catalog-items-api-2022-04-01"
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/catalog-items-api-2022-04-01",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "catalog items api"
+  ],
+  "gitHead": "a91680c9bce217db7412c5ad7c17aa6e918ada8e"
+}