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