@sp-api-sdk/catalog-items-api-2022-04-01 3.1.1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/README.md +2 -2
  2. package/dist/cjs/api-model/api/{catalog-api.js → catalog-items-api.js} +63 -63
  3. package/dist/cjs/api-model/api.js +2 -2
  4. package/dist/cjs/api-model/base.js +1 -1
  5. package/dist/cjs/api-model/common.js +1 -1
  6. package/dist/cjs/api-model/configuration.js +1 -1
  7. package/dist/cjs/api-model/index.js +1 -1
  8. package/dist/cjs/api-model/models/brand-refinement.js +1 -1
  9. package/dist/cjs/api-model/models/classification-refinement.js +1 -1
  10. package/dist/cjs/api-model/models/dimension.js +1 -1
  11. package/dist/cjs/api-model/models/dimensions.js +1 -1
  12. package/dist/cjs/api-model/models/error-list.js +1 -1
  13. package/dist/cjs/api-model/models/item-browse-classification.js +1 -1
  14. package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  15. package/dist/cjs/api-model/models/item-classification-sales-rank.js +1 -1
  16. package/dist/cjs/api-model/models/item-contributor-role.js +1 -1
  17. package/dist/cjs/api-model/models/item-contributor.js +1 -1
  18. package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +1 -1
  19. package/dist/cjs/api-model/models/item-display-group-sales-rank.js +1 -1
  20. package/dist/cjs/api-model/models/item-identifier.js +1 -1
  21. package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +1 -1
  22. package/dist/cjs/api-model/models/item-image.js +1 -1
  23. package/dist/cjs/api-model/models/item-images-by-marketplace.js +1 -1
  24. package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +1 -1
  25. package/dist/cjs/api-model/models/item-relationship.js +1 -1
  26. package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +1 -1
  27. package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  28. package/dist/cjs/api-model/models/item-search-results.js +1 -1
  29. package/dist/cjs/api-model/models/item-summary-by-marketplace.js +1 -1
  30. package/dist/cjs/api-model/models/item-variation-theme.js +1 -1
  31. package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  32. package/dist/cjs/api-model/models/item-vendor-details-category.js +1 -1
  33. package/dist/cjs/api-model/models/item.js +1 -1
  34. package/dist/cjs/api-model/models/model-error.js +1 -1
  35. package/dist/cjs/api-model/models/pagination.js +1 -1
  36. package/dist/cjs/api-model/models/refinements.js +1 -1
  37. package/dist/cjs/client.js +5 -5
  38. package/dist/es/api-model/api/{catalog-api.js → catalog-items-api.js} +58 -58
  39. package/dist/es/api-model/api.js +2 -2
  40. package/dist/es/api-model/base.js +1 -1
  41. package/dist/es/api-model/common.js +1 -1
  42. package/dist/es/api-model/configuration.js +1 -1
  43. package/dist/es/api-model/index.js +1 -1
  44. package/dist/es/api-model/models/brand-refinement.js +1 -1
  45. package/dist/es/api-model/models/classification-refinement.js +1 -1
  46. package/dist/es/api-model/models/dimension.js +1 -1
  47. package/dist/es/api-model/models/dimensions.js +1 -1
  48. package/dist/es/api-model/models/error-list.js +1 -1
  49. package/dist/es/api-model/models/item-browse-classification.js +1 -1
  50. package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  51. package/dist/es/api-model/models/item-classification-sales-rank.js +1 -1
  52. package/dist/es/api-model/models/item-contributor-role.js +1 -1
  53. package/dist/es/api-model/models/item-contributor.js +1 -1
  54. package/dist/es/api-model/models/item-dimensions-by-marketplace.js +1 -1
  55. package/dist/es/api-model/models/item-display-group-sales-rank.js +1 -1
  56. package/dist/es/api-model/models/item-identifier.js +1 -1
  57. package/dist/es/api-model/models/item-identifiers-by-marketplace.js +1 -1
  58. package/dist/es/api-model/models/item-image.js +1 -1
  59. package/dist/es/api-model/models/item-images-by-marketplace.js +1 -1
  60. package/dist/es/api-model/models/item-product-type-by-marketplace.js +1 -1
  61. package/dist/es/api-model/models/item-relationship.js +1 -1
  62. package/dist/es/api-model/models/item-relationships-by-marketplace.js +1 -1
  63. package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  64. package/dist/es/api-model/models/item-search-results.js +1 -1
  65. package/dist/es/api-model/models/item-summary-by-marketplace.js +1 -1
  66. package/dist/es/api-model/models/item-variation-theme.js +1 -1
  67. package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  68. package/dist/es/api-model/models/item-vendor-details-category.js +1 -1
  69. package/dist/es/api-model/models/item.js +1 -1
  70. package/dist/es/api-model/models/model-error.js +1 -1
  71. package/dist/es/api-model/models/pagination.js +1 -1
  72. package/dist/es/api-model/models/refinements.js +1 -1
  73. package/dist/es/client.js +6 -6
  74. package/dist/types/api-model/api/catalog-items-api.d.ts +285 -0
  75. package/dist/types/api-model/api.d.ts +2 -2
  76. package/dist/types/api-model/base.d.ts +1 -1
  77. package/dist/types/api-model/common.d.ts +1 -1
  78. package/dist/types/api-model/configuration.d.ts +1 -1
  79. package/dist/types/api-model/index.d.ts +1 -1
  80. package/dist/types/api-model/models/brand-refinement.d.ts +4 -4
  81. package/dist/types/api-model/models/classification-refinement.d.ts +4 -4
  82. package/dist/types/api-model/models/dimension.d.ts +4 -4
  83. package/dist/types/api-model/models/dimensions.d.ts +1 -1
  84. package/dist/types/api-model/models/error-list.d.ts +1 -1
  85. package/dist/types/api-model/models/item-browse-classification.d.ts +4 -4
  86. package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +4 -4
  87. package/dist/types/api-model/models/item-classification-sales-rank.d.ts +6 -6
  88. package/dist/types/api-model/models/item-contributor-role.d.ts +3 -3
  89. package/dist/types/api-model/models/item-contributor.d.ts +2 -2
  90. package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +3 -3
  91. package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +6 -6
  92. package/dist/types/api-model/models/item-identifier.d.ts +3 -3
  93. package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +4 -4
  94. package/dist/types/api-model/models/item-image.d.ts +2 -2
  95. package/dist/types/api-model/models/item-images-by-marketplace.d.ts +4 -4
  96. package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +4 -4
  97. package/dist/types/api-model/models/item-relationship.d.ts +3 -3
  98. package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +3 -3
  99. package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +5 -5
  100. package/dist/types/api-model/models/item-search-results.d.ts +3 -3
  101. package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +21 -21
  102. package/dist/types/api-model/models/item-variation-theme.d.ts +4 -4
  103. package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +8 -8
  104. package/dist/types/api-model/models/item-vendor-details-category.d.ts +4 -4
  105. package/dist/types/api-model/models/item.d.ts +10 -10
  106. package/dist/types/api-model/models/model-error.d.ts +1 -1
  107. package/dist/types/api-model/models/pagination.d.ts +4 -4
  108. package/dist/types/api-model/models/refinements.d.ts +4 -4
  109. package/dist/types/client.d.ts +2 -2
  110. package/package.json +5 -5
  111. package/dist/types/api-model/api/catalog-api.d.ts +0 -285
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * 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).
3
+ * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -11,31 +11,31 @@
11
11
  */
