@sp-api-sdk/fba-inventory-api-v1 3.0.22 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +553 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/{types/api-model/api/fba-inventory-api.d.ts → index.d.cts} +623 -24
  5. package/dist/index.d.ts +846 -0
  6. package/dist/index.js +509 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/fba-inventory-api.js +0 -355
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/add-inventory-request.js +0 -15
  16. package/dist/cjs/api-model/models/add-inventory-response.js +0 -15
  17. package/dist/cjs/api-model/models/create-inventory-item-request.js +0 -15
  18. package/dist/cjs/api-model/models/create-inventory-item-response.js +0 -15
  19. package/dist/cjs/api-model/models/delete-inventory-item-response.js +0 -15
  20. package/dist/cjs/api-model/models/get-inventory-summaries-response.js +0 -15
  21. package/dist/cjs/api-model/models/get-inventory-summaries-result.js +0 -15
  22. package/dist/cjs/api-model/models/granularity.js +0 -15
  23. package/dist/cjs/api-model/models/index.js +0 -33
  24. package/dist/cjs/api-model/models/inventory-details.js +0 -15
  25. package/dist/cjs/api-model/models/inventory-item.js +0 -15
  26. package/dist/cjs/api-model/models/inventory-summary.js +0 -15
  27. package/dist/cjs/api-model/models/model-error.js +0 -15
  28. package/dist/cjs/api-model/models/pagination.js +0 -15
  29. package/dist/cjs/api-model/models/researching-quantity-entry.js +0 -21
  30. package/dist/cjs/api-model/models/researching-quantity.js +0 -15
  31. package/dist/cjs/api-model/models/reserved-quantity.js +0 -15
  32. package/dist/cjs/api-model/models/unfulfillable-quantity.js +0 -15
  33. package/dist/cjs/client.js +0 -21
  34. package/dist/cjs/index.js +0 -19
  35. package/dist/es/api-model/api/fba-inventory-api.js +0 -345
  36. package/dist/es/api-model/api.js +0 -14
  37. package/dist/es/api-model/base.js +0 -44
  38. package/dist/es/api-model/common.js +0 -110
  39. package/dist/es/api-model/configuration.js +0 -94
  40. package/dist/es/api-model/index.js +0 -16
  41. package/dist/es/api-model/models/add-inventory-request.js +0 -14
  42. package/dist/es/api-model/models/add-inventory-response.js +0 -14
  43. package/dist/es/api-model/models/create-inventory-item-request.js +0 -14
  44. package/dist/es/api-model/models/create-inventory-item-response.js +0 -14
  45. package/dist/es/api-model/models/delete-inventory-item-response.js +0 -14
  46. package/dist/es/api-model/models/get-inventory-summaries-response.js +0 -14
  47. package/dist/es/api-model/models/get-inventory-summaries-result.js +0 -14
  48. package/dist/es/api-model/models/granularity.js +0 -14
  49. package/dist/es/api-model/models/index.js +0 -17
  50. package/dist/es/api-model/models/inventory-details.js +0 -14
  51. package/dist/es/api-model/models/inventory-item.js +0 -14
  52. package/dist/es/api-model/models/inventory-summary.js +0 -14
  53. package/dist/es/api-model/models/model-error.js +0 -14
  54. package/dist/es/api-model/models/pagination.js +0 -14
  55. package/dist/es/api-model/models/researching-quantity-entry.js +0 -18
  56. package/dist/es/api-model/models/researching-quantity.js +0 -14
  57. package/dist/es/api-model/models/reserved-quantity.js +0 -14
  58. package/dist/es/api-model/models/unfulfillable-quantity.js +0 -14
  59. package/dist/es/client.js +0 -17
  60. package/dist/es/index.js +0 -3
  61. package/dist/types/api-model/api.d.ts +0 -12
  62. package/dist/types/api-model/base.d.ts +0 -42
  63. package/dist/types/api-model/common.d.ts +0 -34
  64. package/dist/types/api-model/configuration.d.ts +0 -98
  65. package/dist/types/api-model/index.d.ts +0 -14
  66. package/dist/types/api-model/models/add-inventory-request.d.ts +0 -21
  67. package/dist/types/api-model/models/add-inventory-response.d.ts +0 -20
  68. package/dist/types/api-model/models/create-inventory-item-request.d.ts +0 -28
  69. package/dist/types/api-model/models/create-inventory-item-response.d.ts +0 -20
  70. package/dist/types/api-model/models/delete-inventory-item-response.d.ts +0 -20
  71. package/dist/types/api-model/models/get-inventory-summaries-response.d.ts +0 -24
  72. package/dist/types/api-model/models/get-inventory-summaries-result.d.ts +0 -23
  73. package/dist/types/api-model/models/granularity.d.ts +0 -24
  74. package/dist/types/api-model/models/index.d.ts +0 -17
  75. package/dist/types/api-model/models/inventory-details.d.ts +0 -38
  76. package/dist/types/api-model/models/inventory-item.d.ts +0 -28
  77. package/dist/types/api-model/models/inventory-summary.d.ts +0 -50
  78. package/dist/types/api-model/models/model-error.d.ts +0 -28
  79. package/dist/types/api-model/models/pagination.d.ts +0 -20
  80. package/dist/types/api-model/models/researching-quantity-entry.d.ts +0 -30
  81. package/dist/types/api-model/models/researching-quantity.d.ts +0 -25
  82. package/dist/types/api-model/models/reserved-quantity.d.ts +0 -32
  83. package/dist/types/api-model/models/unfulfillable-quantity.d.ts +0 -44
  84. package/dist/types/client.d.ts +0 -6
  85. package/dist/types/index.d.ts +0 -3
