@sp-api-sdk/fba-inventory-api-v1 4.0.0 → 4.1.1
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.
- package/README.md +3 -4
- package/dist/index.cjs +496 -521
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +506 -570
- package/dist/index.d.ts +506 -570
- package/dist/index.js +471 -483
- package/dist/index.js.map +1 -1
- package/package.json +14 -6
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
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 FBA Inventory
|
|
7
6
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -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
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
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
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
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
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
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 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
|
-
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
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/inventory-item.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for FBA Inventory
|
|
128
117
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -138,42 +127,32 @@ declare class BaseAPI {
|
|
|
138
127
|
* An item in the list of inventory to be added.
|
|
139
128
|
*/
|
|
140
129
|
interface InventoryItem {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The seller SKU of the item.
|
|
132
|
+
*/
|
|
133
|
+
'sellerSku': string;
|
|
134
|
+
/**
|
|
135
|
+
* The marketplaceId.
|
|
136
|
+
*/
|
|
137
|
+
'marketplaceId': string;
|
|
138
|
+
/**
|
|
139
|
+
* The quantity of item to add.
|
|
140
|
+
*/
|
|
141
|
+
'quantity': number;
|
|
153
142
|
}
|
|
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
|
-
|
|
143
|
+
//#endregion
|
|
144
|
+
//#region src/api-model/models/add-inventory-request.d.ts
|
|
167
145
|
/**
|
|
168
146
|
* The object with the list of Inventory to be added
|
|
169
147
|
*/
|
|
170
148
|
interface AddInventoryRequest {
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
149
|
+
/**
|
|
150
|
+
* List of Inventory to be added
|
|
151
|
+
*/
|
|
152
|
+
'inventoryItems'?: Array<InventoryItem>;
|
|
175
153
|
}
|
|
176
|
-
|
|
154
|
+
//#endregion
|
|
155
|
+
//#region src/api-model/models/add-inventory-response.d.ts
|
|
177
156
|
/**
|
|
178
157
|
* Selling Partner API for FBA Inventory
|
|
179
158
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -189,12 +168,13 @@ interface AddInventoryRequest {
|
|
|
189
168
|
* The response schema for the AddInventory operation.
|
|
190
169
|
*/
|
|
191
170
|
interface AddInventoryResponse {
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
171
|
+
/**
|
|
172
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
173
|
+
*/
|
|
174
|
+
'errors'?: Array<Error>;
|
|
196
175
|
}
|
|
197
|
-
|
|
176
|
+
//#endregion
|
|
177
|
+
//#region src/api-model/models/create-inventory-item-request.d.ts
|
|
198
178
|
/**
|
|
199
179
|
* Selling Partner API for FBA Inventory
|
|
200
180
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -210,20 +190,21 @@ interface AddInventoryResponse {
|
|
|
210
190
|
* An item to be created in the inventory.
|
|
211
191
|
*/
|
|
212
192
|
interface CreateInventoryItemRequest {
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
193
|
+
/**
|
|
194
|
+
* The seller SKU of the item.
|
|
195
|
+
*/
|
|
196
|
+
'sellerSku': string;
|
|
197
|
+
/**
|
|
198
|
+
* The marketplaceId.
|
|
199
|
+
*/
|
|
200
|
+
'marketplaceId': string;
|
|
201
|
+
/**
|
|
202
|
+
* The name of the item.
|
|
203
|
+
*/
|
|
204
|
+
'productName': string;
|
|
225
205
|
}
|
|
226
|
-
|
|
206
|
+
//#endregion
|
|
207
|
+
//#region src/api-model/models/create-inventory-item-response.d.ts
|
|
227
208
|
/**
|
|
228
209
|
* Selling Partner API for FBA Inventory
|
|
229
210
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -239,12 +220,13 @@ interface CreateInventoryItemRequest {
|
|
|
239
220
|
* The response schema for the CreateInventoryItem operation.
|
|
240
221
|
*/
|
|
241
222
|
interface CreateInventoryItemResponse {
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
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/delete-inventory-item-response.d.ts
|
|
248
230
|
/**
|
|
249
231
|
* Selling Partner API for FBA Inventory
|
|
250
232
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -260,12 +242,13 @@ interface CreateInventoryItemResponse {
|
|
|
260
242
|
* The response schema for the DeleteInventoryItem operation.
|
|
261
243
|
*/
|
|
262
244
|
interface DeleteInventoryItemResponse {
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
245
|
+
/**
|
|
246
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
247
|
+
*/
|
|
248
|
+
'errors'?: Array<Error>;
|
|
267
249
|
}
|
|
268
|
-
|
|
250
|
+
//#endregion
|
|
251
|
+
//#region src/api-model/models/granularity.d.ts
|
|
269
252
|
/**
|
|
270
253
|
* Selling Partner API for FBA Inventory
|
|
271
254
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -281,16 +264,17 @@ interface DeleteInventoryItemResponse {
|
|
|
281
264
|
* 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
265
|
*/
|
|
283
266
|
interface Granularity {
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
267
|
+
/**
|
|
268
|
+
* The granularity type for the inventory aggregation level.
|
|
269
|
+
*/
|
|
270
|
+
'granularityType'?: string;
|
|
271
|
+
/**
|
|
272
|
+
* The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId.
|
|
273
|
+
*/
|
|
274
|
+
'granularityId'?: string;
|
|
292
275
|
}
|
|
293
|
-
|
|
276
|
+
//#endregion
|
|
277
|
+
//#region src/api-model/models/researching-quantity-entry.d.ts
|
|
294
278
|
/**
|
|
295
279
|
* Selling Partner API for FBA Inventory
|
|
296
280
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -306,48 +290,38 @@ interface Granularity {
|
|
|
306
290
|
* The misplaced or warehouse damaged inventory that is actively being confirmed at our fulfillment centers.
|
|
307
291
|
*/
|
|
308
292
|
interface ResearchingQuantityEntry {
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
293
|
+
/**
|
|
294
|
+
* The duration of the research.
|
|
295
|
+
*/
|
|
296
|
+
'name': ResearchingQuantityEntryNameEnum;
|
|
297
|
+
/**
|
|
298
|
+
* The number of units.
|
|
299
|
+
*/
|
|
300
|
+
'quantity': number;
|
|
317
301
|
}
|
|
318
302
|
declare const ResearchingQuantityEntryNameEnum: {
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
303
|
+
readonly ResearchingQuantityInShortTerm: "researchingQuantityInShortTerm";
|
|
304
|
+
readonly ResearchingQuantityInMidTerm: "researchingQuantityInMidTerm";
|
|
305
|
+
readonly ResearchingQuantityInLongTerm: "researchingQuantityInLongTerm";
|
|
322
306
|
};
|
|
323
307
|
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
|
-
|
|
308
|
+
//#endregion
|
|
309
|
+
//#region src/api-model/models/researching-quantity.d.ts
|
|
337
310
|
/**
|
|
338
311
|
* The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.
|
|
339
312
|
*/
|
|
340
313
|
interface ResearchingQuantity {
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
314
|
+
/**
|
|
315
|
+
* The total number of units currently being researched in Amazon\'s fulfillment network.
|
|
316
|
+
*/
|
|
317
|
+
'totalResearchingQuantity'?: number;
|
|
318
|
+
/**
|
|
319
|
+
* A list of quantity details for items currently being researched.
|
|
320
|
+
*/
|
|
321
|
+
'researchingQuantityBreakdown'?: Array<ResearchingQuantityEntry>;
|
|
349
322
|
}
|
|
350
|
-
|
|
323
|
+
//#endregion
|
|
324
|
+
//#region src/api-model/models/reserved-quantity.d.ts
|
|
351
325
|
/**
|
|
352
326
|
* Selling Partner API for FBA Inventory
|
|
353
327
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -363,24 +337,25 @@ interface ResearchingQuantity {
|
|
|
363
337
|
* The quantity of reserved inventory.
|
|
364
338
|
*/
|
|
365
339
|
interface ReservedQuantity {
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
340
|
+
/**
|
|
341
|
+
* 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.
|
|
342
|
+
*/
|
|
343
|
+
'totalReservedQuantity'?: number;
|
|
344
|
+
/**
|
|
345
|
+
* The number of units reserved for customer orders.
|
|
346
|
+
*/
|
|
347
|
+
'pendingCustomerOrderQuantity'?: number;
|
|
348
|
+
/**
|
|
349
|
+
* The number of units being transferred from one fulfillment center to another.
|
|
350
|
+
*/
|
|
351
|
+
'pendingTransshipmentQuantity'?: number;
|
|
352
|
+
/**
|
|
353
|
+
* The number of units that have been sidelined at the fulfillment center for additional processing.
|
|
354
|
+
*/
|
|
355
|
+
'fcProcessingQuantity'?: number;
|
|
382
356
|
}
|
|
383
|
-
|
|
357
|
+
//#endregion
|
|
358
|
+
//#region src/api-model/models/unfulfillable-quantity.d.ts
|
|
384
359
|
/**
|
|
385
360
|
* Selling Partner API for FBA Inventory
|
|
386
361
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -396,147 +371,115 @@ interface ReservedQuantity {
|
|
|
396
371
|
* The quantity of unfulfillable inventory.
|
|
397
372
|
*/
|
|
398
373
|
interface UnfulfillableQuantity {
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
374
|
+
/**
|
|
375
|
+
* The total number of units in Amazon\'s fulfillment network in unsellable condition.
|
|
376
|
+
*/
|
|
377
|
+
'totalUnfulfillableQuantity'?: number;
|
|
378
|
+
/**
|
|
379
|
+
* The number of units in customer damaged disposition.
|
|
380
|
+
*/
|
|
381
|
+
'customerDamagedQuantity'?: number;
|
|
382
|
+
/**
|
|
383
|
+
* The number of units in warehouse damaged disposition.
|
|
384
|
+
*/
|
|
385
|
+
'warehouseDamagedQuantity'?: number;
|
|
386
|
+
/**
|
|
387
|
+
* The number of units in distributor damaged disposition.
|
|
388
|
+
*/
|
|
389
|
+
'distributorDamagedQuantity'?: number;
|
|
390
|
+
/**
|
|
391
|
+
* The number of units in carrier damaged disposition.
|
|
392
|
+
*/
|
|
393
|
+
'carrierDamagedQuantity'?: number;
|
|
394
|
+
/**
|
|
395
|
+
* The number of units in defective disposition.
|
|
396
|
+
*/
|
|
397
|
+
'defectiveQuantity'?: number;
|
|
398
|
+
/**
|
|
399
|
+
* The number of units in expired disposition.
|
|
400
|
+
*/
|
|
401
|
+
'expiredQuantity'?: number;
|
|
427
402
|
}
|
|
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
|
-
|
|
403
|
+
//#endregion
|
|
404
|
+
//#region src/api-model/models/inventory-details.d.ts
|
|
441
405
|
/**
|
|
442
406
|
* Summarized inventory details. This object will not appear if the details parameter in the request is false.
|
|
443
407
|
*/
|
|
444
408
|
interface InventoryDetails {
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
409
|
+
/**
|
|
410
|
+
* The item quantity that can be picked, packed, and shipped.
|
|
411
|
+
*/
|
|
412
|
+
'fulfillableQuantity'?: number;
|
|
413
|
+
/**
|
|
414
|
+
* The number of units in an inbound shipment for which you have notified Amazon.
|
|
415
|
+
*/
|
|
416
|
+
'inboundWorkingQuantity'?: number;
|
|
417
|
+
/**
|
|
418
|
+
* The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number.
|
|
419
|
+
*/
|
|
420
|
+
'inboundShippedQuantity'?: number;
|
|
421
|
+
/**
|
|
422
|
+
* 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.
|
|
423
|
+
*/
|
|
424
|
+
'inboundReceivingQuantity'?: number;
|
|
425
|
+
'reservedQuantity'?: ReservedQuantity;
|
|
426
|
+
'researchingQuantity'?: ResearchingQuantity;
|
|
427
|
+
'unfulfillableQuantity'?: UnfulfillableQuantity;
|
|
464
428
|
}
|
|
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
|
-
|
|
429
|
+
//#endregion
|
|
430
|
+
//#region src/api-model/models/inventory-summary.d.ts
|
|
478
431
|
/**
|
|
479
432
|
* Inventory summary for a specific item.
|
|
480
433
|
*/
|
|
481
434
|
interface InventorySummary {
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
435
|
+
/**
|
|
436
|
+
* The Amazon Standard Identification Number (ASIN) of an item.
|
|
437
|
+
*/
|
|
438
|
+
'asin'?: string;
|
|
439
|
+
/**
|
|
440
|
+
* Amazon\'s fulfillment network SKU identifier.
|
|
441
|
+
*/
|
|
442
|
+
'fnSku'?: string;
|
|
443
|
+
/**
|
|
444
|
+
* The seller SKU of the item.
|
|
445
|
+
*/
|
|
446
|
+
'sellerSku'?: string;
|
|
447
|
+
/**
|
|
448
|
+
* The condition of the item as described by the seller (for example, New Item).
|
|
449
|
+
*/
|
|
450
|
+
'condition'?: string;
|
|
451
|
+
'inventoryDetails'?: InventoryDetails;
|
|
452
|
+
/**
|
|
453
|
+
* The date and time that any quantity was last updated.
|
|
454
|
+
*/
|
|
455
|
+
'lastUpdatedTime'?: string;
|
|
456
|
+
/**
|
|
457
|
+
* The localized language product title of the item within the specific marketplace.
|
|
458
|
+
*/
|
|
459
|
+
'productName'?: string;
|
|
460
|
+
/**
|
|
461
|
+
* The total number of units in an inbound shipment or in Amazon fulfillment centers.
|
|
462
|
+
*/
|
|
463
|
+
'totalQuantity'?: number;
|
|
464
|
+
/**
|
|
465
|
+
* A list of seller-enrolled stores that apply to this seller SKU.
|
|
466
|
+
*/
|
|
467
|
+
'stores'?: Array<string>;
|
|
515
468
|
}
|
|
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
|
-
|
|
469
|
+
//#endregion
|
|
470
|
+
//#region src/api-model/models/get-inventory-summaries-result.d.ts
|
|
529
471
|
/**
|
|
530
472
|
* The payload schema for the getInventorySummaries operation.
|
|
531
473
|
*/
|
|
532
474
|
interface GetInventorySummariesResult {
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
475
|
+
'granularity': Granularity;
|
|
476
|
+
/**
|
|
477
|
+
* A list of inventory summaries.
|
|
478
|
+
*/
|
|
479
|
+
'inventorySummaries': Array<InventorySummary>;
|
|
538
480
|
}
|
|
539
|
-
|
|
481
|
+
//#endregion
|
|
482
|
+
//#region src/api-model/models/pagination.d.ts
|
|
540
483
|
/**
|
|
541
484
|
* Selling Partner API for FBA Inventory
|
|
542
485
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -552,36 +495,26 @@ interface GetInventorySummariesResult {
|
|
|
552
495
|
* 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
496
|
*/
|
|
554
497
|
interface Pagination {
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
498
|
+
/**
|
|
499
|
+
* 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.
|
|
500
|
+
*/
|
|
501
|
+
'nextToken'?: string;
|
|
559
502
|
}
|
|
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
|
-
|
|
503
|
+
//#endregion
|
|
504
|
+
//#region src/api-model/models/get-inventory-summaries-response.d.ts
|
|
573
505
|
/**
|
|
574
506
|
* The Response schema.
|
|
575
507
|
*/
|
|
576
508
|
interface GetInventorySummariesResponse {
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
509
|
+
'payload'?: GetInventorySummariesResult;
|
|
510
|
+
'pagination'?: Pagination;
|
|
511
|
+
/**
|
|
512
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
513
|
+
*/
|
|
514
|
+
'errors'?: Array<Error>;
|
|
583
515
|
}
|
|
584
|
-
|
|
516
|
+
//#endregion
|
|
517
|
+
//#region src/api-model/models/model-error.d.ts
|
|
585
518
|
/**
|
|
586
519
|
* Selling Partner API for FBA Inventory
|
|
587
520
|
* The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon\'s fulfillment network.
|
|
@@ -597,250 +530,253 @@ interface GetInventorySummariesResponse {
|
|
|
597
530
|
* An error response returned when the request is unsuccessful.
|
|
598
531
|
*/
|
|
599
532
|
interface ModelError {
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
533
|
+
/**
|
|
534
|
+
* An error code that identifies the type of error that occurred.
|
|
535
|
+
*/
|
|
536
|
+
'code': string;
|
|
537
|
+
/**
|
|
538
|
+
* A message that describes the error condition in a human-readable form.
|
|
539
|
+
*/
|
|
540
|
+
'message'?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Additional information that can help the caller understand or fix the issue.
|
|
543
|
+
*/
|
|
544
|
+
'details'?: string;
|
|
612
545
|
}
|
|
613
|
-
|
|
546
|
+
//#endregion
|
|
547
|
+
//#region src/api-model/api/fba-inventory-api.d.ts
|
|
614
548
|
/**
|
|
615
549
|
* FbaInventoryApi - axios parameter creator
|
|
616
550
|
*/
|
|
617
551
|
declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
552
|
+
/**
|
|
553
|
+
* 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.
|
|
554
|
+
* @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency.
|
|
555
|
+
* @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory.
|
|
556
|
+
* @param {*} [options] Override http request option.
|
|
557
|
+
* @throws {RequiredError}
|
|
558
|
+
*/
|
|
559
|
+
addInventory: (xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
560
|
+
/**
|
|
561
|
+
* 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.
|
|
562
|
+
* @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter.
|
|
563
|
+
* @param {*} [options] Override http request option.
|
|
564
|
+
* @throws {RequiredError}
|
|
565
|
+
*/
|
|
566
|
+
createInventoryItem: (createInventoryItemRequestBody: CreateInventoryItemRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
567
|
+
/**
|
|
568
|
+
* 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.
|
|
569
|
+
* @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
570
|
+
* @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted.
|
|
571
|
+
* @param {*} [options] Override http request option.
|
|
572
|
+
* @throws {RequiredError}
|
|
573
|
+
*/
|
|
574
|
+
deleteInventoryItem: (sellerSku: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
575
|
+
/**
|
|
576
|
+
* 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).
|
|
577
|
+
* @param {GetInventorySummariesGranularityTypeEnum} granularityType The granularity type for the inventory aggregation level.
|
|
578
|
+
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
579
|
+
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
580
|
+
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
581
|
+
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
582
|
+
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
583
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
584
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
585
|
+
* @param {*} [options] Override http request option.
|
|
586
|
+
* @throws {RequiredError}
|
|
587
|
+
*/
|
|
588
|
+
getInventorySummaries: (granularityType: GetInventorySummariesGranularityTypeEnum, granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, sellerSku?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
655
589
|
};
|
|
656
590
|
/**
|
|
657
591
|
* FbaInventoryApi - functional programming interface
|
|
658
592
|
*/
|
|
659
593
|
declare const FbaInventoryApiFp: (configuration?: Configuration) => {
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
594
|
+
/**
|
|
595
|
+
* 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.
|
|
596
|
+
* @param {string} xAmznIdempotencyToken A unique token/requestId provided with each call to ensure idempotency.
|
|
597
|
+
* @param {AddInventoryRequest} addInventoryRequestBody List of items to add to Sandbox inventory.
|
|
598
|
+
* @param {*} [options] Override http request option.
|
|
599
|
+
* @throws {RequiredError}
|
|
600
|
+
*/
|
|
601
|
+
addInventory(xAmznIdempotencyToken: string, addInventoryRequestBody: AddInventoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddInventoryResponse>>;
|
|
602
|
+
/**
|
|
603
|
+
* 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.
|
|
604
|
+
* @param {CreateInventoryItemRequest} createInventoryItemRequestBody CreateInventoryItem Request Body Parameter.
|
|
605
|
+
* @param {*} [options] Override http request option.
|
|
606
|
+
* @throws {RequiredError}
|
|
607
|
+
*/
|
|
608
|
+
createInventoryItem(createInventoryItemRequestBody: CreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInventoryItemResponse>>;
|
|
609
|
+
/**
|
|
610
|
+
* 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.
|
|
611
|
+
* @param {string} sellerSku A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
612
|
+
* @param {string} marketplaceId The marketplace ID for the marketplace for which the sellerSku is to be deleted.
|
|
613
|
+
* @param {*} [options] Override http request option.
|
|
614
|
+
* @throws {RequiredError}
|
|
615
|
+
*/
|
|
616
|
+
deleteInventoryItem(sellerSku: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteInventoryItemResponse>>;
|
|
617
|
+
/**
|
|
618
|
+
* 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).
|
|
619
|
+
* @param {GetInventorySummariesGranularityTypeEnum} granularityType The granularity type for the inventory aggregation level.
|
|
620
|
+
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
621
|
+
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
622
|
+
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
623
|
+
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
624
|
+
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
625
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
626
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
627
|
+
* @param {*} [options] Override http request option.
|
|
628
|
+
* @throws {RequiredError}
|
|
629
|
+
*/
|
|
630
|
+
getInventorySummaries(granularityType: GetInventorySummariesGranularityTypeEnum, granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, sellerSku?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventorySummariesResponse>>;
|
|
697
631
|
};
|
|
698
632
|
/**
|
|
699
633
|
* FbaInventoryApi - factory interface
|
|
700
634
|
*/
|
|
701
635
|
declare const FbaInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
636
|
+
/**
|
|
637
|
+
* 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.
|
|
638
|
+
* @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
|
|
639
|
+
* @param {*} [options] Override http request option.
|
|
640
|
+
* @throws {RequiredError}
|
|
641
|
+
*/
|
|
642
|
+
addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddInventoryResponse>;
|
|
643
|
+
/**
|
|
644
|
+
* 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.
|
|
645
|
+
* @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters.
|
|
646
|
+
* @param {*} [options] Override http request option.
|
|
647
|
+
* @throws {RequiredError}
|
|
648
|
+
*/
|
|
649
|
+
createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateInventoryItemResponse>;
|
|
650
|
+
/**
|
|
651
|
+
* 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.
|
|
652
|
+
* @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters.
|
|
653
|
+
* @param {*} [options] Override http request option.
|
|
654
|
+
* @throws {RequiredError}
|
|
655
|
+
*/
|
|
656
|
+
deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteInventoryItemResponse>;
|
|
657
|
+
/**
|
|
658
|
+
* 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).
|
|
659
|
+
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInventorySummariesResponse>;
|
|
730
664
|
};
|
|
731
665
|
/**
|
|
732
666
|
* Request parameters for addInventory operation in FbaInventoryApi.
|
|
733
667
|
*/
|
|
734
668
|
interface FbaInventoryApiAddInventoryRequest {
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
669
|
+
/**
|
|
670
|
+
* A unique token/requestId provided with each call to ensure idempotency.
|
|
671
|
+
*/
|
|
672
|
+
readonly xAmznIdempotencyToken: string;
|
|
673
|
+
/**
|
|
674
|
+
* List of items to add to Sandbox inventory.
|
|
675
|
+
*/
|
|
676
|
+
readonly addInventoryRequestBody: AddInventoryRequest;
|
|
743
677
|
}
|
|
744
678
|
/**
|
|
745
679
|
* Request parameters for createInventoryItem operation in FbaInventoryApi.
|
|
746
680
|
*/
|
|
747
681
|
interface FbaInventoryApiCreateInventoryItemRequest {
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
682
|
+
/**
|
|
683
|
+
* CreateInventoryItem Request Body Parameter.
|
|
684
|
+
*/
|
|
685
|
+
readonly createInventoryItemRequestBody: CreateInventoryItemRequest;
|
|
752
686
|
}
|
|
753
687
|
/**
|
|
754
688
|
* Request parameters for deleteInventoryItem operation in FbaInventoryApi.
|
|
755
689
|
*/
|
|
756
690
|
interface FbaInventoryApiDeleteInventoryItemRequest {
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
691
|
+
/**
|
|
692
|
+
* A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
693
|
+
*/
|
|
694
|
+
readonly sellerSku: string;
|
|
695
|
+
/**
|
|
696
|
+
* The marketplace ID for the marketplace for which the sellerSku is to be deleted.
|
|
697
|
+
*/
|
|
698
|
+
readonly marketplaceId: string;
|
|
765
699
|
}
|
|
766
700
|
/**
|
|
767
701
|
* Request parameters for getInventorySummaries operation in FbaInventoryApi.
|
|
768
702
|
*/
|
|
769
703
|
interface FbaInventoryApiGetInventorySummariesRequest {
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
704
|
+
/**
|
|
705
|
+
* The granularity type for the inventory aggregation level.
|
|
706
|
+
*/
|
|
707
|
+
readonly granularityType: GetInventorySummariesGranularityTypeEnum;
|
|
708
|
+
/**
|
|
709
|
+
* The granularity ID for the inventory aggregation level.
|
|
710
|
+
*/
|
|
711
|
+
readonly granularityId: string;
|
|
712
|
+
/**
|
|
713
|
+
* The marketplace ID for the marketplace for which to return inventory summaries.
|
|
714
|
+
*/
|
|
715
|
+
readonly marketplaceIds: Array<string>;
|
|
716
|
+
/**
|
|
717
|
+
* true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
718
|
+
*/
|
|
719
|
+
readonly details?: boolean;
|
|
720
|
+
/**
|
|
721
|
+
* A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
722
|
+
*/
|
|
723
|
+
readonly startDateTime?: string;
|
|
724
|
+
/**
|
|
725
|
+
* A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
726
|
+
*/
|
|
727
|
+
readonly sellerSkus?: Array<string>;
|
|
728
|
+
/**
|
|
729
|
+
* A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
730
|
+
*/
|
|
731
|
+
readonly sellerSku?: string;
|
|
732
|
+
/**
|
|
733
|
+
* String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
734
|
+
*/
|
|
735
|
+
readonly nextToken?: string;
|
|
802
736
|
}
|
|
803
737
|
/**
|
|
804
738
|
* FbaInventoryApi - object-oriented interface
|
|
805
739
|
*/
|
|
806
740
|
declare class FbaInventoryApi extends BaseAPI {
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
741
|
+
/**
|
|
742
|
+
* 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.
|
|
743
|
+
* @param {FbaInventoryApiAddInventoryRequest} requestParameters Request parameters.
|
|
744
|
+
* @param {*} [options] Override http request option.
|
|
745
|
+
* @throws {RequiredError}
|
|
746
|
+
*/
|
|
747
|
+
addInventory(requestParameters: FbaInventoryApiAddInventoryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddInventoryResponse, any, {}>>;
|
|
748
|
+
/**
|
|
749
|
+
* 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.
|
|
750
|
+
* @param {FbaInventoryApiCreateInventoryItemRequest} requestParameters Request parameters.
|
|
751
|
+
* @param {*} [options] Override http request option.
|
|
752
|
+
* @throws {RequiredError}
|
|
753
|
+
*/
|
|
754
|
+
createInventoryItem(requestParameters: FbaInventoryApiCreateInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateInventoryItemResponse, any, {}>>;
|
|
755
|
+
/**
|
|
756
|
+
* 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.
|
|
757
|
+
* @param {FbaInventoryApiDeleteInventoryItemRequest} requestParameters Request parameters.
|
|
758
|
+
* @param {*} [options] Override http request option.
|
|
759
|
+
* @throws {RequiredError}
|
|
760
|
+
*/
|
|
761
|
+
deleteInventoryItem(requestParameters: FbaInventoryApiDeleteInventoryItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteInventoryItemResponse, any, {}>>;
|
|
762
|
+
/**
|
|
763
|
+
* 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).
|
|
764
|
+
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
*/
|
|
768
|
+
getInventorySummaries(requestParameters: FbaInventoryApiGetInventorySummariesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInventorySummariesResponse, any, {}>>;
|
|
835
769
|
}
|
|
836
770
|
declare const GetInventorySummariesGranularityTypeEnum: {
|
|
837
|
-
|
|
771
|
+
readonly Marketplace: "Marketplace";
|
|
838
772
|
};
|
|
839
773
|
type GetInventorySummariesGranularityTypeEnum = typeof GetInventorySummariesGranularityTypeEnum[keyof typeof GetInventorySummariesGranularityTypeEnum];
|
|
840
|
-
|
|
774
|
+
//#endregion
|
|
775
|
+
//#region src/client.d.ts
|
|
841
776
|
declare const clientRateLimits: RateLimit[];
|
|
842
777
|
declare class FbaInventoryApiClient extends FbaInventoryApi {
|
|
843
|
-
|
|
778
|
+
constructor(configuration: ClientConfiguration);
|
|
844
779
|
}
|
|
845
|
-
|
|
846
|
-
export {
|
|
780
|
+
//#endregion
|
|
781
|
+
export { AddInventoryRequest, AddInventoryResponse, CreateInventoryItemRequest, CreateInventoryItemResponse, DeleteInventoryItemResponse, FbaInventoryApi, FbaInventoryApiAddInventoryRequest, FbaInventoryApiAxiosParamCreator, FbaInventoryApiClient, FbaInventoryApiCreateInventoryItemRequest, FbaInventoryApiDeleteInventoryItemRequest, FbaInventoryApiFactory, FbaInventoryApiFp, FbaInventoryApiGetInventorySummariesRequest, GetInventorySummariesGranularityTypeEnum, GetInventorySummariesResponse, GetInventorySummariesResult, Granularity, InventoryDetails, InventoryItem, InventorySummary, ModelError, Pagination, ResearchingQuantity, ResearchingQuantityEntry, ResearchingQuantityEntryNameEnum, ReservedQuantity, UnfulfillableQuantity, clientRateLimits };
|
|
782
|
+
//# sourceMappingURL=index.d.ts.map
|