12
12
  import type { ItemVendorDetailsCategory } from './item-vendor-details-category';
13
13
  /**
14
- * Vendor details associated with an Amazon catalog item for the indicated Amazon marketplace.
14
+ * The vendor details that are associated with an Amazon catalog item for the specified `marketplaceId`.
15
15
  * @export
16
16
  * @interface ItemVendorDetailsByMarketplace
17
17
  */
18
18
  export interface ItemVendorDetailsByMarketplace {
19
19
  /**
20
- * Amazon marketplace identifier.
20
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
21
21
  * @type {string}
22
22
  * @memberof ItemVendorDetailsByMarketplace
23
23
  */
24
24
  'marketplaceId': string;
25
25
  /**
26
- * Brand code associated with an Amazon catalog item.
26
+ * The brand code that is associated with an Amazon catalog item.
27
27
  * @type {string}
28
28
  * @memberof ItemVendorDetailsByMarketplace
29
29
  */
30
30
  'brandCode'?: string;
31
31
  /**
32
- * Manufacturer code associated with an Amazon catalog item.
32
+ * The manufacturer code that is associated with an Amazon catalog item.
33
33
  * @type {string}
34
34
  * @memberof ItemVendorDetailsByMarketplace
35
35
  */
36
36
  'manufacturerCode'?: string;
37
37
  /**
38
- * Parent vendor code of the manufacturer code.
38
+ * The parent vendor code of the manufacturer code.
39
39
  * @type {string}
40
40
  * @memberof ItemVendorDetailsByMarketplace
41
41
  */
@@ -47,7 +47,7 @@ export interface ItemVendorDetailsByMarketplace {
47
47
  */
48
48
  'productCategory'?: ItemVendorDetailsCategory;
49
49
  /**
50
- * Product group associated with an Amazon catalog item.
50
+ * The product group that is associated with an Amazon catalog item.
51
51
  * @type {string}
52
52
  * @memberof ItemVendorDetailsByMarketplace
53
53
  */
@@ -59,7 +59,7 @@ export interface ItemVendorDetailsByMarketplace {
59
59
  */
60
60
  'productSubcategory'?: ItemVendorDetailsCategory;
61
61
  /**
62
- * Replenishment category associated with an Amazon catalog item.
62
+ * The replenishment category that is associated with an Amazon catalog item.
63
63
  * @type {string}
64
64
  * @memberof ItemVendorDetailsByMarketplace
65
65
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * 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).
3
+ * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,19 +10,19 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Product category or subcategory associated with an Amazon catalog item.
13
+ * The product category or subcategory that is associated with an Amazon catalog item.
14
14
  * @export
15
15
  * @interface ItemVendorDetailsCategory
16
16
  */
17
17
  export interface ItemVendorDetailsCategory {
18
18
  /**
19
- * Display name of the product category or subcategory
19
+ * The display name of the product category or subcategory.
20
20
  * @type {string}
21
21
  * @memberof ItemVendorDetailsCategory
22
22
  */
23
23
  'displayName'?: string;
24
24
  /**
25
- * Value (code) of the product category or subcategory.
25
+ * The code that identifies the product category or subcategory.
26
26
  * @type {string}
27
27
  * @memberof ItemVendorDetailsCategory
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * 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).
3
+ * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -25,13 +25,13 @@ import type { ItemVendorDetailsByMarketplace } from './item-vendor-details-by-ma
25
25
  */
26
26
  export interface Item {
27
27
  /**
28
- * Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog.
28
+ * The unique identifier of an item in the Amazon catalog.
29
29
  * @type {string}
30
30
  * @memberof Item
31
31
  */
32
32
  'asin': string;
33
33
  /**
34
- * 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.
34
+ * 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/docs/product-type-definitions-api-v2020-09-01-reference).
35
35
  * @type {{ [key: string]: any; }}
36
36
  * @memberof Item
37
37
  */
@@ -39,13 +39,13 @@ export interface Item {
39
39
  [key: string]: any;
40
40
  };
41
41
  /**
42
- * Array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace.
42
+ * An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.
43
43
  * @type {Array<ItemBrowseClassificationsByMarketplace>}
44
44
  * @memberof Item
45
45
  */
46
46
  'classifications'?: Array<ItemBrowseClassificationsByMarketplace>;
47
47
  /**
48
- * Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace.
48
+ * An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
49
49
  * @type {Array<ItemDimensionsByMarketplace>}
50
50
  * @memberof Item
51
51
  */
@@ -57,19 +57,19 @@ export interface Item {
57
57
  */
58
58
  'identifiers'?: Array<ItemIdentifiersByMarketplace>;
59
59
  /**
60
- * Images for an item in the Amazon catalog.
60
+ * The images for an item in the Amazon catalog.
61
61
  * @type {Array<ItemImagesByMarketplace>}
62
62
  * @memberof Item
63
63
  */
64
64
  'images'?: Array<ItemImagesByMarketplace>;
65
65
  /**
66
- * Product types associated with the Amazon catalog item.
66
+ * Product types that are associated with the Amazon catalog item.
67
67
  * @type {Array<ItemProductTypeByMarketplace>}
68
68
  * @memberof Item
69
69
  */
70
70
  'productTypes'?: Array<ItemProductTypeByMarketplace>;
71
71
  /**
72
- * Relationships by marketplace for an Amazon catalog item (for example, variations).
72
+ * Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).
73
73
  * @type {Array<ItemRelationshipsByMarketplace>}
74
74
  * @memberof Item
75
75
  */
@@ -81,13 +81,13 @@ export interface Item {
81
81
  */
82
82
  'salesRanks'?: Array<ItemSalesRanksByMarketplace>;
83
83
  /**
84
- * Summary details of an Amazon catalog item.
84
+ * Summaries of Amazon catalog items.
85
85
  * @type {Array<ItemSummaryByMarketplace>}
86
86
  * @memberof Item
87
87
  */
88
88
  'summaries'?: Array<ItemSummaryByMarketplace>;
89
89
  /**
90
- * Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only.
90
+ * The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.
91
91
  * @type {Array<ItemVendorDetailsByMarketplace>}
92
92
  * @memberof Item
93
93
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * 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).
3
+ * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * 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).
3
+ * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,19 +10,19 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * 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.
13
+ * 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.
14
14
  * @export
15
15
  * @interface Pagination
16
16
  */
17
17
  export interface Pagination {
18
18
  /**
19
- * A token that can be used to fetch the next page.
19
+ * A token that you can use to retrieve the next page.
20
20
  * @type {string}
21
21
  * @memberof Pagination
22
22
  */
23
23
  'nextToken'?: string;
24
24
  /**
25
- * A token that can be used to fetch the previous page.
25
+ * A token that you can use to retrieve the previous page.
26
26
  * @type {string}
27
27
  * @memberof Pagination
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * 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).
3
+ * 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).
4
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -12,19 +12,19 @@
12
12
  import type { BrandRefinement } from './brand-refinement';
13
13
  import type { ClassificationRefinement } from './classification-refinement';
14
14
  /**
15
- * Search refinements.
15
+ * Optional fields that you can use to refine your search results.
16
16
  * @export
17
17
  * @interface Refinements
18
18
  */
19
19
  export interface Refinements {
20
20
  /**
21
- * Brand search refinements.
21
+ * A list of brands you can use to refine your search.
22
22
  * @type {Array<BrandRefinement>}
23
23
  * @memberof Refinements
24
24
  */
25
25
  'brands': Array<BrandRefinement>;
26
26
  /**
27
- * Classification search refinements.
27
+ * A list of classifications you can use to refine your search.
28
28
  * @type {Array<ClassificationRefinement>}
29
29
  * @memberof Refinements
30
30
  */
@@ -1,6 +1,6 @@
1
1
  import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
- import { CatalogApi } from './api-model';
2
+ import { CatalogItemsApi } from './api-model';
3
3
  export declare const clientRateLimits: RateLimit[];
4
- export declare class CatalogItemsApiClient extends CatalogApi {
4
+ export declare class CatalogItemsApiClient extends CatalogItemsApi {
5
5
  constructor(configuration: ClientConfiguration);
6
6
  }
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@sp-api-sdk/catalog-items-api-2022-04-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
- "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.",
5
- "version": "3.1.1",
4
+ "description": "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.",
5
+ "version": "4.0.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.12",
22
- "axios": "^1.8.3"
21
+ "@sp-api-sdk/common": "2.1.14",
22
+ "axios": "^1.9.0"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "catalog items api"
42
42
  ],
43
- "gitHead": "1e03c21270cfd38688ca6928b63d3f3b4a3587b0"
43
+ "gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
44
44
  }
@@ -1,285 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * 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).
4
- *
5
- * The version of the OpenAPI document: 2022-04-01
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { Item } from '../models';
17
- import type { ItemSearchResults } from '../models';
18
- /**
19
- * CatalogApi - axios parameter creator
20
- * @export
21
- */
22
- export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => {
23
- /**
24
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
- * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
26
- * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
27
- * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
28
- * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
29
- * @param {*} [options] Override http request option.
30
- * @throws {RequiredError}
31
- */
32
- getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
33
- /**
34
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
35
- * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
36
- * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
37
- * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
38
- * @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
39
- * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
40
- * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
41
- * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
42
- * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
43
- * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
44
- * @param {number} [pageSize] Number of results to be returned per page.
45
- * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
46
- * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
47
- * @param {*} [options] Override http request option.
48
- * @throws {RequiredError}
49
- */
50
- 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>;
51
- };
52
- /**
53
- * CatalogApi - functional programming interface
54
- * @export
55
- */
56
- export declare const CatalogApiFp: (configuration?: Configuration) => {
57
- /**
58
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
59
- * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
60
- * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
61
- * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
62
- * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
63
- * @param {*} [options] Override http request option.
64
- * @throws {RequiredError}
65
- */
66
- getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
67
- /**
68
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
69
- * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
70
- * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
71
- * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
72
- * @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
73
- * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
74
- * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
75
- * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
76
- * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
77
- * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
78
- * @param {number} [pageSize] Number of results to be returned per page.
79
- * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
80
- * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
81
- * @param {*} [options] Override http request option.
82
- * @throws {RequiredError}
83
- */
84
- 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>>;
85
- };
86
- /**
87
- * CatalogApi - factory interface
88
- * @export
89
- */
90
- export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
91
- /**
92
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
93
- * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
94
- * @param {*} [options] Override http request option.
95
- * @throws {RequiredError}
96
- */
97
- getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
98
- /**
99
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
100
- * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
101
- * @param {*} [options] Override http request option.
102
- * @throws {RequiredError}
103
- */
104
- searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>;
105
- };
106
- /**
107
- * Request parameters for getCatalogItem operation in CatalogApi.
108
- * @export
109
- * @interface CatalogApiGetCatalogItemRequest
110
- */
111
- export interface CatalogApiGetCatalogItemRequest {
112
- /**
113
- * The Amazon Standard Identification Number (ASIN) of the item.
114
- * @type {string}
115
- * @memberof CatalogApiGetCatalogItem
116
- */
117
- readonly asin: string;
118
- /**
119
- * A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
120
- * @type {Array<string>}
121
- * @memberof CatalogApiGetCatalogItem
122
- */
123
- readonly marketplaceIds: Array<string>;
124
- /**
125
- * A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
126
- * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
127
- * @memberof CatalogApiGetCatalogItem
128
- */
129
- readonly includedData?: Array<GetCatalogItemIncludedDataEnum>;
130
- /**
131
- * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
132
- * @type {string}
133
- * @memberof CatalogApiGetCatalogItem
134
- */
135
- readonly locale?: string;
136
- }
137
- /**
138
- * Request parameters for searchCatalogItems operation in CatalogApi.
139
- * @export
140
- * @interface CatalogApiSearchCatalogItemsRequest
141
- */
142
- export interface CatalogApiSearchCatalogItemsRequest {
143
- /**
144
- * A comma-delimited list of Amazon marketplace identifiers for the request.
145
- * @type {Array<string>}
146
- * @memberof CatalogApiSearchCatalogItems
147
- */
148
- readonly marketplaceIds: Array<string>;
149
- /**
150
- * A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
151
- * @type {Array<string>}
152
- * @memberof CatalogApiSearchCatalogItems
153
- */
154
- readonly identifiers?: Array<string>;
155
- /**
156
- * Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
157
- * @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'}
158
- * @memberof CatalogApiSearchCatalogItems
159
- */
160
- readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
161
- /**
162
- * A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
163
- * @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
164
- * @memberof CatalogApiSearchCatalogItems
165
- */
166
- readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>;
167
- /**
168
- * Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
169
- * @type {string}
170
- * @memberof CatalogApiSearchCatalogItems
171
- */
172
- readonly locale?: string;
173
- /**
174
- * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
175
- * @type {string}
176
- * @memberof CatalogApiSearchCatalogItems
177
- */
178
- readonly sellerId?: string;
179
- /**
180
- * A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
181
- * @type {Array<string>}
182
- * @memberof CatalogApiSearchCatalogItems
183
- */
184
- readonly keywords?: Array<string>;
185
- /**
186
- * A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
187
- * @type {Array<string>}
188
- * @memberof CatalogApiSearchCatalogItems
189
- */
190
- readonly brandNames?: Array<string>;
191
- /**
192
- * A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
193
- * @type {Array<string>}
194
- * @memberof CatalogApiSearchCatalogItems
195
- */
196
- readonly classificationIds?: Array<string>;
197
- /**
198
- * Number of results to be returned per page.
199
- * @type {number}
200
- * @memberof CatalogApiSearchCatalogItems
201
- */
202
- readonly pageSize?: number;
203
- /**
204
- * A token to fetch a certain page when there are multiple pages worth of results.
205
- * @type {string}
206
- * @memberof CatalogApiSearchCatalogItems
207
- */
208
- readonly pageToken?: string;
209
- /**
210
- * The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
211
- * @type {string}
212
- * @memberof CatalogApiSearchCatalogItems
213
- */
214
- readonly keywordsLocale?: string;
215
- }
216
- /**
217
- * CatalogApi - object-oriented interface
218
- * @export
219
- * @class CatalogApi
220
- * @extends {BaseAPI}
221
- */
222
- export declare class CatalogApi extends BaseAPI {
223
- /**
224
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
225
- * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
226
- * @param {*} [options] Override http request option.
227
- * @throws {RequiredError}
228
- * @memberof CatalogApi
229
- */
230
- getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>;
231
- /**
232
- * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
233
- * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
234
- * @param {*} [options] Override http request option.
235
- * @throws {RequiredError}
236
- * @memberof CatalogApi
237
- */
238
- searchCatalogItems(requestParameters: CatalogApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>;
239
- }
240
- /**
241
- * @export
242
- */
243
- export declare const GetCatalogItemIncludedDataEnum: {
244
- readonly Attributes: "attributes";
245
- readonly Classifications: "classifications";
246
- readonly Dimensions: "dimensions";
247
- readonly Identifiers: "identifiers";
248
- readonly Images: "images";
249
- readonly ProductTypes: "productTypes";
250
- readonly Relationships: "relationships";
251
- readonly SalesRanks: "salesRanks";
252
- readonly Summaries: "summaries";
253
- readonly VendorDetails: "vendorDetails";
254
- };
255
- export type GetCatalogItemIncludedDataEnum = typeof GetCatalogItemIncludedDataEnum[keyof typeof GetCatalogItemIncludedDataEnum];
256
- /**
257
- * @export
258
- */
259
- export declare const SearchCatalogItemsIdentifiersTypeEnum: {
260
- readonly Asin: "ASIN";
261
- readonly Ean: "EAN";
262
- readonly Gtin: "GTIN";
263
- readonly Isbn: "ISBN";
264
- readonly Jan: "JAN";
265
- readonly Minsan: "MINSAN";
266
- readonly Sku: "SKU";
267
- readonly Upc: "UPC";
268
- };
269
- export type SearchCatalogItemsIdentifiersTypeEnum = typeof SearchCatalogItemsIdentifiersTypeEnum[keyof typeof SearchCatalogItemsIdentifiersTypeEnum];
270
- /**
271
- * @export
272
- */
273
- export declare const SearchCatalogItemsIncludedDataEnum: {
274
- readonly Attributes: "attributes";
275
- readonly Classifications: "classifications";
276
- readonly Dimensions: "dimensions";
277
- readonly Identifiers: "identifiers";
278
- readonly Images: "images";
279
- readonly ProductTypes: "productTypes";
280
- readonly Relationships: "relationships";
281
- readonly SalesRanks: "salesRanks";
282
- readonly Summaries: "summaries";
283
- readonly VendorDetails: "vendorDetails";
284
- };
285
- export type SearchCatalogItemsIncludedDataEnum = typeof SearchCatalogItemsIncludedDataEnum[keyof typeof SearchCatalogItemsIncludedDataEnum];