@@ -1,3 +1,296 @@
1
+ import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
2
+ import * as axios from 'axios';
3
+ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
4
+
5
+ /**
6
+ * Selling Partner API for FBA Inventory
7
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
8
+ *
9
+ * The version of the OpenAPI document: v1
10
+ *
11
+ *
12
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
13
+ * https://openapi-generator.tech
14
+ * Do not edit the class manually.
15
+ */
16
+ interface AWSv4Configuration {
17
+ options?: {
18
+ region?: string;
19
+ service?: string;
20
+ };
21
+ credentials?: {
22
+ accessKeyId?: string;
23
+ secretAccessKey?: string;
24
+ sessionToken?: string;
25
+ };
26
+ }
27
+ 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;
37
+ }
38
+ 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;
101
+ }
102
+
103
+ /**
104
+ * Selling Partner API for FBA Inventory
105
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
106
+ *
107
+ * The version of the OpenAPI document: v1
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
+
115
+ interface RequestArgs {
116
+ url: string;
117
+ options: RawAxiosRequestConfig;
118
+ }
119
+ declare class BaseAPI {
120
+ protected basePath: string;
121
+ protected axios: AxiosInstance;
122
+ protected configuration: Configuration | undefined;
123
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
124
+ }
125
+
126
+ /**
127
+ * Selling Partner API for FBA Inventory
128
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
129
+ *
130
+ * The version of the OpenAPI document: v1
131
+ *
132
+ *
133
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
134
+ * https://openapi-generator.tech
135
+ * Do not edit the class manually.
136
+ */
137
+ /**
138
+ * An item in the list of inventory to be added.
139
+ */
140
+ interface InventoryItem {
141
+ /**
142
+ * The seller SKU of the item.
143
+ */
144
+ 'sellerSku': string;
145
+ /**
146
+ * The marketplaceId.
147
+ */
148
+ 'marketplaceId': string;
149
+ /**
150
+ * The quantity of item to add.
151
+ */
152
+ 'quantity': number;
153
+ }
154
+
155
+ /**
156
+ * Selling Partner API for FBA Inventory
157
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
158
+ *
159
+ * The version of the OpenAPI document: v1
160
+ *
161
+ *
162
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
163
+ * https://openapi-generator.tech
164
+ * Do not edit the class manually.
165
+ */
166
+
167
+ /**
168
+ * The object with the list of Inventory to be added
169
+ */
170
+ interface AddInventoryRequest {
171
+ /**
172
+ * List of Inventory to be added
173
+ */
174
+ 'inventoryItems'?: Array<InventoryItem>;
175
+ }
176
+
177
+ /**
178
+ * Selling Partner API for FBA Inventory
179
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
180
+ *
181
+ * The version of the OpenAPI document: v1
182
+ *
183
+ *
184
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
185
+ * https://openapi-generator.tech
186
+ * Do not edit the class manually.
187
+ */
188
+ /**
189
+ * The response schema for the AddInventory operation.
190
+ */
191
+ interface AddInventoryResponse {
192
+ /**
193
+ * A list of error responses returned when a request is unsuccessful.
194
+ */
195
+ 'errors'?: Array<Error>;
196
+ }
197
+
198
+ /**
199
+ * Selling Partner API for FBA Inventory
200
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
201
+ *
202
+ * The version of the OpenAPI document: v1
203
+ *
204
+ *
205
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
206
+ * https://openapi-generator.tech
207
+ * Do not edit the class manually.
208
+ */
209
+ /**
210
+ * An item to be created in the inventory.
211
+ */
212
+ interface CreateInventoryItemRequest {
213
+ /**
214
+ * The seller SKU of the item.
215
+ */
216
+ 'sellerSku': string;
217
+ /**
218
+ * The marketplaceId.
219
+ */
220
+ 'marketplaceId': string;
221
+ /**
222
+ * The name of the item.
223
+ */
224
+ 'productName': string;
225
+ }
226
+
227
+ /**
228
+ * Selling Partner API for FBA Inventory
229
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
230
+ *
231
+ * The version of the OpenAPI document: v1
232
+ *
233
+ *
234
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
235
+ * https://openapi-generator.tech
236
+ * Do not edit the class manually.
237
+ */
238
+ /**
239
+ * The response schema for the CreateInventoryItem operation.
240
+ */
241
+ interface CreateInventoryItemResponse {
242
+ /**
243
+ * A list of error responses returned when a request is unsuccessful.
244
+ */
245
+ 'errors'?: Array<Error>;
246
+ }
247
+
248
+ /**
249
+ * Selling Partner API for FBA Inventory
250
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
251
+ *
252
+ * The version of the OpenAPI document: v1
253
+ *
254
+ *
255
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
256
+ * https://openapi-generator.tech
257
+ * Do not edit the class manually.
258
+ */
259
+ /**
260
+ * The response schema for the DeleteInventoryItem operation.
261
+ */
262
+ interface DeleteInventoryItemResponse {
263
+ /**
264
+ * A list of error responses returned when a request is unsuccessful.
265
+ */
266
+ 'errors'?: Array<Error>;
267
+ }
268
+
269
+ /**
270
+ * Selling Partner API for FBA Inventory
271
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
272
+ *
273
+ * The version of the OpenAPI document: v1
274
+ *
275
+ *
276
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
277
+ * https://openapi-generator.tech
278
+ * Do not edit the class manually.
279
+ */
280
+ /**
281
+ * Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace.
282
+ */
283
+ interface Granularity {
284
+ /**
285
+ * The granularity type for the inventory aggregation level.
286
+ */
287
+ 'granularityType'?: string;
288
+ /**
289
+ * The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId.
290
+ */
291
+ 'granularityId'?: string;
292
+ }
293
+
1
294
  /**
2
295
  * Selling Partner API for FBA Inventory
3
296
  * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
@@ -9,20 +302,319 @@
9
302
  * https://openapi-generator.tech
10
303
  * Do not edit the class manually.
11
304
  */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { AddInventoryRequest } from '../models';
