@sp-api-sdk/catalog-items-api-2022-04-01 4.2.12 → 5.1.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 (122) hide show
  1. package/README.md +7 -8
  2. package/dist/index.cjs +479 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +1132 -0
  5. package/dist/index.d.ts +1132 -0
  6. package/dist/index.js +443 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +26 -12
  9. package/dist/cjs/api-model/api/catalog-items-api.js +0 -283
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/brand-refinement.js +0 -15
  16. package/dist/cjs/api-model/models/classification-refinement.js +0 -15
  17. package/dist/cjs/api-model/models/dimension.js +0 -15
  18. package/dist/cjs/api-model/models/dimensions.js +0 -15
  19. package/dist/cjs/api-model/models/error-list.js +0 -15
  20. package/dist/cjs/api-model/models/index.js +0 -45
  21. package/dist/cjs/api-model/models/item-browse-classification.js +0 -15
  22. package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +0 -15
  23. package/dist/cjs/api-model/models/item-classification-sales-rank.js +0 -15
  24. package/dist/cjs/api-model/models/item-contributor-role.js +0 -15
  25. package/dist/cjs/api-model/models/item-contributor.js +0 -15
  26. package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +0 -15
  27. package/dist/cjs/api-model/models/item-display-group-sales-rank.js +0 -15
  28. package/dist/cjs/api-model/models/item-identifier.js +0 -15
  29. package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +0 -15
  30. package/dist/cjs/api-model/models/item-image.js +0 -28
  31. package/dist/cjs/api-model/models/item-images-by-marketplace.js +0 -15
  32. package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +0 -15
  33. package/dist/cjs/api-model/models/item-relationship.js +0 -20
  34. package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +0 -15
  35. package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +0 -15
  36. package/dist/cjs/api-model/models/item-search-results.js +0 -15
  37. package/dist/cjs/api-model/models/item-summary-by-marketplace.js +0 -22
  38. package/dist/cjs/api-model/models/item-variation-theme.js +0 -15
  39. package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +0 -28
  40. package/dist/cjs/api-model/models/item-vendor-details-category.js +0 -15
  41. package/dist/cjs/api-model/models/item.js +0 -15
  42. package/dist/cjs/api-model/models/model-error.js +0 -15
  43. package/dist/cjs/api-model/models/pagination.js +0 -15
  44. package/dist/cjs/api-model/models/refinements.js +0 -15
  45. package/dist/cjs/client.js +0 -28
  46. package/dist/cjs/index.js +0 -19
  47. package/dist/es/api-model/api/catalog-items-api.js +0 -273
  48. package/dist/es/api-model/api.js +0 -14
  49. package/dist/es/api-model/base.js +0 -44
  50. package/dist/es/api-model/common.js +0 -110
  51. package/dist/es/api-model/configuration.js +0 -94
  52. package/dist/es/api-model/index.js +0 -16
  53. package/dist/es/api-model/models/brand-refinement.js +0 -14
  54. package/dist/es/api-model/models/classification-refinement.js +0 -14
  55. package/dist/es/api-model/models/dimension.js +0 -14
  56. package/dist/es/api-model/models/dimensions.js +0 -14
  57. package/dist/es/api-model/models/error-list.js +0 -14
  58. package/dist/es/api-model/models/index.js +0 -29
  59. package/dist/es/api-model/models/item-browse-classification.js +0 -14
  60. package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +0 -14
  61. package/dist/es/api-model/models/item-classification-sales-rank.js +0 -14
  62. package/dist/es/api-model/models/item-contributor-role.js +0 -14
  63. package/dist/es/api-model/models/item-contributor.js +0 -14
  64. package/dist/es/api-model/models/item-dimensions-by-marketplace.js +0 -14
  65. package/dist/es/api-model/models/item-display-group-sales-rank.js +0 -14
  66. package/dist/es/api-model/models/item-identifier.js +0 -14
  67. package/dist/es/api-model/models/item-identifiers-by-marketplace.js +0 -14
  68. package/dist/es/api-model/models/item-image.js +0 -25
  69. package/dist/es/api-model/models/item-images-by-marketplace.js +0 -14
  70. package/dist/es/api-model/models/item-product-type-by-marketplace.js +0 -14
  71. package/dist/es/api-model/models/item-relationship.js +0 -17
  72. package/dist/es/api-model/models/item-relationships-by-marketplace.js +0 -14
  73. package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +0 -14
  74. package/dist/es/api-model/models/item-search-results.js +0 -14
  75. package/dist/es/api-model/models/item-summary-by-marketplace.js +0 -19
  76. package/dist/es/api-model/models/item-variation-theme.js +0 -14
  77. package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +0 -25
  78. package/dist/es/api-model/models/item-vendor-details-category.js +0 -14
  79. package/dist/es/api-model/models/item.js +0 -14
  80. package/dist/es/api-model/models/model-error.js +0 -14
  81. package/dist/es/api-model/models/pagination.js +0 -14
  82. package/dist/es/api-model/models/refinements.js +0 -14
  83. package/dist/es/client.js +0 -24
  84. package/dist/es/index.js +0 -3
  85. package/dist/types/api-model/api/catalog-items-api.d.ts +0 -232
  86. package/dist/types/api-model/api.d.ts +0 -12
  87. package/dist/types/api-model/base.d.ts +0 -42
  88. package/dist/types/api-model/common.d.ts +0 -34
  89. package/dist/types/api-model/configuration.d.ts +0 -98
  90. package/dist/types/api-model/index.d.ts +0 -14
  91. package/dist/types/api-model/models/brand-refinement.d.ts +0 -24
  92. package/dist/types/api-model/models/classification-refinement.d.ts +0 -28
  93. package/dist/types/api-model/models/dimension.d.ts +0 -24
  94. package/dist/types/api-model/models/dimensions.d.ts +0 -21
  95. package/dist/types/api-model/models/error-list.d.ts +0 -20
  96. package/dist/types/api-model/models/index.d.ts +0 -29
  97. package/dist/types/api-model/models/item-browse-classification.d.ts +0 -25
  98. package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +0 -25
  99. package/dist/types/api-model/models/item-classification-sales-rank.d.ts +0 -32
  100. package/dist/types/api-model/models/item-contributor-role.d.ts +0 -24
  101. package/dist/types/api-model/models/item-contributor.d.ts +0 -22
  102. package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +0 -23
  103. package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +0 -32
  104. package/dist/types/api-model/models/item-identifier.d.ts +0 -24
  105. package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +0 -25
  106. package/dist/types/api-model/models/item-image.d.ts +0 -45
  107. package/dist/types/api-model/models/item-images-by-marketplace.d.ts +0 -25
  108. package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +0 -24
  109. package/dist/types/api-model/models/item-relationship.d.ts +0 -35
  110. package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +0 -25
  111. package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +0 -30
  112. package/dist/types/api-model/models/item-search-results.d.ts +0 -29
  113. package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +0 -102
  114. package/dist/types/api-model/models/item-variation-theme.d.ts +0 -24
  115. package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +0 -56
  116. package/dist/types/api-model/models/item-vendor-details-category.d.ts +0 -24
  117. package/dist/types/api-model/models/item.d.ts +0 -71
  118. package/dist/types/api-model/models/model-error.d.ts +0 -28
  119. package/dist/types/api-model/models/pagination.d.ts +0 -24
  120. package/dist/types/api-model/models/refinements.d.ts +0 -26
  121. package/dist/types/client.d.ts +0 -6
  122. package/dist/types/index.d.ts +0 -3