17
- import type { AddInventoryResponse } from '../models';
18
- import type { CreateInventoryItemRequest } from '../models';
19
- import type { CreateInventoryItemResponse } from '../models';
20
- import type { DeleteInventoryItemResponse } from '../models';
21
- import type { GetInventorySummariesResponse } from '../models';
305
+ /**
306
+ * The misplaced or warehouse damaged inventory that is actively being confirmed at our fulfillment centers.
307
+ */
308
+ interface ResearchingQuantityEntry {
309
+ /**
310
+ * The duration of the research.
311
+ */
312
+ 'name': ResearchingQuantityEntryNameEnum;
313
+ /**
314
+ * The number of units.
315
+ */
316
+ 'quantity': number;
317
+ }
318
+ declare const ResearchingQuantityEntryNameEnum: {
319
+ readonly ResearchingQuantityInShortTerm: "researchingQuantityInShortTerm";
320
+ readonly ResearchingQuantityInMidTerm: "researchingQuantityInMidTerm";
321
+ readonly ResearchingQuantityInLongTerm: "researchingQuantityInLongTerm";
322
+ };
323
+ type ResearchingQuantityEntryNameEnum = typeof ResearchingQuantityEntryNameEnum[keyof typeof ResearchingQuantityEntryNameEnum];
324
+
325
+ /**
326
+ * Selling Partner API for FBA Inventory
327
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
328
+ *
329
+ * The version of the OpenAPI document: v1
330
+ *
331
+ *
332
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
333
+ * https://openapi-generator.tech
334
+ * Do not edit the class manually.
335
+ */
336
+
337
+ /**
338
+ * The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.
339
+ */
340
+ interface ResearchingQuantity {
341
+ /**
342
+ * The total number of units currently being researched in Amazon\'s fulfillment network.
343
+ */
344
+ 'totalResearchingQuantity'?: number;
345
+ /**
346
+ * A list of quantity details for items currently being researched.
347
+ */
348
+ 'researchingQuantityBreakdown'?: Array<ResearchingQuantityEntry>;
349
+ }
350
+
351
+ /**
352
+ * Selling Partner API for FBA Inventory
353
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
354
+ *
355
+ * The version of the OpenAPI document: v1
356
+ *
357
+ *
358
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
359
+ * https://openapi-generator.tech
360
+ * Do not edit the class manually.
361
+ */
362
+ /**
363
+ * The quantity of reserved inventory.
364
+ */
365
+ interface ReservedQuantity {
366
+ /**
367
+ * The total number of units in Amazon\'s fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes.
368
+ */
369
+ 'totalReservedQuantity'?: number;
370
+ /**
371
+ * The number of units reserved for customer orders.
372
+ */
373
+ 'pendingCustomerOrderQuantity'?: number;
374
+ /**
375
+ * The number of units being transferred from one fulfillment center to another.
376
+ */
377
+ 'pendingTransshipmentQuantity'?: number;
378
+ /**
379
+ * The number of units that have been sidelined at the fulfillment center for additional processing.
380
+ */
381
+ 'fcProcessingQuantity'?: number;
382
+ }
383
+
384
+ /**
385
+ * Selling Partner API for FBA Inventory
386
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
387
+ *
388
+ * The version of the OpenAPI document: v1
389
+ *
390
+ *
391
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
392
+ * https://openapi-generator.tech
393
+ * Do not edit the class manually.
394
+ */
395
+ /**
396
+ * The quantity of unfulfillable inventory.
397
+ */
398
+ interface UnfulfillableQuantity {
399
+ /**
400
+ * The total number of units in Amazon\'s fulfillment network in unsellable condition.
401
+ */
402
+ 'totalUnfulfillableQuantity'?: number;
403
+ /**
404
+ * The number of units in customer damaged disposition.
405
+ */
406
+ 'customerDamagedQuantity'?: number;
407
+ /**
408
+ * The number of units in warehouse damaged disposition.
409
+ */
410
+ 'warehouseDamagedQuantity'?: number;
411
+ /**
412
+ * The number of units in distributor damaged disposition.
413
+ */
414
+ 'distributorDamagedQuantity'?: number;
415
+ /**
416
+ * The number of units in carrier damaged disposition.
417
+ */
418
+ 'carrierDamagedQuantity'?: number;
419
+ /**
420
+ * The number of units in defective disposition.
421
+ */
422
+ 'defectiveQuantity'?: number;
423
+ /**
424
+ * The number of units in expired disposition.
425
+ */
426
+ 'expiredQuantity'?: number;
427
+ }
428
+
429
+ /**
430
+ * Selling Partner API for FBA Inventory
431
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
432
+ *
433
+ * The version of the OpenAPI document: v1
434
+ *
435
+ *
436
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
437
+ * https://openapi-generator.tech
438
+ * Do not edit the class manually.
439
+ */
440
+
441
+ /**
442
+ * Summarized inventory details. This object will not appear if the details parameter in the request is false.
443
+ */
444
+ interface InventoryDetails {
445
+ /**
446
+ * The item quantity that can be picked, packed, and shipped.
447
+ */
448
+ 'fulfillableQuantity'?: number;
449
+ /**
450
+ * The number of units in an inbound shipment for which you have notified Amazon.
451
+ */
452
+ 'inboundWorkingQuantity'?: number;
453
+ /**
454
+ * The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number.
455
+ */
456
+ 'inboundShippedQuantity'?: number;
457
+ /**
458
+ * The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed.
459
+ */
460
+ 'inboundReceivingQuantity'?: number;
461
+ 'reservedQuantity'?: ReservedQuantity;
462
+ 'researchingQuantity'?: ResearchingQuantity;
463
+ 'unfulfillableQuantity'?: UnfulfillableQuantity;
464
+ }
465
+
466
+ /**
467
+ * Selling Partner API for FBA Inventory
468
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
469
+ *
470
+ * The version of the OpenAPI document: v1
471
+ *
472
+ *
473
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
474
+ * https://openapi-generator.tech
475
+ * Do not edit the class manually.
476
+ */
477
+
478
+ /**
479
+ * Inventory summary for a specific item.
480
+ */
481
+ interface InventorySummary {
482
+ /**
483
+ * The Amazon Standard Identification Number (ASIN) of an item.
484
+ */
485
+ 'asin'?: string;
486
+ /**
487
+ * Amazon\'s fulfillment network SKU identifier.
488
+ */
489
+ 'fnSku'?: string;
490
+ /**
491
+ * The seller SKU of the item.
492
+ */
493
+ 'sellerSku'?: string;
494
+ /**
495
+ * The condition of the item as described by the seller (for example, New Item).
496
+ */
497
+ 'condition'?: string;
498
+ 'inventoryDetails'?: InventoryDetails;
499
+ /**
500
+ * The date and time that any quantity was last updated.
501
+ */
502
+ 'lastUpdatedTime'?: string;
503
+ /**
504
+ * The localized language product title of the item within the specific marketplace.
505
+ */
506
+ 'productName'?: string;
507
+ /**
508
+ * The total number of units in an inbound shipment or in Amazon fulfillment centers.
509
+ */
510
+ 'totalQuantity'?: number;
511
+ /**
512
+ * A list of seller-enrolled stores that apply to this seller SKU.
513
+ */
514
+ 'stores'?: Array<string>;
515
+ }
516
+
517
+ /**
518
+ * Selling Partner API for FBA Inventory
519
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
520
+ *
521
+ * The version of the OpenAPI document: v1
522
+ *
523
+ *
524
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
525
+ * https://openapi-generator.tech
526
+ * Do not edit the class manually.
527
+ */
528
+
529
+ /**
530
+ * The payload schema for the getInventorySummaries operation.
531
+ */
532
+ interface GetInventorySummariesResult {
533
+ 'granularity': Granularity;
534
+ /**
535
+ * A list of inventory summaries.
536
+ */
537
+ 'inventorySummaries': Array<InventorySummary>;
538
+ }
539
+
540
+ /**
541
+ * Selling Partner API for FBA Inventory
542
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
543
+ *
544
+ * The version of the OpenAPI document: v1
545
+ *
546
+ *
547
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
548
+ * https://openapi-generator.tech
549
+ * Do not edit the class manually.
550
+ */
551
+ /**
552
+ * The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It\'s a form of traffic management.
553
+ */
554
+ interface Pagination {
555
+ /**
556
+ * A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.
557
+ */
558
+ 'nextToken'?: string;
559
+ }
560
+
561
+ /**
562
+ * Selling Partner API for FBA Inventory
563
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
564
+ *
565
+ * The version of the OpenAPI document: v1
566
+ *
567
+ *
568
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
569
+ * https://openapi-generator.tech
570
+ * Do not edit the class manually.
571
+ */
572
+
573
+ /**
574
+ * The Response schema.
575
+ */
576
+ interface GetInventorySummariesResponse {
577
+ 'payload'?: GetInventorySummariesResult;
578
+ 'pagination'?: Pagination;
579
+ /**
580
+ * A list of error responses returned when a request is unsuccessful.
581
+ */
582
+ 'errors'?: Array<Error>;
583
+ }
584
+
585
+ /**
586
+ * Selling Partner API for FBA Inventory
587
+ * The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
588
+ *
589
+ * The version of the OpenAPI document: v1
590
+ *
591
+ *
592
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
593
+ * https://openapi-generator.tech
594
+ * Do not edit the class manually.
595
+ */
596
+ /**
597
+ * An error response returned when the request is unsuccessful.
598
+ */
599
+ interface ModelError {
600
+ /**
601
+ * An error code that identifies the type of error that occurred.
602
+ */
603
+ 'code': string;
604
+ /**
605
+ * A message that describes the error condition in a human-readable form.
606
+ */
607
+ 'message'?: string;
608
+ /**
609
+ * Additional information that can help the caller understand or fix the issue.
610
+ */
611
+ 'details'?: string;
612
+ }
613
+
22
614
  /**
23
615
  * FbaInventoryApi - axios parameter creator
24
616
  */
25
- export declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
617
+ declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
26
618
  /**
27
619
  * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
28
620
  * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency.
@@ -64,7 +656,7 @@ export declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configur
64
656
  /**
65
657
  * FbaInventoryApi - functional programming interface
66
658
  */
67
- export declare const FbaInventoryApiFp: (configuration?: Configuration) => {
659
+ declare const FbaInventoryApiFp: (configuration?: Configuration) => {
68
660
  /**
69
661
  * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
70
662
  * @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency.
@@ -106,7 +698,7 @@ export declare const FbaInventoryApiFp: (configuration?: Configuration) => {
106
698
  /**
107
699
  * FbaInventoryApi - factory interface
108
700
  */
109
- export declare const FbaInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
701
+ declare const FbaInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
110
702
  /**
111
703
  * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
112
704
  * @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
@@ -139,7 +731,7 @@ export declare const FbaInventoryApiFactory: (configuration?: Configuration, bas
139
731
  /**
140
732
  * Request parameters for addInventory operation in FbaInventoryApi.
141
733
  */
142
- export interface FbaInventoryApiAddInventoryRequest {
734
+ interface FbaInventoryApiAddInventoryRequest {
143
735
  /**
144
736
  * A unique token/requestId provided with each call to ensure idempotency.
145
737
  */
@@ -152,7 +744,7 @@ export interface FbaInventoryApiAddInventoryRequest {
152
744
  /**
153
745
  * Request parameters for createInventoryItem operation in FbaInventoryApi.
154
746
  */
155
- export interface FbaInventoryApiCreateInventoryItemRequest {
747
+ interface FbaInventoryApiCreateInventoryItemRequest {
156
748
  /**
157
749
  * CreateInventoryItem Request Body Parameter.
158
750
  */
@@ -161,7 +753,7 @@ export interface FbaInventoryApiCreateInventoryItemRequest {
161
753
  /**
162
754
  * Request parameters for deleteInventoryItem operation in FbaInventoryApi.
163
755
  */
164
- export interface FbaInventoryApiDeleteInventoryItemRequest {
756
+ interface FbaInventoryApiDeleteInventoryItemRequest {
165
757
  /**
166
758
  * A single seller SKU used for querying the specified seller SKU inventory summaries.
167
759
  */
@@ -174,7 +766,7 @@ export interface FbaInventoryApiDeleteInventoryItemRequest {
174
766
  /**
175
767
  * Request parameters for getInventorySummaries operation in FbaInventoryApi.
176
768
  */
177
- export interface FbaInventoryApiGetInventorySummariesRequest {
769
+ interface FbaInventoryApiGetInventorySummariesRequest {
178
770
  /**
179
771
  * The granularity type for the inventory aggregation level.
180
772
  */
@@ -211,37 +803,44 @@ export interface FbaInventoryApiGetInventorySummariesRequest {
211
803
  /**
212
804
  * FbaInventoryApi - object-oriented interface
213
805
  */
214
- export declare class FbaInventoryApi extends BaseAPI {
806
+ declare class FbaInventoryApi extends BaseAPI {
215
807
  /**
216
808
  * Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
217
809
  * @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
218
810
  * @param {*} [options] Override http request option.
219
811
  * @throws {RequiredError}
220
812
  */
221
- addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AddInventoryResponse, any, {}>>;
813
+ addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<AddInventoryResponse, any, {}>>;
222
814
  /**
223
815
  * Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
224
816
  * @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters.
225
817
  * @param {*} [options] Override http request option.
226
818
  * @throws {RequiredError}
227
819
  */
228
- createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInventoryItemResponse, any, {}>>;
820
+ createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateInventoryItemResponse, any, {}>>;
229
821
  /**
230
822
  * Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
231
823
  * @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters.
232
824
  * @param {*} [options] Override http request option.
233
825
  * @throws {RequiredError}
234
826
  */
235
- deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteInventoryItemResponse, any, {}>>;
827
+ deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<DeleteInventoryItemResponse, any, {}>>;
236
828
  /**
237
829
  * Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters: - All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted. - When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified. - When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored. - When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
238
830
  * @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
239
831
  * @param {*} [options] Override http request option.
240
832
  * @throws {RequiredError}
241
833
  */
242
- getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInventorySummariesResponse, any, {}>>;
834
+ getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetInventorySummariesResponse, any, {}>>;
243
835
  }
244
- export declare const GetInventorySummariesGranularityTypeEnum: {
836
+ declare const GetInventorySummariesGranularityTypeEnum: {
245
837
  readonly Marketplace: "Marketplace";
246
838
  };
247
- export type GetInventorySummariesGranularityTypeEnum = typeof GetInventorySummariesGranularityTypeEnum[keyof typeof GetInventorySummariesGranularityTypeEnum];
839
+ type GetInventorySummariesGranularityTypeEnum = typeof GetInventorySummariesGranularityTypeEnum[keyof typeof GetInventorySummariesGranularityTypeEnum];
840
+
841
+ declare const clientRateLimits: RateLimit[];
842
+ declare class FbaInventoryApiClient extends FbaInventoryApi {
843
+ constructor(configuration: ClientConfiguration);
844
+ }
845
+
846
+ export { type AddInventoryRequest, type AddInventoryResponse, type CreateInventoryItemRequest, type CreateInventoryItemResponse, type DeleteInventoryItemResponse, FbaInventoryApi, type FbaInventoryApiAddInventoryRequest, FbaInventoryApiAxiosParamCreator, FbaInventoryApiClient, type FbaInventoryApiCreateInventoryItemRequest, type FbaInventoryApiDeleteInventoryItemRequest, FbaInventoryApiFactory, FbaInventoryApiFp, type FbaInventoryApiGetInventorySummariesRequest, GetInventorySummariesGranularityTypeEnum, type GetInventorySummariesResponse, type GetInventorySummariesResult, type Granularity, type InventoryDetails, type InventoryItem, type InventorySummary, type ModelError, type Pagination, type ResearchingQuantity, type ResearchingQuantityEntry, ResearchingQuantityEntryNameEnum, type ReservedQuantity, type UnfulfillableQuantity, clientRateLimits };