@@ -0,0 +1,1132 @@
1
+ import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
2
+ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
3
+ //#region src/api-model/configuration.d.ts
4
+ /**
5
+ * Selling Partner API for Catalog Items
6
+ * 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).
7
+ *
8
+ * The version of the OpenAPI document: 2022-04-01
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ interface AWSv4Configuration {
16
+ options?: {
17
+ region?: string;
18
+ service?: string;
19
+ };
20
+ credentials?: {
21
+ accessKeyId?: string;
22
+ secretAccessKey?: string;
23
+ sessionToken?: string;
24
+ };
25
+ }
26
+ interface ConfigurationParameters {
27
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
+ username?: string;
29
+ password?: string;
30
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
31
+ awsv4?: AWSv4Configuration;
32
+ basePath?: string;
33
+ serverIndex?: number;
34
+ baseOptions?: any;
35
+ formDataCtor?: new () => any;
36
+ }
37
+ declare class Configuration {
38
+ /**
39
+ * parameter for apiKey security
40
+ * @param name security name
41
+ */
42
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
43
+ /**
44
+ * parameter for basic security
45
+ */
46
+ username?: string;
47
+ /**
48
+ * parameter for basic security
49
+ */
50
+ password?: string;
51
+ /**
52
+ * parameter for oauth2 security
53
+ * @param name security name
54
+ * @param scopes oauth2 scope
55
+ */
56
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
57
+ /**
58
+ * parameter for aws4 signature security
59
+ * @param {Object} AWS4Signature - AWS4 Signature security
60
+ * @param {string} options.region - aws region
61
+ * @param {string} options.service - name of the service.
62
+ * @param {string} credentials.accessKeyId - aws access key id
63
+ * @param {string} credentials.secretAccessKey - aws access key
64
+ * @param {string} credentials.sessionToken - aws session token
65
+ * @memberof Configuration
66
+ */
67
+ awsv4?: AWSv4Configuration;
68
+ /**
69
+ * override base path
70
+ */
71
+ basePath?: string;
72
+ /**
73
+ * override server index
74
+ */
75
+ serverIndex?: number;
76
+ /**
77
+ * base options for axios calls
78
+ */
79
+ baseOptions?: any;
80
+ /**
81
+ * The FormData constructor that will be used to create multipart form data
82
+ * requests. You can inject this here so that execution environments that
83
+ * do not support the FormData class can still run the generated client.
84
+ *
85
+ * @type {new () => FormData}
86
+ */
87
+ formDataCtor?: new () => any;
88
+ constructor(param?: ConfigurationParameters);
89
+ /**
90
+ * Check if the given MIME is a JSON MIME.
91
+ * JSON MIME examples:
92
+ * application/json
93
+ * application/json; charset=UTF8
94
+ * APPLICATION/JSON
95
+ * application/vnd.company+json
96
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
97
+ * @return True if the given MIME is JSON, false otherwise.
98
+ */
99
+ isJsonMime(mime: string): boolean;
100
+ }
101
+ //#endregion
102
+ //#region src/api-model/base.d.ts
103
+ interface RequestArgs {
104
+ url: string;
105
+ options: RawAxiosRequestConfig;
106
+ }
107
+ declare class BaseAPI {
108
+ protected basePath: string;
109
+ protected axios: AxiosInstance;
110
+ protected configuration: Configuration | undefined;
111
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
112
+ }
113
+ //#endregion
114
+ //#region src/api-model/models/brand-refinement.d.ts
115
+ /**
116
+ * Selling Partner API for Catalog Items
117
+ * 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).
118
+ *
119
+ * The version of the OpenAPI document: 2022-04-01
120
+ *
121
+ *
122
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
123
+ * https://openapi-generator.tech
124
+ * Do not edit the class manually.
125
+ */
126
+ /**
127
+ * A brand that you can use to refine your search.
128
+ */
129
+ interface BrandRefinement {
130
+ /**
131
+ * The estimated number of results that would be returned if you refine your search by the specified `brandName`.
132
+ */
133
+ 'numberOfResults': number;
134
+ /**
135
+ * The brand name that you can use to refine your search.
136
+ */
137
+ 'brandName': string;
138
+ }
139
+ //#endregion
140
+ //#region src/api-model/models/classification-refinement.d.ts
141
+ /**
142
+ * Selling Partner API for Catalog Items
143
+ * 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).
144
+ *
145
+ * The version of the OpenAPI document: 2022-04-01
146
+ *
147
+ *
148
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
149
+ * https://openapi-generator.tech
150
+ * Do not edit the class manually.
151
+ */
152
+ /**
153
+ * A classification that you can use to refine your search.
154
+ */
155
+ interface ClassificationRefinement {
156
+ /**
157
+ * The estimated number of results that would be returned if you refine your search by the specified `classificationId`.
158
+ */
159
+ 'numberOfResults': number;
160
+ /**
161
+ * Display name for the classification.
162
+ */
163
+ 'displayName': string;
164
+ /**
165
+ * The identifier of the classification that you can use to refine your search.
166
+ */
167
+ 'classificationId': string;
168
+ }
169
+ //#endregion
170
+ //#region src/api-model/models/dimension.d.ts
171
+ /**
172
+ * Selling Partner API for Catalog Items
173
+ * 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).
174
+ *
175
+ * The version of the OpenAPI document: 2022-04-01
176
+ *
177
+ *
178
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
179
+ * https://openapi-generator.tech
180
+ * Do not edit the class manually.
181
+ */
182
+ /**
183
+ * The value of an individual dimension for an Amazon catalog item or item package.
184
+ */
185
+ interface Dimension {
186
+ /**
187
+ * Unit of measurement for the dimension value.
188
+ */
189
+ 'unit'?: string;
190
+ /**
191
+ * Numeric value of the dimension.
192
+ */
193
+ 'value'?: number;
194
+ }
195
+ //#endregion
196
+ //#region src/api-model/models/dimensions.d.ts
197
+ /**
198
+ * Dimensions of an Amazon catalog item or item in its packaging.
199
+ */
200
+ interface Dimensions {
201
+ 'height'?: Dimension;
202
+ 'length'?: Dimension;
203
+ 'weight'?: Dimension;
204
+ 'width'?: Dimension;
205
+ }
206
+ //#endregion
207
+ //#region src/api-model/models/error-list.d.ts
208
+ /**
209
+ * Selling Partner API for Catalog Items
210
+ * 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).
211
+ *
212
+ * The version of the OpenAPI document: 2022-04-01
213
+ *
214
+ *
215
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
216
+ * https://openapi-generator.tech
217
+ * Do not edit the class manually.
218
+ */
219
+ /**
220
+ * A list of error responses returned when a request is unsuccessful.
221
+ */
222
+ interface ErrorList {
223
+ /**
224
+ * A list of error responses returned when a request is unsuccessful.
225
+ */
226
+ 'errors': Array<Error>;
227
+ }
228
+ //#endregion
229
+ //#region src/api-model/models/item-browse-classification.d.ts
230
+ /**
231
+ * Selling Partner API for Catalog Items
232
+ * 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).
233
+ *
234
+ * The version of the OpenAPI document: 2022-04-01
235
+ *
236
+ *
237
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
238
+ * https://openapi-generator.tech
239
+ * Do not edit the class manually.
240
+ */
241
+ /**
242
+ * Classification (browse node) for an Amazon catalog item.
243
+ */
244
+ interface ItemBrowseClassification {
245
+ /**
246
+ * Display name for the classification.
247
+ */
248
+ 'displayName': string;
249
+ /**
250
+ * Identifier of the classification.
251
+ */
252
+ 'classificationId': string;
253
+ 'parent'?: ItemBrowseClassification;
254
+ }
255
+ //#endregion
256
+ //#region src/api-model/models/item-browse-classifications-by-marketplace.d.ts
257
+ /**
258
+ * Classifications (browse nodes) that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
259
+ */
260
+ interface ItemBrowseClassificationsByMarketplace {
261
+ /**
262
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
263
+ */
264
+ 'marketplaceId': string;
265
+ /**
266
+ * Classifications (browse nodes) that are associated with the item in the Amazon catalog.
267
+ */
268
+ 'classifications'?: Array<ItemBrowseClassification>;
269
+ }
270
+ //#endregion
271
+ //#region src/api-model/models/item-dimensions-by-marketplace.d.ts
272
+ /**
273
+ * Dimensions that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
274
+ */
275
+ interface ItemDimensionsByMarketplace {
276
+ /**
277
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
278
+ */
279
+ 'marketplaceId': string;
280
+ 'item'?: Dimensions;
281
+ 'package'?: Dimensions;
282
+ }
283
+ //#endregion
284
+ //#region src/api-model/models/item-identifier.d.ts
285
+ /**
286
+ * Selling Partner API for Catalog Items
287
+ * 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).
288
+ *
289
+ * The version of the OpenAPI document: 2022-04-01
290
+ *
291
+ *
292
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
293
+ * https://openapi-generator.tech
294
+ * Do not edit the class manually.
295
+ */
296
+ /**
297
+ * The identifier that is associated with the item in the Amazon catalog, such as a UPC or EAN identifier.
298
+ */
299
+ interface ItemIdentifier {
300
+ /**
301
+ * Type of identifier, such as UPC, EAN, or ISBN.
302
+ */
303
+ 'identifierType': string;
304
+ /**
305
+ * Identifier of the item.
306
+ */
307
+ 'identifier': string;
308
+ }
309
+ //#endregion
310
+ //#region src/api-model/models/item-identifiers-by-marketplace.d.ts
311
+ /**
312
+ * Identifiers that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
313
+ */
314
+ interface ItemIdentifiersByMarketplace {
315
+ /**
316
+ * 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.
317
+ */
318
+ 'marketplaceId': string;
319
+ /**
320
+ * Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`.
321
+ */
322
+ 'identifiers': Array<ItemIdentifier>;
323
+ }
324
+ //#endregion
325
+ //#region src/api-model/models/item-image.d.ts
326
+ /**
327
+ * Selling Partner API for Catalog Items
328
+ * 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).
329
+ *
330
+ * The version of the OpenAPI document: 2022-04-01
331
+ *
332
+ *
333
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
334
+ * https://openapi-generator.tech
335
+ * Do not edit the class manually.
336
+ */
337
+ /**
338
+ * Image for an item in the Amazon catalog.
339
+ */
340
+ interface ItemImage {
341
+ /**
342
+ * Variant of the image, such as `MAIN` or `PT01`.
343
+ */
344
+ 'variant': ItemImageVariantEnum;
345
+ /**
346
+ * URL for the image.
347
+ */
348
+ 'link': string;
349
+ /**
350
+ * Height of the image in pixels.
351
+ */
352
+ 'height': number;
353
+ /**
354
+ * Width of the image in pixels.
355
+ */
356
+ 'width': number;
357
+ }
358
+ declare const ItemImageVariantEnum: {
359
+ readonly Main: "MAIN";
360
+ readonly Pt01: "PT01";
361
+ readonly Pt02: "PT02";
362
+ readonly Pt03: "PT03";
363
+ readonly Pt04: "PT04";
364
+ readonly Pt05: "PT05";
365
+ readonly Pt06: "PT06";
366
+ readonly Pt07: "PT07";
367
+ readonly Pt08: "PT08";
368
+ readonly Swch: "SWCH";
369
+ };
370
+ type ItemImageVariantEnum = typeof ItemImageVariantEnum[keyof typeof ItemImageVariantEnum];
371
+ //#endregion
372
+ //#region src/api-model/models/item-images-by-marketplace.d.ts
373
+ /**
374
+ * Images for an item in the Amazon catalog, grouped by `marketplaceId`.
375
+ */
376
+ interface ItemImagesByMarketplace {
377
+ /**
378
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
379
+ */
380
+ 'marketplaceId': string;
381
+ /**
382
+ * Images for an item in the Amazon catalog, grouped by `marketplaceId`.
383
+ */
384
+ 'images': Array<ItemImage>;
385
+ }
386
+ //#endregion
387
+ //#region src/api-model/models/item-product-type-by-marketplace.d.ts
388
+ /**
389
+ * Selling Partner API for Catalog Items
390
+ * 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).
391
+ *
392
+ * The version of the OpenAPI document: 2022-04-01
393
+ *
394
+ *
395
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
396
+ * https://openapi-generator.tech
397
+ * Do not edit the class manually.
398
+ */
399
+ /**
400
+ * Product type that is associated with the Amazon catalog item, grouped by `marketplaceId`.
401
+ */
402
+ interface ItemProductTypeByMarketplace {
403
+ /**
404
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
405
+ */
406
+ 'marketplaceId'?: string;
407
+ /**
408
+ * Name of the product type that is associated with the Amazon catalog item.
409
+ */
410
+ 'productType'?: string;
411
+ }
412
+ //#endregion
413
+ //#region src/api-model/models/item-variation-theme.d.ts
414
+ /**
415
+ * Selling Partner API for Catalog Items
416
+ * 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).
417
+ *
418
+ * The version of the OpenAPI document: 2022-04-01
419
+ *
420
+ *
421
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
422
+ * https://openapi-generator.tech
423
+ * Do not edit the class manually.
424
+ */
425
+ /**
426
+ * The variation theme is a list of Amazon catalog item attributes that define the variation family.
427
+ */
428
+ interface ItemVariationTheme {
429
+ /**
430
+ * Names of the Amazon catalog item attributes that are associated with the variation theme.
431
+ */
432
+ 'attributes'?: Array<string>;
433
+ /**
434
+ * Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family.
435
+ */
436
+ 'theme'?: string;
437
+ }
438
+ //#endregion
439
+ //#region src/api-model/models/item-relationship.d.ts
440
+ /**
441
+ * Relationship details for an Amazon catalog item.
442
+ */
443
+ interface ItemRelationship {
444
+ /**
445
+ * ASINs of the related items that are children of this item.
446
+ */
447
+ 'childAsins'?: Array<string>;
448
+ /**
449
+ * ASINs of the related items that are parents of this item.
450
+ */
451
+ 'parentAsins'?: Array<string>;
452
+ 'variationTheme'?: ItemVariationTheme;
453
+ /**
454
+ * Type of relationship.
455
+ */
456
+ 'type': ItemRelationshipTypeEnum;
457
+ }
458
+ declare const ItemRelationshipTypeEnum: {
459
+ readonly Variation: "VARIATION";
460
+ readonly PackageHierarchy: "PACKAGE_HIERARCHY";
461
+ };
462
+ type ItemRelationshipTypeEnum = typeof ItemRelationshipTypeEnum[keyof typeof ItemRelationshipTypeEnum];
463
+ //#endregion
464
+ //#region src/api-model/models/item-relationships-by-marketplace.d.ts
465
+ /**
466
+ * Relationship details for the Amazon catalog item for the specified Amazon `marketplaceId`.
467
+ */
468
+ interface ItemRelationshipsByMarketplace {
469
+ /**
470
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
471
+ */
472
+ 'marketplaceId': string;
473
+ /**
474
+ * Relationships for the item.
475
+ */
476
+ 'relationships': Array<ItemRelationship>;
477
+ }
478
+ //#endregion
479
+ //#region src/api-model/models/item-classification-sales-rank.d.ts
480
+ /**
481
+ * Selling Partner API for Catalog Items
482
+ * 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).
483
+ *
484
+ * The version of the OpenAPI document: 2022-04-01
485
+ *
486
+ *
487
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
488
+ * https://openapi-generator.tech
489
+ * Do not edit the class manually.
490
+ */
491
+ /**
492
+ * Sales rank of an Amazon catalog item.
493
+ */
494
+ interface ItemClassificationSalesRank {
495
+ /**
496
+ * Identifier of the classification that is associated with the sales rank.
497
+ */
498
+ 'classificationId': string;
499
+ /**
500
+ * Name of the sales rank.
501
+ */
502
+ 'title': string;
503
+ /**
504
+ * Corresponding Amazon retail website URL for the sales category.
505
+ */
506
+ 'link'?: string;
507
+ /**
508
+ * Sales rank.
509
+ */
510
+ 'rank': number;
511
+ }
512
+ //#endregion
513
+ //#region src/api-model/models/item-display-group-sales-rank.d.ts
514
+ /**
515
+ * Selling Partner API for Catalog Items
516
+ * 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).
517
+ *
518
+ * The version of the OpenAPI document: 2022-04-01
519
+ *
520
+ *
521
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
522
+ * https://openapi-generator.tech
523
+ * Do not edit the class manually.
524
+ */
525
+ /**
526
+ * Sales rank of an Amazon catalog item, grouped by website display group.
527
+ */
528
+ interface ItemDisplayGroupSalesRank {
529
+ /**
530
+ * Name of the website display group that is associated with the sales rank
531
+ */
532
+ 'websiteDisplayGroup': string;
533
+ /**
534
+ * Name of the sales rank.
535
+ */
536
+ 'title': string;
537
+ /**
538
+ * Corresponding Amazon retail website URL for the sales rank.
539
+ */
540
+ 'link'?: string;
541
+ /**
542
+ * Sales rank.
543
+ */
544
+ 'rank': number;
545
+ }
546
+ //#endregion
547
+ //#region src/api-model/models/item-sales-ranks-by-marketplace.d.ts
548
+ /**
549
+ * Sales ranks of an Amazon catalog item, grouped by `marketplaceId`.
550
+ */
551
+ interface ItemSalesRanksByMarketplace {
552
+ /**
553
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
554
+ */
555
+ 'marketplaceId': string;
556
+ /**
557
+ * Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification.
558
+ */
559
+ 'classificationRanks'?: Array<ItemClassificationSalesRank>;
560
+ /**
561
+ * Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group.
562
+ */
563
+ 'displayGroupRanks'?: Array<ItemDisplayGroupSalesRank>;
564
+ }
565
+ //#endregion
566
+ //#region src/api-model/models/item-contributor-role.d.ts
567
+ /**
568
+ * Selling Partner API for Catalog Items
569
+ * 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).
570
+ *
571
+ * The version of the OpenAPI document: 2022-04-01
572
+ *
573
+ *
574
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
575
+ * https://openapi-generator.tech
576
+ * Do not edit the class manually.
577
+ */
578
+ /**
579
+ * Role of an individual contributor in the creation of an item, such as author or actor.
580
+ */
581
+ interface ItemContributorRole {
582
+ /**
583
+ * Display name of the role in the requested locale, such as `Author` or `Actor`.
584
+ */
585
+ 'displayName'?: string;
586
+ /**
587
+ * Role value for the Amazon catalog item, such as `author` or `actor`.
588
+ */
589
+ 'value': string;
590
+ }
591
+ //#endregion
592
+ //#region src/api-model/models/item-contributor.d.ts
593
+ /**
594
+ * Individual contributor to the creation of an item, such as an author or actor.
595
+ */
596
+ interface ItemContributor {
597
+ 'role': ItemContributorRole;
598
+ /**
599
+ * Name of the contributor, such as `Jane Austen`.
600
+ */
601
+ 'value': string;
602
+ }
603
+ //#endregion
604
+ //#region src/api-model/models/item-summary-by-marketplace.d.ts
605
+ /**
606
+ * Information about an Amazon catalog item for the indicated `marketplaceId`.
607
+ */
608
+ interface ItemSummaryByMarketplace {
609
+ /**
610
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
611
+ */
612
+ 'marketplaceId': string;
613
+ /**
614
+ * When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature.
615
+ */
616
+ 'adultProduct'?: boolean;
617
+ /**
618
+ * When `true`, the Amazon catalog item is autographed.
619
+ */
620
+ 'autographed'?: boolean;
621
+ /**
622
+ * Name of the brand that is associated with the Amazon catalog item.
623
+ */
624
+ 'brand'?: string;
625
+ 'browseClassification'?: ItemBrowseClassification;
626
+ /**
627
+ * The color that is associated with the Amazon catalog item.
628
+ */
629
+ 'color'?: string;
630
+ /**
631
+ * Individual contributors to the creation of the item, such as the authors or actors.
632
+ */
633
+ 'contributors'?: Array<ItemContributor>;
634
+ /**
635
+ * Classification type that is associated with the Amazon catalog item.
636
+ */
637
+ 'itemClassification'?: ItemSummaryByMarketplaceItemClassificationEnum;
638
+ /**
639
+ * The name that is associated with the Amazon catalog item.
640
+ */
641
+ 'itemName'?: string;
642
+ /**
643
+ * The name of the manufacturer that is associated with the Amazon catalog item.
644
+ */
645
+ 'manufacturer'?: string;
646
+ /**
647
+ * When true, the item is classified as memorabilia.
648
+ */
649
+ 'memorabilia'?: boolean;
650
+ /**
651
+ * The model number that is associated with the Amazon catalog item.
652
+ */
653
+ 'modelNumber'?: string;
654
+ /**
655
+ * The quantity of the Amazon catalog item within one package.
656
+ */
657
+ 'packageQuantity'?: number;
658
+ /**
659
+ * The part number that is associated with the Amazon catalog item.
660
+ */
661
+ 'partNumber'?: string;
662
+ /**
663
+ * The earliest date on which the Amazon catalog item can be shipped to customers.
664
+ */
665
+ 'releaseDate'?: string;
666
+ /**
667
+ * The name of the size of the Amazon catalog item.
668
+ */
669
+ 'size'?: string;
670
+ /**
671
+ * The name of the style that is associated with the Amazon catalog item.
672
+ */
673
+ 'style'?: string;
674
+ /**
675
+ * When true, the Amazon catalog item is eligible for trade-in.
676
+ */
677
+ 'tradeInEligible'?: boolean;
678
+ /**
679
+ * The identifier of the website display group that is associated with the Amazon catalog item.
680
+ */
681
+ 'websiteDisplayGroup'?: string;
682
+ /**
683
+ * The display name of the website display group that is associated with the Amazon catalog item.
684
+ */
685
+ 'websiteDisplayGroupName'?: string;
686
+ }
687
+ declare const ItemSummaryByMarketplaceItemClassificationEnum: {
688
+ readonly BaseProduct: "BASE_PRODUCT";
689
+ readonly Other: "OTHER";
690
+ readonly ProductBundle: "PRODUCT_BUNDLE";
691
+ readonly VariationParent: "VARIATION_PARENT";
692
+ };
693
+ type ItemSummaryByMarketplaceItemClassificationEnum = typeof ItemSummaryByMarketplaceItemClassificationEnum[keyof typeof ItemSummaryByMarketplaceItemClassificationEnum];
694
+ //#endregion
695
+ //#region src/api-model/models/item-vendor-details-category.d.ts
696
+ /**
697
+ * Selling Partner API for Catalog Items
698
+ * 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).
699
+ *
700
+ * The version of the OpenAPI document: 2022-04-01
701
+ *
702
+ *
703
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
704
+ * https://openapi-generator.tech
705
+ * Do not edit the class manually.
706
+ */
707
+ /**
708
+ * The product category or subcategory that is associated with an Amazon catalog item.
709
+ */
710
+ interface ItemVendorDetailsCategory {
711
+ /**
712
+ * The display name of the product category or subcategory.
713
+ */
714
+ 'displayName'?: string;
715
+ /**
716
+ * The code that identifies the product category or subcategory.
717
+ */
718
+ 'value'?: string;
719
+ }
720
+ //#endregion
721
+ //#region src/api-model/models/item-vendor-details-by-marketplace.d.ts
722
+ /**
723
+ * The vendor details that are associated with an Amazon catalog item for the specified `marketplaceId`.
724
+ */
725
+ interface ItemVendorDetailsByMarketplace {
726
+ /**
727
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
728
+ */
729
+ 'marketplaceId': string;
730
+ /**
731
+ * The brand code that is associated with an Amazon catalog item.
732
+ */
733
+ 'brandCode'?: string;
734
+ /**
735
+ * The manufacturer code that is associated with an Amazon catalog item.
736
+ */
737
+ 'manufacturerCode'?: string;
738
+ /**
739
+ * The parent vendor code of the manufacturer code.
740
+ */
741
+ 'manufacturerCodeParent'?: string;
742
+ 'productCategory'?: ItemVendorDetailsCategory;
743
+ /**
744
+ * The product group that is associated with an Amazon catalog item.
745
+ */
746
+ 'productGroup'?: string;
747
+ 'productSubcategory'?: ItemVendorDetailsCategory;
748
+ /**
749
+ * The replenishment category that is associated with an Amazon catalog item.
750
+ */
751
+ 'replenishmentCategory'?: ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum;
752
+ }
753
+ declare const ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum: {
754
+ readonly Allocated: "ALLOCATED";
755
+ readonly BasicReplenishment: "BASIC_REPLENISHMENT";
756
+ readonly InSeason: "IN_SEASON";
757
+ readonly LimitedReplenishment: "LIMITED_REPLENISHMENT";
758
+ readonly ManufacturerOutOfStock: "MANUFACTURER_OUT_OF_STOCK";
759
+ readonly NewProduct: "NEW_PRODUCT";
760
+ readonly NonReplenishable: "NON_REPLENISHABLE";
761
+ readonly NonStockupable: "NON_STOCKUPABLE";
762
+ readonly Obsolete: "OBSOLETE";
763
+ readonly PlannedReplenishment: "PLANNED_REPLENISHMENT";
764
+ };
765
+ type ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum = typeof ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum[keyof typeof ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum];
766
+ //#endregion
767
+ //#region src/api-model/models/item.d.ts
768
+ /**
769
+ * An item in the Amazon catalog.
770
+ */
771
+ interface Item {
772
+ /**
773
+ * The unique identifier of an item in the Amazon catalog.
774
+ */
775
+ 'asin': string;
776
+ /**
777
+ * 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).
778
+ */
779
+ 'attributes'?: {
780
+ [key: string]: any;
781
+ };
782
+ /**
783
+ * An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.
784
+ */
785
+ 'classifications'?: Array<ItemBrowseClassificationsByMarketplace>;
786
+ /**
787
+ * An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
788
+ */
789
+ 'dimensions'?: Array<ItemDimensionsByMarketplace>;
790
+ /**
791
+ * Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.
792
+ */
793
+ 'identifiers'?: Array<ItemIdentifiersByMarketplace>;
794
+ /**
795
+ * The images for an item in the Amazon catalog.
796
+ */
797
+ 'images'?: Array<ItemImagesByMarketplace>;
798
+ /**
799
+ * Product types that are associated with the Amazon catalog item.
800
+ */
801
+ 'productTypes'?: Array<ItemProductTypeByMarketplace>;
802
+ /**
803
+ * Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).
804
+ */
805
+ 'relationships'?: Array<ItemRelationshipsByMarketplace>;
806
+ /**
807
+ * Sales ranks of an Amazon catalog item.
808
+ */
809
+ 'salesRanks'?: Array<ItemSalesRanksByMarketplace>;
810
+ /**
811
+ * Summaries of Amazon catalog items.
812
+ */
813
+ 'summaries'?: Array<ItemSummaryByMarketplace>;
814
+ /**
815
+ * The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.
816
+ */
817
+ 'vendorDetails'?: Array<ItemVendorDetailsByMarketplace>;
818
+ }
819
+ //#endregion
820
+ //#region src/api-model/models/pagination.d.ts
821
+ /**
822
+ * Selling Partner API for Catalog Items
823
+ * 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).
824
+ *
825
+ * The version of the OpenAPI document: 2022-04-01
826
+ *
827
+ *
828
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
829
+ * https://openapi-generator.tech
830
+ * Do not edit the class manually.
831
+ */
832
+ /**
833
+ * 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.
834
+ */
835
+ interface Pagination {
836
+ /**
837
+ * A token that you can use to retrieve the next page.
838
+ */
839
+ 'nextToken'?: string;
840
+ /**
841
+ * A token that you can use to retrieve the previous page.
842
+ */
843
+ 'previousToken'?: string;
844
+ }
845
+ //#endregion
846
+ //#region src/api-model/models/refinements.d.ts
847
+ /**
848
+ * Optional fields that you can use to refine your search results.
849
+ */
850
+ interface Refinements {
851
+ /**
852
+ * A list of brands you can use to refine your search.
853
+ */
854
+ 'brands': Array<BrandRefinement>;
855
+ /**
856
+ * A list of classifications you can use to refine your search.
857
+ */
858
+ 'classifications': Array<ClassificationRefinement>;
859
+ }
860
+ //#endregion
861
+ //#region src/api-model/models/item-search-results.d.ts
862
+ /**
863
+ * Items in the Amazon catalog and search-related metadata.
864
+ */
865
+ interface ItemSearchResults {
866
+ /**
867
+ * 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.
868
+ */
869
+ 'numberOfResults': number;
870
+ 'pagination'?: Pagination;
871
+ 'refinements'?: Refinements;
872
+ /**
873
+ * A list of items from the Amazon catalog.
874
+ */
875
+ 'items': Array<Item>;
876
+ }
877
+ //#endregion
878
+ //#region src/api-model/models/model-error.d.ts
879
+ /**
880
+ * Selling Partner API for Catalog Items
881
+ * 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).
882
+ *
883
+ * The version of the OpenAPI document: 2022-04-01
884
+ *
885
+ *
886
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
887
+ * https://openapi-generator.tech
888
+ * Do not edit the class manually.
889
+ */
890
+ /**
891
+ * Error response returned when the request is unsuccessful.
892
+ */
893
+ interface ModelError {
894
+ /**
895
+ * An error code that identifies the type of error that occurred.
896
+ */
897
+ 'code': string;
898
+ /**
899
+ * A message that describes the error condition.
900
+ */
901
+ 'message': string;
902
+ /**
903
+ * Additional details that can help the caller understand or fix the issue.
904
+ */
905
+ 'details'?: string;
906
+ }
907
+ //#endregion
908
+ //#region src/api-model/api/catalog-items-api.d.ts
909
+ /**
910
+ * CatalogItemsApi - axios parameter creator
911
+ */
912
+ declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
913
+ /**
914
+ * 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).
915
+ * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
916
+ * @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).
917
+ * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
918
+ * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
919
+ * @param {*} [options] Override http request option.
920
+ * @throws {RequiredError}
921
+ */
922
+ getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
923
+ /**
924
+ * 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).
925
+ * @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).
926
+ * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;identifiers&#x60; and &#x60;keywords&#x60; in the same request.
927
+ * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** &#x60;identifiersType&#x60; is required when &#x60;identifiers&#x60; is in the request.
928
+ * @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
929
+ * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
930
+ * @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;.
931
+ * @param {Array<string>} [keywords] A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;keywords&#x60; and &#x60;identifiers&#x60; in the same request.
932
+ * @param {Array<string>} [brandNames] A comma-delimited list of brand names that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
933
+ * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
934
+ * @param {number} [pageSize] The number of results to include on each page.
935
+ * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results.
936
+ * @param {string} [keywordsLocale] The language of the keywords that are included in queries based on &#x60;keywords&#x60;. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
937
+ * @param {*} [options] Override http request option.
938
+ * @throws {RequiredError}
939
+ */
940
+ 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>;
941
+ };
942
+ /**
943
+ * CatalogItemsApi - functional programming interface
944
+ */
945
+ declare const CatalogItemsApiFp: (configuration?: Configuration) => {
946
+ /**
947
+ * 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).
948
+ * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
949
+ * @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).
950
+ * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
951
+ * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
952
+ * @param {*} [options] Override http request option.
953
+ * @throws {RequiredError}
954
+ */
955
+ getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
956
+ /**
957
+ * 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).
958
+ * @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).
959
+ * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;identifiers&#x60; and &#x60;keywords&#x60; in the same request.
960
+ * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** &#x60;identifiersType&#x60; is required when &#x60;identifiers&#x60; is in the request.
961
+ * @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
962
+ * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
963
+ * @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;.
964
+ * @param {Array<string>} [keywords] A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;keywords&#x60; and &#x60;identifiers&#x60; in the same request.
965
+ * @param {Array<string>} [brandNames] A comma-delimited list of brand names that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
966
+ * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
967
+ * @param {number} [pageSize] The number of results to include on each page.
968
+ * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results.
969
+ * @param {string} [keywordsLocale] The language of the keywords that are included in queries based on &#x60;keywords&#x60;. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
970
+ * @param {*} [options] Override http request option.
971
+ * @throws {RequiredError}
972
+ */
973
+ 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>>;
974
+ };
975
+ /**
976
+ * CatalogItemsApi - factory interface
977
+ */
978
+ declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
979
+ /**
980
+ * 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).
981
+ * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
982
+ * @param {*} [options] Override http request option.
983
+ * @throws {RequiredError}
984
+ */
985
+ getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
986
+ /**
987
+ * 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).
988
+ * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
989
+ * @param {*} [options] Override http request option.
990
+ * @throws {RequiredError}
991
+ */
992
+ searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>;
993
+ };
994
+ /**
995
+ * Request parameters for getCatalogItem operation in CatalogItemsApi.
996
+ */
997
+ interface CatalogItemsApiGetCatalogItemRequest {
998
+ /**
999
+ * The Amazon Standard Identification Number (ASIN) of the item.
1000
+ */
1001
+ readonly asin: string;
1002
+ /**
1003
+ * 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).
1004
+ */
1005
+ readonly marketplaceIds: Array<string>;
1006
+ /**
1007
+ * A comma-delimited list of datasets to include in the response.
1008
+ */
1009
+ readonly includedData?: Array<GetCatalogItemIncludedDataEnum>;
1010
+ /**
1011
+ * The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
1012
+ */
1013
+ readonly locale?: string;
1014
+ }
1015
+ /**
1016
+ * Request parameters for searchCatalogItems operation in CatalogItemsApi.
1017
+ */
1018
+ interface CatalogItemsApiSearchCatalogItemsRequest {
1019
+ /**
1020
+ * 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).
1021
+ */
1022
+ readonly marketplaceIds: Array<string>;
1023
+ /**
1024
+ * A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;identifiers&#x60; and &#x60;keywords&#x60; in the same request.
1025
+ */
1026
+ readonly identifiers?: Array<string>;
1027
+ /**
1028
+ * The type of product identifiers that you can use to search the Amazon catalog. **Note:** &#x60;identifiersType&#x60; is required when &#x60;identifiers&#x60; is in the request.
1029
+ */
1030
+ readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
1031
+ /**
1032
+ * A comma-delimited list of datasets to include in the response.
1033
+ */
1034
+ readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>;
1035
+ /**
1036
+ * The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
1037
+ */
1038
+ readonly locale?: string;
1039
+ /**
1040
+ * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
1041
+ */
1042
+ readonly sellerId?: string;
1043
+ /**
1044
+ * A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;keywords&#x60; and &#x60;identifiers&#x60; in the same request.
1045
+ */
1046
+ readonly keywords?: Array<string>;
1047
+ /**
1048
+ * A comma-delimited list of brand names that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
1049
+ */
1050
+ readonly brandNames?: Array<string>;
1051
+ /**
1052
+ * A comma-delimited list of classification identifiers that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
1053
+ */
1054
+ readonly classificationIds?: Array<string>;
1055
+ /**
1056
+ * The number of results to include on each page.
1057
+ */
1058
+ readonly pageSize?: number;
1059
+ /**
1060
+ * A token that you can use to fetch a specific page when there are multiple pages of results.
1061
+ */
1062
+ readonly pageToken?: string;
1063
+ /**
1064
+ * The language of the keywords that are included in queries based on &#x60;keywords&#x60;. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
1065
+ */
1066
+ readonly keywordsLocale?: string;
1067
+ }
1068
+ /**
1069
+ * CatalogItemsApi - object-oriented interface
1070
+ */
1071
+ declare class CatalogItemsApi extends BaseAPI {
1072
+ /**
1073
+ * 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).
1074
+ * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
1075
+ * @param {*} [options] Override http request option.
1076
+ * @throws {RequiredError}
1077
+ */
1078
+ getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Item, any, {}>>;
1079
+ /**
1080
+ * 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).
1081
+ * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
1082
+ * @param {*} [options] Override http request option.
1083
+ * @throws {RequiredError}
1084
+ */
1085
+ searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ItemSearchResults, any, {}>>;
1086
+ }
1087
+ declare const GetCatalogItemIncludedDataEnum: {
1088
+ readonly Attributes: "attributes";
1089
+ readonly Classifications: "classifications";
1090
+ readonly Dimensions: "dimensions";
1091
+ readonly Identifiers: "identifiers";
1092
+ readonly Images: "images";
1093
+ readonly ProductTypes: "productTypes";
1094
+ readonly Relationships: "relationships";
1095
+ readonly SalesRanks: "salesRanks";
1096
+ readonly Summaries: "summaries";
1097
+ readonly VendorDetails: "vendorDetails";
1098
+ };
1099
+ type GetCatalogItemIncludedDataEnum = typeof GetCatalogItemIncludedDataEnum[keyof typeof GetCatalogItemIncludedDataEnum];
1100
+ declare const SearchCatalogItemsIdentifiersTypeEnum: {
1101
+ readonly Asin: "ASIN";
1102
+ readonly Ean: "EAN";
1103
+ readonly Gtin: "GTIN";
1104
+ readonly Isbn: "ISBN";
1105
+ readonly Jan: "JAN";
1106
+ readonly Minsan: "MINSAN";
1107
+ readonly Sku: "SKU";
1108
+ readonly Upc: "UPC";
1109
+ };
1110
+ type SearchCatalogItemsIdentifiersTypeEnum = typeof SearchCatalogItemsIdentifiersTypeEnum[keyof typeof SearchCatalogItemsIdentifiersTypeEnum];
1111
+ declare const SearchCatalogItemsIncludedDataEnum: {
1112
+ readonly Attributes: "attributes";
1113
+ readonly Classifications: "classifications";
1114
+ readonly Dimensions: "dimensions";
1115
+ readonly Identifiers: "identifiers";
1116
+ readonly Images: "images";
1117
+ readonly ProductTypes: "productTypes";
1118
+ readonly Relationships: "relationships";
1119
+ readonly SalesRanks: "salesRanks";
1120
+ readonly Summaries: "summaries";
1121
+ readonly VendorDetails: "vendorDetails";
1122
+ };
1123
+ type SearchCatalogItemsIncludedDataEnum = typeof SearchCatalogItemsIncludedDataEnum[keyof typeof SearchCatalogItemsIncludedDataEnum];
1124
+ //#endregion
1125
+ //#region src/client.d.ts
1126
+ declare const clientRateLimits: RateLimit[];
1127
+ declare class CatalogItemsApiClient extends CatalogItemsApi {
1128
+ constructor(configuration: ClientConfiguration);
1129
+ }
1130
+ //#endregion
1131
+ export { BrandRefinement, CatalogItemsApi, CatalogItemsApiAxiosParamCreator, CatalogItemsApiClient, CatalogItemsApiFactory, CatalogItemsApiFp, CatalogItemsApiGetCatalogItemRequest, CatalogItemsApiSearchCatalogItemsRequest, ClassificationRefinement, Dimension, Dimensions, ErrorList, GetCatalogItemIncludedDataEnum, Item, ItemBrowseClassification, ItemBrowseClassificationsByMarketplace, ItemClassificationSalesRank, ItemContributor, ItemContributorRole, ItemDimensionsByMarketplace, ItemDisplayGroupSalesRank, ItemIdentifier, ItemIdentifiersByMarketplace, ItemImage, ItemImageVariantEnum, ItemImagesByMarketplace, ItemProductTypeByMarketplace, ItemRelationship, ItemRelationshipTypeEnum, ItemRelationshipsByMarketplace, ItemSalesRanksByMarketplace, ItemSearchResults, ItemSummaryByMarketplace, ItemSummaryByMarketplaceItemClassificationEnum, ItemVariationTheme, ItemVendorDetailsByMarketplace, ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum, ItemVendorDetailsCategory, ModelError, Pagination, Refinements, SearchCatalogItemsIdentifiersTypeEnum, SearchCatalogItemsIncludedDataEnum, clientRateLimits };
1132
+ //# sourceMappingURL=index.d.cts.map