@sp-api-sdk/fulfillment-inbound-api-v0 5.0.0 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,7 +1,6 @@
1
- import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
2
- import * as axios from 'axios';
3
- import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
4
-
1
+ import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
2
+ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
3
+ //#region src/api-model/configuration.d.ts
5
4
  /**
6
5
  * Selling Partner API for Fulfillment Inbound
7
6
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to 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
- options?: {
18
- region?: string;
19
- service?: string;
20
- };
21
- credentials?: {
22
- accessKeyId?: string;
23
- secretAccessKey?: string;
24
- sessionToken?: string;
25
- };
16
+ options?: {
17
+ region?: string;
18
+ service?: string;
19
+ };
20
+ credentials?: {
21
+ accessKeyId?: string;
22
+ secretAccessKey?: string;
23
+ sessionToken?: string;
24
+ };
26
25
  }
27
26
  interface ConfigurationParameters {
28
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
- username?: string;
30
- password?: string;
31
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
32
- awsv4?: AWSv4Configuration;
33
- basePath?: string;
34
- serverIndex?: number;
35
- baseOptions?: any;
36
- formDataCtor?: new () => any;
27
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
+ username?: string;
29
+ password?: string;
30
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
31
+ awsv4?: AWSv4Configuration;
32
+ basePath?: string;
33
+ serverIndex?: number;
34
+ baseOptions?: any;
35
+ formDataCtor?: new () => any;
37
36
  }
38
37
  declare class Configuration {
39
- /**
40
- * parameter for apiKey security
41
- * @param name security name
42
- */
43
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
44
- /**
45
- * parameter for basic security
46
- */
47
- username?: string;
48
- /**
49
- * parameter for basic security
50
- */
51
- password?: string;
52
- /**
53
- * parameter for oauth2 security
54
- * @param name security name
55
- * @param scopes oauth2 scope
56
- */
57
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
58
- /**
59
- * parameter for aws4 signature security
60
- * @param {Object} AWS4Signature - AWS4 Signature security
61
- * @param {string} options.region - aws region
62
- * @param {string} options.service - name of the service.
63
- * @param {string} credentials.accessKeyId - aws access key id
64
- * @param {string} credentials.secretAccessKey - aws access key
65
- * @param {string} credentials.sessionToken - aws session token
66
- * @memberof Configuration
67
- */
68
- awsv4?: AWSv4Configuration;
69
- /**
70
- * override base path
71
- */
72
- basePath?: string;
73
- /**
74
- * override server index
75
- */
76
- serverIndex?: number;
77
- /**
78
- * base options for axios calls
79
- */
80
- baseOptions?: any;
81
- /**
82
- * The FormData constructor that will be used to create multipart form data
83
- * requests. You can inject this here so that execution environments that
84
- * do not support the FormData class can still run the generated client.
85
- *
86
- * @type {new () => FormData}
87
- */
88
- formDataCtor?: new () => any;
89
- constructor(param?: ConfigurationParameters);
90
- /**
91
- * Check if the given MIME is a JSON MIME.
92
- * JSON MIME examples:
93
- * application/json
94
- * application/json; charset=UTF8
95
- * APPLICATION/JSON
96
- * application/vnd.company+json
97
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
98
- * @return True if the given MIME is JSON, false otherwise.
99
- */
100
- isJsonMime(mime: string): boolean;
38
+ /**
39
+ * parameter for apiKey security
40
+ * @param name security name
41
+ */
42
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
43
+ /**
44
+ * parameter for basic security
45
+ */
46
+ username?: string;
47
+ /**
48
+ * parameter for basic security
49
+ */
50
+ password?: string;
51
+ /**
52
+ * parameter for oauth2 security
53
+ * @param name security name
54
+ * @param scopes oauth2 scope
55
+ */
56
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
57
+ /**
58
+ * parameter for aws4 signature security
59
+ * @param {Object} AWS4Signature - AWS4 Signature security
60
+ * @param {string} options.region - aws region
61
+ * @param {string} options.service - name of the service.
62
+ * @param {string} credentials.accessKeyId - aws access key id
63
+ * @param {string} credentials.secretAccessKey - aws access key
64
+ * @param {string} credentials.sessionToken - aws session token
65
+ * @memberof Configuration
66
+ */
67
+ awsv4?: AWSv4Configuration;
68
+ /**
69
+ * override base path
70
+ */
71
+ basePath?: string;
72
+ /**
73
+ * override server index
74
+ */
75
+ serverIndex?: number;
76
+ /**
77
+ * base options for axios calls
78
+ */
79
+ baseOptions?: any;
80
+ /**
81
+ * The FormData constructor that will be used to create multipart form data
82
+ * requests. You can inject this here so that execution environments that
83
+ * do not support the FormData class can still run the generated client.
84
+ *
85
+ * @type {new () => FormData}
86
+ */
87
+ formDataCtor?: new () => any;
88
+ constructor(param?: ConfigurationParameters);
89
+ /**
90
+ * Check if the given MIME is a JSON MIME.
91
+ * JSON MIME examples:
92
+ * application/json
93
+ * application/json; charset=UTF8
94
+ * APPLICATION/JSON
95
+ * application/vnd.company+json
96
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
97
+ * @return True if the given MIME is JSON, false otherwise.
98
+ */
99
+ isJsonMime(mime: string): boolean;
101
100
  }
102
-
103
- /**
104
- * Selling Partner API for Fulfillment Inbound
105
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
106
- *
107
- * The version of the OpenAPI document: v0
108
- *
109
- *
110
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
111
- * https://openapi-generator.tech
112
- * Do not edit the class manually.
113
- */
114
-
101
+ //#endregion
102
+ //#region src/api-model/base.d.ts
115
103
  interface RequestArgs {
116
- url: string;
117
- options: RawAxiosRequestConfig;
104
+ url: string;
105
+ options: RawAxiosRequestConfig;
118
106
  }
119
107
  declare class BaseAPI {
120
- protected basePath: string;
121
- protected axios: AxiosInstance;
122
- protected configuration: Configuration | undefined;
123
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
108
+ protected basePath: string;
109
+ protected axios: AxiosInstance;
110
+ protected configuration: Configuration | undefined;
111
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
124
112
  }
125
-
113
+ //#endregion
114
+ //#region src/api-model/models/barcode-instruction.d.ts
126
115
  /**
127
116
  * Selling Partner API for Fulfillment Inbound
128
117
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -138,12 +127,13 @@ declare class BaseAPI {
138
127
  * Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace.
139
128
  */
140
129
  declare const BarcodeInstruction: {
141
- readonly RequiresFnskuLabel: "RequiresFNSKULabel";
142
- readonly CanUseOriginalBarcode: "CanUseOriginalBarcode";
143
- readonly MustProvideSellerSku: "MustProvideSellerSKU";
130
+ readonly RequiresFnskuLabel: "RequiresFNSKULabel";
131
+ readonly CanUseOriginalBarcode: "CanUseOriginalBarcode";
132
+ readonly MustProvideSellerSku: "MustProvideSellerSKU";
144
133
  };
145
134
  type BarcodeInstruction = typeof BarcodeInstruction[keyof typeof BarcodeInstruction];
146
-
135
+ //#endregion
136
+ //#region src/api-model/models/prep-guidance.d.ts
147
137
  /**
148
138
  * Selling Partner API for Fulfillment Inbound
149
139
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -159,12 +149,13 @@ type BarcodeInstruction = typeof BarcodeInstruction[keyof typeof BarcodeInstruct
159
149
  * Item preparation instructions.
160
150
  */
161
151
  declare const PrepGuidance: {
162
- readonly ConsultHelpDocuments: "ConsultHelpDocuments";
163
- readonly NoAdditionalPrepRequired: "NoAdditionalPrepRequired";
164
- readonly SeePrepInstructionsList: "SeePrepInstructionsList";
152
+ readonly ConsultHelpDocuments: "ConsultHelpDocuments";
153
+ readonly NoAdditionalPrepRequired: "NoAdditionalPrepRequired";
154
+ readonly SeePrepInstructionsList: "SeePrepInstructionsList";
165
155
  };
166
156
  type PrepGuidance = typeof PrepGuidance[keyof typeof PrepGuidance];
167
-
157
+ //#endregion
158
+ //#region src/api-model/models/prep-instruction.d.ts
168
159
  /**
169
160
  * Selling Partner API for Fulfillment Inbound
170
161
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -180,53 +171,43 @@ type PrepGuidance = typeof PrepGuidance[keyof typeof PrepGuidance];
180
171
  * Preparation instructions for shipping an item to Amazon\'s fulfillment network. For more information about preparing items for shipment to Amazon\'s fulfillment network, see the Seller Central Help for your marketplace.
181
172
  */
182
173
  declare const PrepInstruction: {
183
- readonly Polybagging: "Polybagging";
184
- readonly BubbleWrapping: "BubbleWrapping";
185
- readonly Taping: "Taping";
186
- readonly BlackShrinkWrapping: "BlackShrinkWrapping";
187
- readonly Labeling: "Labeling";
188
- readonly HangGarment: "HangGarment";
189
- readonly SetCreation: "SetCreation";
190
- readonly Boxing: "Boxing";
191
- readonly RemoveFromHanger: "RemoveFromHanger";
192
- readonly Debundle: "Debundle";
193
- readonly SuffocationStickering: "SuffocationStickering";
194
- readonly CapSealing: "CapSealing";
195
- readonly SetStickering: "SetStickering";
196
- readonly BlankStickering: "BlankStickering";
197
- readonly ShipsInProductPackaging: "ShipsInProductPackaging";
198
- readonly NoPrep: "NoPrep";
174
+ readonly Polybagging: "Polybagging";
175
+ readonly BubbleWrapping: "BubbleWrapping";
176
+ readonly Taping: "Taping";
177
+ readonly BlackShrinkWrapping: "BlackShrinkWrapping";
178
+ readonly Labeling: "Labeling";
179
+ readonly HangGarment: "HangGarment";
180
+ readonly SetCreation: "SetCreation";
181
+ readonly Boxing: "Boxing";
182
+ readonly RemoveFromHanger: "RemoveFromHanger";
183
+ readonly Debundle: "Debundle";
184
+ readonly SuffocationStickering: "SuffocationStickering";
185
+ readonly CapSealing: "CapSealing";
186
+ readonly SetStickering: "SetStickering";
187
+ readonly BlankStickering: "BlankStickering";
188
+ readonly ShipsInProductPackaging: "ShipsInProductPackaging";
189
+ readonly NoPrep: "NoPrep";
199
190
  };
200
191
  type PrepInstruction = typeof PrepInstruction[keyof typeof PrepInstruction];
201
-
202
- /**
203
- * Selling Partner API for Fulfillment Inbound
204
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
205
- *
206
- * The version of the OpenAPI document: v0
207
- *
208
- *
209
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
210
- * https://openapi-generator.tech
211
- * Do not edit the class manually.
212
- */
213
-
192
+ //#endregion
193
+ //#region src/api-model/models/asinprep-instructions.d.ts
214
194
  /**
215
195
  * Item preparation instructions to help with item sourcing decisions.
216
196
  */
217
197
  interface ASINPrepInstructions {
218
- /**
219
- * The Amazon Standard Identification Number (ASIN) of the item.
220
- */
221
- 'ASIN'?: string;
222
- 'BarcodeInstruction'?: BarcodeInstruction;
223
- 'PrepGuidance'?: PrepGuidance;
224
- /**
225
- * A list of preparation instructions to help with item sourcing decisions.
226
- */
227
- 'PrepInstructionList'?: Array<PrepInstruction>;
198
+ /**
199
+ * The Amazon Standard Identification Number (ASIN) of the item.
200
+ */
201
+ 'ASIN'?: string;
202
+ 'BarcodeInstruction'?: BarcodeInstruction;
203
+ 'PrepGuidance'?: PrepGuidance;
204
+ /**
205
+ * A list of preparation instructions to help with item sourcing decisions.
206
+ */
207
+ 'PrepInstructionList'?: Array<PrepInstruction>;
228
208
  }
229
-
209
+ //#endregion
210
+ //#region src/api-model/models/address.d.ts
230
211
  /**
231
212
  * Selling Partner API for Fulfillment Inbound
232
213
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -242,40 +223,41 @@ interface ASINPrepInstructions {
242
223
  * Specific details to identify a place.
243
224
  */
244
225
  interface Address {
245
- /**
246
- * Name of the individual or business.
247
- */
248
- 'Name': string;
249
- /**
250
- * The street address information.
251
- */
252
- 'AddressLine1': string;
253
- /**
254
- * Additional street address information, if required.
255
- */
256
- 'AddressLine2'?: string;
257
- /**
258
- * The district or county.
259
- */
260
- 'DistrictOrCounty'?: string;
261
- /**
262
- * The city.
263
- */
264
- 'City': string;
265
- /**
266
- * The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan.
267
- */
268
- 'StateOrProvinceCode': string;
269
- /**
270
- * The country code in two-character ISO 3166-1 alpha-2 format.
271
- */
272
- 'CountryCode': string;
273
- /**
274
- * The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan.
275
- */
276
- 'PostalCode': string;
226
+ /**
227
+ * Name of the individual or business.
228
+ */
229
+ 'Name': string;
230
+ /**
231
+ * The street address information.
232
+ */
233
+ 'AddressLine1': string;
234
+ /**
235
+ * Additional street address information, if required.
236
+ */
237
+ 'AddressLine2'?: string;
238
+ /**
239
+ * The district or county.
240
+ */
241
+ 'DistrictOrCounty'?: string;
242
+ /**
243
+ * The city.
244
+ */
245
+ 'City': string;
246
+ /**
247
+ * The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan.
248
+ */
249
+ 'StateOrProvinceCode': string;
250
+ /**
251
+ * The country code in two-character ISO 3166-1 alpha-2 format.
252
+ */
253
+ 'CountryCode': string;
254
+ /**
255
+ * The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan.
256
+ */
257
+ 'PostalCode': string;
277
258
  }
278
-
259
+ //#endregion
260
+ //#region src/api-model/models/currency-code.d.ts
279
261
  /**
280
262
  * Selling Partner API for Fulfillment Inbound
281
263
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -291,54 +273,33 @@ interface Address {
291
273
  * The currency code.
292
274
  */
293
275
  declare const CurrencyCode: {
294
- readonly Usd: "USD";
295
- readonly Gbp: "GBP";
276
+ readonly Usd: "USD";
277
+ readonly Gbp: "GBP";
296
278
  };
297
279
  type CurrencyCode = typeof CurrencyCode[keyof typeof CurrencyCode];
298
-
299
- /**
300
- * Selling Partner API for Fulfillment Inbound
301
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
302
- *
303
- * The version of the OpenAPI document: v0
304
- *
305
- *
306
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
307
- * https://openapi-generator.tech
308
- * Do not edit the class manually.
309
- */
310
-
280
+ //#endregion
281
+ //#region src/api-model/models/amount.d.ts
311
282
  /**
312
283
  * The monetary value.
313
284
  */
314
285
  interface Amount {
315
- 'CurrencyCode': CurrencyCode;
316
- /**
317
- * Number format that supports decimal.
318
- */
319
- 'Value': number;
286
+ 'CurrencyCode': CurrencyCode;
287
+ /**
288
+ * Number format that supports decimal.
289
+ */
290
+ 'Value': number;
320
291
  }
321
-
322
- /**
323
- * Selling Partner API for Fulfillment Inbound
324
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
325
- *
326
- * The version of the OpenAPI document: v0
327
- *
328
- *
329
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
330
- * https://openapi-generator.tech
331
- * Do not edit the class manually.
332
- */
333
-
292
+ //#endregion
293
+ //#region src/api-model/models/amazon-prep-fees-details.d.ts
334
294
  /**
335
295
  * The fees for Amazon to prep goods for shipment.
336
296
  */
337
297
  interface AmazonPrepFeesDetails {
338
- 'PrepInstruction'?: PrepInstruction;
339
- 'FeePerUnit'?: Amount;
298
+ 'PrepInstruction'?: PrepInstruction;
299
+ 'FeePerUnit'?: Amount;
340
300
  }
341
-
301
+ //#endregion
302
+ //#region src/api-model/models/bill-of-lading-download-url.d.ts
342
303
  /**
343
304
  * Selling Partner API for Fulfillment Inbound
344
305
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -354,36 +315,26 @@ interface AmazonPrepFeesDetails {
354
315
  * Download URL for the bill of lading.
355
316
  */
356
317
  interface BillOfLadingDownloadURL {
357
- /**
358
- * URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds
359
- */
360
- 'DownloadURL'?: string;
318
+ /**
319
+ * URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds
320
+ */
321
+ 'DownloadURL'?: string;
361
322
  }
362
-
363
- /**
364
- * Selling Partner API for Fulfillment Inbound
365
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
366
- *
367
- * The version of the OpenAPI document: v0
368
- *
369
- *
370
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
371
- * https://openapi-generator.tech
372
- * Do not edit the class manually.
373
- */
374
-
323
+ //#endregion
324
+ //#region src/api-model/models/box-contents-fee-details.d.ts
375
325
  /**
376
326
  * The manual processing fee per unit and total fee for a shipment.
377
327
  */
378
328
  interface BoxContentsFeeDetails {
379
- /**
380
- * The item quantity.
381
- */
382
- 'TotalUnits'?: number;
383
- 'FeePerUnit'?: Amount;
384
- 'TotalFee'?: Amount;
329
+ /**
330
+ * The item quantity.
331
+ */
332
+ 'TotalUnits'?: number;
333
+ 'FeePerUnit'?: Amount;
334
+ 'TotalFee'?: Amount;
385
335
  }
386
-
336
+ //#endregion
337
+ //#region src/api-model/models/box-contents-source.d.ts
387
338
  /**
388
339
  * Selling Partner API for Fulfillment Inbound
389
340
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -399,13 +350,14 @@ interface BoxContentsFeeDetails {
399
350
  * Where the seller provided box contents information for a shipment.
400
351
  */
401
352
  declare const BoxContentsSource: {
402
- readonly None: "NONE";
403
- readonly Feed: "FEED";
404
- readonly _2DBarcode: "2D_BARCODE";
405
- readonly Interactive: "INTERACTIVE";
353
+ readonly None: "NONE";
354
+ readonly Feed: "FEED";
355
+ readonly _2DBarcode: "2D_BARCODE";
356
+ readonly Interactive: "INTERACTIVE";
406
357
  };
407
358
  type BoxContentsSource = typeof BoxContentsSource[keyof typeof BoxContentsSource];
408
-
359
+ //#endregion
360
+ //#region src/api-model/models/error-reason.d.ts
409
361
  /**
410
362
  * Selling Partner API for Fulfillment Inbound
411
363
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -421,34 +373,24 @@ type BoxContentsSource = typeof BoxContentsSource[keyof typeof BoxContentsSource
421
373
  * The reason that the ASIN is invalid.
422
374
  */
423
375
  declare const ErrorReason: {
424
- readonly DoesNotExist: "DoesNotExist";
425
- readonly InvalidAsin: "InvalidASIN";
376
+ readonly DoesNotExist: "DoesNotExist";
377
+ readonly InvalidAsin: "InvalidASIN";
426
378
  };
427
379
  type ErrorReason = typeof ErrorReason[keyof typeof ErrorReason];
428
-
429
- /**
430
- * Selling Partner API for Fulfillment Inbound
431
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
432
- *
433
- * The version of the OpenAPI document: v0
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
-
380
+ //#endregion
381
+ //#region src/api-model/models/get-bill-of-lading-response.d.ts
441
382
  /**
442
383
  * The response schema for the getBillOfLading operation.
443
384
  */
444
385
  interface GetBillOfLadingResponse {
445
- 'payload'?: BillOfLadingDownloadURL;
446
- /**
447
- * A list of error responses returned when a request is unsuccessful.
448
- */
449
- 'errors'?: Array<Error>;
386
+ 'payload'?: BillOfLadingDownloadURL;
387
+ /**
388
+ * A list of error responses returned when a request is unsuccessful.
389
+ */
390
+ 'errors'?: Array<Error>;
450
391
  }
451
-
392
+ //#endregion
393
+ //#region src/api-model/models/label-download-url.d.ts
452
394
  /**
453
395
  * Selling Partner API for Fulfillment Inbound
454
396
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -464,174 +406,109 @@ interface GetBillOfLadingResponse {
464
406
  * Download URL for a label
465
407
  */
466
408
  interface LabelDownloadURL {
467
- /**
468
- * URL to download the label for the package. Note: The URL will only be valid for 15 seconds
469
- */
470
- 'DownloadURL'?: string;
409
+ /**
410
+ * URL to download the label for the package. Note: The URL will only be valid for 15 seconds
411
+ */
412
+ 'DownloadURL'?: string;
471
413
  }
472
-
473
- /**
474
- * Selling Partner API for Fulfillment Inbound
475
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
476
- *
477
- * The version of the OpenAPI document: v0
478
- *
479
- *
480
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
481
- * https://openapi-generator.tech
482
- * Do not edit the class manually.
483
- */
484
-
414
+ //#endregion
415
+ //#region src/api-model/models/get-labels-response.d.ts
485
416
  /**
486
417
  * The response schema for the getLabels operation.
487
418
  */
488
419
  interface GetLabelsResponse {
489
- 'payload'?: LabelDownloadURL;
490
- /**
491
- * A list of error responses returned when a request is unsuccessful.
492
- */
493
- 'errors'?: Array<Error>;
420
+ 'payload'?: LabelDownloadURL;
421
+ /**
422
+ * A list of error responses returned when a request is unsuccessful.
423
+ */
424
+ 'errors'?: Array<Error>;
494
425
  }
495
-
496
- /**
497
- * Selling Partner API for Fulfillment Inbound
498
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
499
- *
500
- * The version of the OpenAPI document: v0
501
- *
502
- *
503
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
504
- * https://openapi-generator.tech
505
- * Do not edit the class manually.
506
- */
507
-
426
+ //#endregion
427
+ //#region src/api-model/models/invalid-asin.d.ts
508
428
  /**
509
429
  * Contains details about an invalid ASIN
510
430
  */
511
431
  interface InvalidASIN {
512
- /**
513
- * The Amazon Standard Identification Number (ASIN) of the item.
514
- */
515
- 'ASIN'?: string;
516
- 'ErrorReason'?: ErrorReason;
432
+ /**
433
+ * The Amazon Standard Identification Number (ASIN) of the item.
434
+ */
435
+ 'ASIN'?: string;
436
+ 'ErrorReason'?: ErrorReason;
517
437
  }
518
-
519
- /**
520
- * Selling Partner API for Fulfillment Inbound
521
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
522
- *
523
- * The version of the OpenAPI document: v0
524
- *
525
- *
526
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
527
- * https://openapi-generator.tech
528
- * Do not edit the class manually.
529
- */
530
-
438
+ //#endregion
439
+ //#region src/api-model/models/invalid-sku.d.ts
531
440
  /**
532
441
  * Contains detail about an invalid SKU
533
442
  */
534
443
  interface InvalidSKU {
535
- /**
536
- * The seller SKU of the item.
537
- */
538
- 'SellerSKU'?: string;
539
- 'ErrorReason'?: ErrorReason;
444
+ /**
445
+ * The seller SKU of the item.
446
+ */
447
+ 'SellerSKU'?: string;
448
+ 'ErrorReason'?: ErrorReason;
540
449
  }
541
-
542
- /**
543
- * Selling Partner API for Fulfillment Inbound
544
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
545
- *
546
- * The version of the OpenAPI document: v0
547
- *
548
- *
549
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
550
- * https://openapi-generator.tech
551
- * Do not edit the class manually.
552
- */
553
-
450
+ //#endregion
451
+ //#region src/api-model/models/skuprep-instructions.d.ts
554
452
  /**
555
453
  * Labeling requirements and item preparation instructions to help you prepare items for shipment to Amazon\'s fulfillment network.
556
454
  */
557
455
  interface SKUPrepInstructions {
558
- /**
559
- * The seller SKU of the item.
560
- */
561
- 'SellerSKU'?: string;
562
- /**
563
- * The Amazon Standard Identification Number (ASIN) of the item.
564
- */
565
- 'ASIN'?: string;
566
- 'BarcodeInstruction'?: BarcodeInstruction;
567
- 'PrepGuidance'?: PrepGuidance;
568
- /**
569
- * A list of preparation instructions to help with item sourcing decisions.
570
- */
571
- 'PrepInstructionList'?: Array<PrepInstruction>;
572
- /**
573
- * A list of preparation instructions and fees for Amazon to prep goods for shipment.
574
- */
575
- 'AmazonPrepFeesDetailsList'?: Array<AmazonPrepFeesDetails>;
456
+ /**
457
+ * The seller SKU of the item.
458
+ */
459
+ 'SellerSKU'?: string;
460
+ /**
461
+ * The Amazon Standard Identification Number (ASIN) of the item.
462
+ */
463
+ 'ASIN'?: string;
464
+ 'BarcodeInstruction'?: BarcodeInstruction;
465
+ 'PrepGuidance'?: PrepGuidance;
466
+ /**
467
+ * A list of preparation instructions to help with item sourcing decisions.
468
+ */
469
+ 'PrepInstructionList'?: Array<PrepInstruction>;
470
+ /**
471
+ * A list of preparation instructions and fees for Amazon to prep goods for shipment.
472
+ */
473
+ 'AmazonPrepFeesDetailsList'?: Array<AmazonPrepFeesDetails>;
576
474
  }
577
-
578
- /**
579
- * Selling Partner API for Fulfillment Inbound
580
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
581
- *
582
- * The version of the OpenAPI document: v0
583
- *
584
- *
585
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
586
- * https://openapi-generator.tech
587
- * Do not edit the class manually.
588
- */
589
-
475
+ //#endregion
476
+ //#region src/api-model/models/get-prep-instructions-result.d.ts
590
477
  /**
591
478
  * Result for the get prep instructions operation
592
479
  */
593
480
  interface GetPrepInstructionsResult {
594
- /**
595
- * A list of SKU labeling requirements and item preparation instructions.
596
- */
597
- 'SKUPrepInstructionsList'?: Array<SKUPrepInstructions>;
598
- /**
599
- * A list of invalid SKU values and the reason they are invalid.
600
- */
601
- 'InvalidSKUList'?: Array<InvalidSKU>;
602
- /**
603
- * A list of item preparation instructions.
604
- */
605
- 'ASINPrepInstructionsList'?: Array<ASINPrepInstructions>;
606
- /**
607
- * A list of invalid ASIN values and the reasons they are invalid.
608
- */
609
- 'InvalidASINList'?: Array<InvalidASIN>;
481
+ /**
482
+ * A list of SKU labeling requirements and item preparation instructions.
483
+ */
484
+ 'SKUPrepInstructionsList'?: Array<SKUPrepInstructions>;
485
+ /**
486
+ * A list of invalid SKU values and the reason they are invalid.
487
+ */
488
+ 'InvalidSKUList'?: Array<InvalidSKU>;
489
+ /**
490
+ * A list of item preparation instructions.
491
+ */
492
+ 'ASINPrepInstructionsList'?: Array<ASINPrepInstructions>;
493
+ /**
494
+ * A list of invalid ASIN values and the reasons they are invalid.
495
+ */
496
+ 'InvalidASINList'?: Array<InvalidASIN>;
610
497
  }
611
-
612
- /**
613
- * Selling Partner API for Fulfillment Inbound
614
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
615
- *
616
- * The version of the OpenAPI document: v0
617
- *
618
- *
619
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
620
- * https://openapi-generator.tech
621
- * Do not edit the class manually.
622
- */
623
-
498
+ //#endregion
499
+ //#region src/api-model/models/get-prep-instructions-response.d.ts
624
500
  /**
625
501
  * The response schema for the getPrepInstructions operation.
626
502
  */
627
503
  interface GetPrepInstructionsResponse {
628
- 'payload'?: GetPrepInstructionsResult;
629
- /**
630
- * A list of error responses returned when a request is unsuccessful.
631
- */
632
- 'errors'?: Array<Error>;
504
+ 'payload'?: GetPrepInstructionsResult;
505
+ /**
506
+ * A list of error responses returned when a request is unsuccessful.
507
+ */
508
+ 'errors'?: Array<Error>;
633
509
  }
634
-
510
+ //#endregion
511
+ //#region src/api-model/models/prep-owner.d.ts
635
512
  /**
636
513
  * Selling Partner API for Fulfillment Inbound
637
514
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -647,130 +524,87 @@ interface GetPrepInstructionsResponse {
647
524
  * Indicates who will prepare the item.
648
525
  */
649
526
  declare const PrepOwner: {
650
- readonly Amazon: "AMAZON";
651
- readonly Seller: "SELLER";
527
+ readonly Amazon: "AMAZON";
528
+ readonly Seller: "SELLER";
652
529
  };
653
530
  type PrepOwner = typeof PrepOwner[keyof typeof PrepOwner];
654
-
655
- /**
656
- * Selling Partner API for Fulfillment Inbound
657
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
658
- *
659
- * The version of the OpenAPI document: v0
660
- *
661
- *
662
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
663
- * https://openapi-generator.tech
664
- * Do not edit the class manually.
665
- */
666
-
531
+ //#endregion
532
+ //#region src/api-model/models/prep-details.d.ts
667
533
  /**
668
534
  * Preparation instructions and who is responsible for the preparation.
669
535
  */
670
536
  interface PrepDetails {
671
- 'PrepInstruction': PrepInstruction;
672
- 'PrepOwner': PrepOwner;
537
+ 'PrepInstruction': PrepInstruction;
538
+ 'PrepOwner': PrepOwner;
673
539
  }
674
-
675
- /**
676
- * Selling Partner API for Fulfillment Inbound
677
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
678
- *
679
- * The version of the OpenAPI document: v0
680
- *
681
- *
682
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
683
- * https://openapi-generator.tech
684
- * Do not edit the class manually.
685
- */
686
-
540
+ //#endregion
541
+ //#region src/api-model/models/inbound-shipment-item.d.ts
687
542
  /**
688
543
  * Item information for an inbound shipment. Submitted with a call to the createInboundShipment or updateInboundShipment operation.
689
544
  */
690
545
  interface InboundShipmentItem {
691
- /**
692
- * A shipment identifier originally returned by the createInboundShipmentPlan operation.
693
- */
694
- 'ShipmentId'?: string;
695
- /**
696
- * The seller SKU of the item.
697
- */
698
- 'SellerSKU': string;
699
- /**
700
- * Amazon\'s fulfillment network SKU of the item.
701
- */
702
- 'FulfillmentNetworkSKU'?: string;
703
- /**
704
- * The item quantity.
705
- */
706
- 'QuantityShipped': number;
707
- /**
708
- * The item quantity.
709
- */
710
- 'QuantityReceived'?: number;
711
- /**
712
- * The item quantity.
713
- */
714
- 'QuantityInCase'?: number;
715
- /**
716
- * Type containing date in string format
717
- */
718
- 'ReleaseDate'?: string;
719
- /**
720
- * A list of preparation instructions and who is responsible for that preparation.
721
- */
722
- 'PrepDetailsList'?: Array<PrepDetails>;
546
+ /**
547
+ * A shipment identifier originally returned by the createInboundShipmentPlan operation.
548
+ */
549
+ 'ShipmentId'?: string;
550
+ /**
551
+ * The seller SKU of the item.
552
+ */
553
+ 'SellerSKU': string;
554
+ /**
555
+ * Amazon\'s fulfillment network SKU of the item.
556
+ */
557
+ 'FulfillmentNetworkSKU'?: string;
558
+ /**
559
+ * The item quantity.
560
+ */
561
+ 'QuantityShipped': number;
562
+ /**
563
+ * The item quantity.
564
+ */
565
+ 'QuantityReceived'?: number;
566
+ /**
567
+ * The item quantity.
568
+ */
569
+ 'QuantityInCase'?: number;
570
+ /**
571
+ * Type containing date in string format
572
+ */
573
+ 'ReleaseDate'?: string;
574
+ /**
575
+ * A list of preparation instructions and who is responsible for that preparation.
576
+ */
577
+ 'PrepDetailsList'?: Array<PrepDetails>;
723
578
  }
724
-
725
- /**
726
- * Selling Partner API for Fulfillment Inbound
727
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
728
- *
729
- * The version of the OpenAPI document: v0
730
- *
731
- *
732
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
733
- * https://openapi-generator.tech
734
- * Do not edit the class manually.
735
- */
736
-
579
+ //#endregion
580
+ //#region src/api-model/models/get-shipment-items-result.d.ts
737
581
  /**
738
582
  * Result for the get shipment items operation
739
583
  */
740
584
  interface GetShipmentItemsResult {
741
- /**
742
- * A list of inbound shipment item information.
743
- */
744
- 'ItemData'?: Array<InboundShipmentItem>;
745
- /**
746
- * When present and not empty, pass this string token in the next request to return the next response page.
747
- */
748
- 'NextToken'?: string;
585
+ /**
586
+ * A list of inbound shipment item information.
587
+ */
588
+ 'ItemData'?: Array<InboundShipmentItem>;
589
+ /**
590
+ * When present and not empty, pass this string token in the next request to return the next response page.
591
+ */
592
+ 'NextToken'?: string;
749
593
  }
750
-
751
- /**
752
- * Selling Partner API for Fulfillment Inbound
753
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
754
- *
755
- * The version of the OpenAPI document: v0
756
- *
757
- *
758
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
759
- * https://openapi-generator.tech
760
- * Do not edit the class manually.
761
- */
762
-
594
+ //#endregion
595
+ //#region src/api-model/models/get-shipment-items-response.d.ts
763
596
  /**
764
597
  * The response schema for the getShipmentItems operation.
765
598
  */
766
599
  interface GetShipmentItemsResponse {
767
- 'payload'?: GetShipmentItemsResult;
768
- /**
769
- * A list of error responses returned when a request is unsuccessful.
770
- */
771
- 'errors'?: Array<Error>;
600
+ 'payload'?: GetShipmentItemsResult;
601
+ /**
602
+ * A list of error responses returned when a request is unsuccessful.
603
+ */
604
+ 'errors'?: Array<Error>;
772
605
  }
773
-
606
+ //#endregion
607
+ //#region src/api-model/models/label-prep-type.d.ts
774
608
  /**
775
609
  * Selling Partner API for Fulfillment Inbound
776
610
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -786,12 +620,13 @@ interface GetShipmentItemsResponse {
786
620
  * The type of label preparation that is required for the inbound shipment.
787
621
  */
788
622
  declare const LabelPrepType: {
789
- readonly NoLabel: "NO_LABEL";
790
- readonly SellerLabel: "SELLER_LABEL";
791
- readonly AmazonLabel: "AMAZON_LABEL";
623
+ readonly NoLabel: "NO_LABEL";
624
+ readonly SellerLabel: "SELLER_LABEL";
625
+ readonly AmazonLabel: "AMAZON_LABEL";
792
626
  };
793
627
  type LabelPrepType = typeof LabelPrepType[keyof typeof LabelPrepType];
794
-
628
+ //#endregion
629
+ //#region src/api-model/models/shipment-status.d.ts
795
630
  /**
796
631
  * Selling Partner API for Fulfillment Inbound
797
632
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -807,111 +642,79 @@ type LabelPrepType = typeof LabelPrepType[keyof typeof LabelPrepType];
807
642
  * Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED.
808
643
  */
809
644
  declare const ShipmentStatus: {
810
- readonly Working: "WORKING";
811
- readonly Shipped: "SHIPPED";
812
- readonly Receiving: "RECEIVING";
813
- readonly Cancelled: "CANCELLED";
814
- readonly Deleted: "DELETED";
815
- readonly Closed: "CLOSED";
816
- readonly Error: "ERROR";
817
- readonly InTransit: "IN_TRANSIT";
818
- readonly Delivered: "DELIVERED";
819
- readonly CheckedIn: "CHECKED_IN";
645
+ readonly Working: "WORKING";
646
+ readonly Shipped: "SHIPPED";
647
+ readonly Receiving: "RECEIVING";
648
+ readonly Cancelled: "CANCELLED";
649
+ readonly Deleted: "DELETED";
650
+ readonly Closed: "CLOSED";
651
+ readonly Error: "ERROR";
652
+ readonly InTransit: "IN_TRANSIT";
653
+ readonly Delivered: "DELIVERED";
654
+ readonly CheckedIn: "CHECKED_IN";
820
655
  };
821
656
  type ShipmentStatus = typeof ShipmentStatus[keyof typeof ShipmentStatus];
822
-
823
- /**
824
- * Selling Partner API for Fulfillment Inbound
825
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
826
- *
827
- * The version of the OpenAPI document: v0
828
- *
829
- *
830
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
831
- * https://openapi-generator.tech
832
- * Do not edit the class manually.
833
- */
834
-
657
+ //#endregion
658
+ //#region src/api-model/models/inbound-shipment-info.d.ts
835
659
  /**
836
660
  * Information about the seller\'s inbound shipments. Returned by the listInboundShipments operation.
837
661
  */
838
662
  interface InboundShipmentInfo {
839
- /**
840
- * The shipment identifier submitted in the request.
841
- */
842
- 'ShipmentId'?: string;
843
- /**
844
- * The name for the inbound shipment.
845
- */
846
- 'ShipmentName'?: string;
847
- 'ShipFromAddress': Address;
848
- /**
849
- * An Amazon fulfillment center identifier created by Amazon.
850
- */
851
- 'DestinationFulfillmentCenterId'?: string;
852
- 'ShipmentStatus'?: ShipmentStatus;
853
- 'LabelPrepType'?: LabelPrepType;
854
- /**
855
- * Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed.
856
- */
857
- 'AreCasesRequired': boolean;
858
- /**
859
- * Type containing date in string format
860
- */
861
- 'ConfirmedNeedByDate'?: string;
862
- 'BoxContentsSource'?: BoxContentsSource;
863
- 'EstimatedBoxContentsFee'?: BoxContentsFeeDetails;
663
+ /**
664
+ * The shipment identifier submitted in the request.
665
+ */
666
+ 'ShipmentId'?: string;
667
+ /**
668
+ * The name for the inbound shipment.
669
+ */
670
+ 'ShipmentName'?: string;
671
+ 'ShipFromAddress': Address;
672
+ /**
673
+ * An Amazon fulfillment center identifier created by Amazon.
674
+ */
675
+ 'DestinationFulfillmentCenterId'?: string;
676
+ 'ShipmentStatus'?: ShipmentStatus;
677
+ 'LabelPrepType'?: LabelPrepType;
678
+ /**
679
+ * Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed.
680
+ */
681
+ 'AreCasesRequired': boolean;
682
+ /**
683
+ * Type containing date in string format
684
+ */
685
+ 'ConfirmedNeedByDate'?: string;
686
+ 'BoxContentsSource'?: BoxContentsSource;
687
+ 'EstimatedBoxContentsFee'?: BoxContentsFeeDetails;
864
688
  }
865
-
866
- /**
867
- * Selling Partner API for Fulfillment Inbound
868
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
869
- *
870
- * The version of the OpenAPI document: v0
871
- *
872
- *
873
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
874
- * https://openapi-generator.tech
875
- * Do not edit the class manually.
876
- */
877
-
689
+ //#endregion
690
+ //#region src/api-model/models/get-shipments-result.d.ts
878
691
  /**
879
692
  * Result for the get shipments operation
880
693
  */
881
694
  interface GetShipmentsResult {
882
- /**
883
- * A list of inbound shipment information.
884
- */
885
- 'ShipmentData'?: Array<InboundShipmentInfo>;
886
- /**
887
- * When present and not empty, pass this string token in the next request to return the next response page.
888
- */
889
- 'NextToken'?: string;
695
+ /**
696
+ * A list of inbound shipment information.
697
+ */
698
+ 'ShipmentData'?: Array<InboundShipmentInfo>;
699
+ /**
700
+ * When present and not empty, pass this string token in the next request to return the next response page.
701
+ */
702
+ 'NextToken'?: string;
890
703
  }
891
-
892
- /**
893
- * Selling Partner API for Fulfillment Inbound
894
- * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
895
- *
896
- * The version of the OpenAPI document: v0
897
- *
898
- *
899
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
900
- * https://openapi-generator.tech
901
- * Do not edit the class manually.
902
- */
903
-
704
+ //#endregion
705
+ //#region src/api-model/models/get-shipments-response.d.ts
904
706
  /**
905
707
  * The response schema for the getShipments operation.
906
708
  */
907
709
  interface GetShipmentsResponse {
908
- 'payload'?: GetShipmentsResult;
909
- /**
910
- * A list of error responses returned when a request is unsuccessful.
911
- */
912
- 'errors'?: Array<Error>;
710
+ 'payload'?: GetShipmentsResult;
711
+ /**
712
+ * A list of error responses returned when a request is unsuccessful.
713
+ */
714
+ 'errors'?: Array<Error>;
913
715
  }
914
-
716
+ //#endregion
717
+ //#region src/api-model/models/model-error.d.ts
915
718
  /**
916
719
  * Selling Partner API for Fulfillment Inbound
917
720
  * The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon\'s fulfillment network.
@@ -927,432 +730,435 @@ interface GetShipmentsResponse {
927
730
  * Error response returned when the request is unsuccessful.
928
731
  */
929
732
  interface ModelError {
930
- /**
931
- * An error code that identifies the type of error that occured.
932
- */
933
- 'code': string;
934
- /**
935
- * A message that describes the error condition in a human-readable form.
936
- */
937
- 'message': string;
938
- /**
939
- * Additional details that can help the caller understand or fix the issue.
940
- */
941
- 'details'?: string;
733
+ /**
734
+ * An error code that identifies the type of error that occured.
735
+ */
736
+ 'code': string;
737
+ /**
738
+ * A message that describes the error condition in a human-readable form.
739
+ */
740
+ 'message': string;
741
+ /**
742
+ * Additional details that can help the caller understand or fix the issue.
743
+ */
744
+ 'details'?: string;
942
745
  }
943
-
746
+ //#endregion
747
+ //#region src/api-model/api/fulfillment-inbound-api.d.ts
944
748
  /**
945
749
  * FulfillmentInboundApi - axios parameter creator
946
750
  */
947
751
  declare const FulfillmentInboundApiAxiosParamCreator: (configuration?: Configuration) => {
948
- /**
949
- * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
950
- * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
951
- * @param {*} [options] Override http request option.
952
- * @throws {RequiredError}
953
- */
954
- getBillOfLading: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
955
- /**
956
- * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
957
- * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
958
- * @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
959
- * @param {GetLabelsLabelTypeEnum} labelType The type of labels requested.
960
- * @param {number} [numberOfPackages] The number of packages in the shipment.
961
- * @param {Array<string>} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;CartonId&#x60; values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;boxID&#x60; values from the [&#x60;listShipmentBoxes&#x60;](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the &#x60;IncorrectPackageIdentifier&#x60; error code.
962
- * @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
963
- * @param {number} [pageSize] The page size for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
964
- * @param {number} [pageStartIndex] The page start index for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.
965
- * @param {*} [options] Override http request option.
966
- * @throws {RequiredError}
967
- */
968
- getLabels: (shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array<string>, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
969
- /**
970
- * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
971
- * @param {string} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
972
- * @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon\&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
973
- * @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
974
- * @param {*} [options] Override http request option.
975
- * @throws {RequiredError}
976
- */
977
- getPrepInstructions: (shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
978
- /**
979
- * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
980
- * @param {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
981
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
982
- * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
983
- * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
984
- * @param {string} [nextToken] A string token returned in the response to your previous request.
985
- * @param {*} [options] Override http request option.
986
- * @throws {RequiredError}
987
- */
988
- getShipmentItems: (queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
989
- /**
990
- * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
991
- * @param {string} shipmentId A shipment identifier used for selecting items in a specific inbound shipment.
992
- * @param {string} [marketplaceId] Deprecated. Do not use.
993
- * @param {*} [options] Override http request option.
994
- * @throws {RequiredError}
995
- */
996
- getShipmentItemsByShipmentId: (shipmentId: string, marketplaceId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
997
- /**
998
- * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
999
- * @param {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
1000
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
1001
- * @param {Array<GetShipmentsShipmentStatusListEnum>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
1002
- * @param {Array<string>} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
1003
- * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1004
- * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1005
- * @param {string} [nextToken] A string token returned in the response to your previous request.
1006
- * @param {*} [options] Override http request option.
1007
- * @throws {RequiredError}
1008
- */
1009
- getShipments: (queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
752
+ /**
753
+ * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
754
+ * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
755
+ * @param {*} [options] Override http request option.
756
+ * @throws {RequiredError}
757
+ */
758
+ getBillOfLading: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
759
+ /**
760
+ * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
761
+ * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
762
+ * @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
763
+ * @param {GetLabelsLabelTypeEnum} labelType The type of labels requested.
764
+ * @param {number} [numberOfPackages] The number of packages in the shipment.
765
+ * @param {Array<string>} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;CartonId&#x60; values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;boxID&#x60; values from the [&#x60;listShipmentBoxes&#x60;](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the &#x60;IncorrectPackageIdentifier&#x60; error code.
766
+ * @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
767
+ * @param {number} [pageSize] The page size for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
768
+ * @param {number} [pageStartIndex] The page start index for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.
769
+ * @param {*} [options] Override http request option.
770
+ * @throws {RequiredError}
771
+ */
772
+ getLabels: (shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array<string>, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
773
+ /**
774
+ * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
775
+ * @param {string} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
776
+ * @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon\&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
777
+ * @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
778
+ * @param {*} [options] Override http request option.
779
+ * @throws {RequiredError}
780
+ */
781
+ getPrepInstructions: (shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
782
+ /**
783
+ * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
784
+ * @param {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
785
+ * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
786
+ * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
787
+ * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
788
+ * @param {string} [nextToken] A string token returned in the response to your previous request.
789
+ * @param {*} [options] Override http request option.
790
+ * @throws {RequiredError}
791
+ */
792
+ getShipmentItems: (queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
793
+ /**
794
+ * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
795
+ * @param {string} shipmentId A shipment identifier used for selecting items in a specific inbound shipment.
796
+ * @param {string} [marketplaceId] Deprecated. Do not use.
797
+ * @param {*} [options] Override http request option.
798
+ * @throws {RequiredError}
799
+ */
800
+ getShipmentItemsByShipmentId: (shipmentId: string, marketplaceId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
801
+ /**
802
+ * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
803
+ * @param {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
804
+ * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
805
+ * @param {Array<GetShipmentsShipmentStatusListEnum>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
806
+ * @param {Array<string>} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
807
+ * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
808
+ * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
809
+ * @param {string} [nextToken] A string token returned in the response to your previous request.
810
+ * @param {*} [options] Override http request option.
811
+ * @throws {RequiredError}
812
+ */
813
+ getShipments: (queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1010
814
  };
1011
815
  /**
1012
816
  * FulfillmentInboundApi - functional programming interface
1013
817
  */
1014
818
  declare const FulfillmentInboundApiFp: (configuration?: Configuration) => {
1015
- /**
1016
- * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1017
- * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
1018
- * @param {*} [options] Override http request option.
1019
- * @throws {RequiredError}
1020
- */
1021
- getBillOfLading(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBillOfLadingResponse>>;
1022
- /**
1023
- * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1024
- * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
1025
- * @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
1026
- * @param {GetLabelsLabelTypeEnum} labelType The type of labels requested.
1027
- * @param {number} [numberOfPackages] The number of packages in the shipment.
1028
- * @param {Array<string>} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;CartonId&#x60; values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;boxID&#x60; values from the [&#x60;listShipmentBoxes&#x60;](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the &#x60;IncorrectPackageIdentifier&#x60; error code.
1029
- * @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
1030
- * @param {number} [pageSize] The page size for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
1031
- * @param {number} [pageStartIndex] The page start index for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.
1032
- * @param {*} [options] Override http request option.
1033
- * @throws {RequiredError}
1034
- */
1035
- getLabels(shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array<string>, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLabelsResponse>>;
1036
- /**
1037
- * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1038
- * @param {string} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
1039
- * @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon\&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
1040
- * @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
1041
- * @param {*} [options] Override http request option.
1042
- * @throws {RequiredError}
1043
- */
1044
- getPrepInstructions(shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPrepInstructionsResponse>>;
1045
- /**
1046
- * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1047
- * @param {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
1048
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
1049
- * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1050
- * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1051
- * @param {string} [nextToken] A string token returned in the response to your previous request.
1052
- * @param {*} [options] Override http request option.
1053
- * @throws {RequiredError}
1054
- */
1055
- getShipmentItems(queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentItemsResponse>>;
1056
- /**
1057
- * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1058
- * @param {string} shipmentId A shipment identifier used for selecting items in a specific inbound shipment.
1059
- * @param {string} [marketplaceId] Deprecated. Do not use.
1060
- * @param {*} [options] Override http request option.
1061
- * @throws {RequiredError}
1062
- */
1063
- getShipmentItemsByShipmentId(shipmentId: string, marketplaceId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentItemsResponse>>;
1064
- /**
1065
- * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1066
- * @param {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
1067
- * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
1068
- * @param {Array<GetShipmentsShipmentStatusListEnum>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
1069
- * @param {Array<string>} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
1070
- * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1071
- * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1072
- * @param {string} [nextToken] A string token returned in the response to your previous request.
1073
- * @param {*} [options] Override http request option.
1074
- * @throws {RequiredError}
1075
- */
1076
- getShipments(queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentsResponse>>;
819
+ /**
820
+ * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
821
+ * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
822
+ * @param {*} [options] Override http request option.
823
+ * @throws {RequiredError}
824
+ */
825
+ getBillOfLading(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBillOfLadingResponse>>;
826
+ /**
827
+ * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
828
+ * @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
829
+ * @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
830
+ * @param {GetLabelsLabelTypeEnum} labelType The type of labels requested.
831
+ * @param {number} [numberOfPackages] The number of packages in the shipment.
832
+ * @param {Array<string>} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;CartonId&#x60; values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;boxID&#x60; values from the [&#x60;listShipmentBoxes&#x60;](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the &#x60;IncorrectPackageIdentifier&#x60; error code.
833
+ * @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
834
+ * @param {number} [pageSize] The page size for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
835
+ * @param {number} [pageStartIndex] The page start index for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.
836
+ * @param {*} [options] Override http request option.
837
+ * @throws {RequiredError}
838
+ */
839
+ getLabels(shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array<string>, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLabelsResponse>>;
840
+ /**
841
+ * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
842
+ * @param {string} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
843
+ * @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon\&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
844
+ * @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
845
+ * @param {*} [options] Override http request option.
846
+ * @throws {RequiredError}
847
+ */
848
+ getPrepInstructions(shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPrepInstructionsResponse>>;
849
+ /**
850
+ * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
851
+ * @param {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
852
+ * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
853
+ * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
854
+ * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
855
+ * @param {string} [nextToken] A string token returned in the response to your previous request.
856
+ * @param {*} [options] Override http request option.
857
+ * @throws {RequiredError}
858
+ */
859
+ getShipmentItems(queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentItemsResponse>>;
860
+ /**
861
+ * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
862
+ * @param {string} shipmentId A shipment identifier used for selecting items in a specific inbound shipment.
863
+ * @param {string} [marketplaceId] Deprecated. Do not use.
864
+ * @param {*} [options] Override http request option.
865
+ * @throws {RequiredError}
866
+ */
867
+ getShipmentItemsByShipmentId(shipmentId: string, marketplaceId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentItemsResponse>>;
868
+ /**
869
+ * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
870
+ * @param {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
871
+ * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
872
+ * @param {Array<GetShipmentsShipmentStatusListEnum>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
873
+ * @param {Array<string>} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
874
+ * @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
875
+ * @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
876
+ * @param {string} [nextToken] A string token returned in the response to your previous request.
877
+ * @param {*} [options] Override http request option.
878
+ * @throws {RequiredError}
879
+ */
880
+ getShipments(queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentsResponse>>;
1077
881
  };
1078
882
  /**
1079
883
  * FulfillmentInboundApi - factory interface
1080
884
  */
1081
885
  declare const FulfillmentInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1082
- /**
1083
- * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1084
- * @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
1085
- * @param {*} [options] Override http request option.
1086
- * @throws {RequiredError}
1087
- */
1088
- getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetBillOfLadingResponse>;
1089
- /**
1090
- * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1091
- * @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
1092
- * @param {*} [options] Override http request option.
1093
- * @throws {RequiredError}
1094
- */
1095
- getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLabelsResponse>;
1096
- /**
1097
- * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1098
- * @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
1099
- * @param {*} [options] Override http request option.
1100
- * @throws {RequiredError}
1101
- */
1102
- getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrepInstructionsResponse>;
1103
- /**
1104
- * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1105
- * @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
1106
- * @param {*} [options] Override http request option.
1107
- * @throws {RequiredError}
1108
- */
1109
- getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
1110
- /**
1111
- * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1112
- * @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
1113
- * @param {*} [options] Override http request option.
1114
- * @throws {RequiredError}
1115
- */
1116
- getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
1117
- /**
1118
- * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1119
- * @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
1120
- * @param {*} [options] Override http request option.
1121
- * @throws {RequiredError}
1122
- */
1123
- getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentsResponse>;
886
+ /**
887
+ * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
888
+ * @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
889
+ * @param {*} [options] Override http request option.
890
+ * @throws {RequiredError}
891
+ */
892
+ getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetBillOfLadingResponse>;
893
+ /**
894
+ * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
895
+ * @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
896
+ * @param {*} [options] Override http request option.
897
+ * @throws {RequiredError}
898
+ */
899
+ getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLabelsResponse>;
900
+ /**
901
+ * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
902
+ * @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
903
+ * @param {*} [options] Override http request option.
904
+ * @throws {RequiredError}
905
+ */
906
+ getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrepInstructionsResponse>;
907
+ /**
908
+ * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
909
+ * @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
910
+ * @param {*} [options] Override http request option.
911
+ * @throws {RequiredError}
912
+ */
913
+ getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
914
+ /**
915
+ * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
916
+ * @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
917
+ * @param {*} [options] Override http request option.
918
+ * @throws {RequiredError}
919
+ */
920
+ getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
921
+ /**
922
+ * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
923
+ * @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
924
+ * @param {*} [options] Override http request option.
925
+ * @throws {RequiredError}
926
+ */
927
+ getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentsResponse>;
1124
928
  };
1125
929
  /**
1126
930
  * Request parameters for getBillOfLading operation in FulfillmentInboundApi.
1127
931
  */
1128
932
  interface FulfillmentInboundApiGetBillOfLadingRequest {
1129
- /**
1130
- * A shipment identifier originally returned by the createInboundShipmentPlan operation.
1131
- */
1132
- readonly shipmentId: string;
933
+ /**
934
+ * A shipment identifier originally returned by the createInboundShipmentPlan operation.
935
+ */
936
+ readonly shipmentId: string;
1133
937
  }
1134
938
  /**
1135
939
  * Request parameters for getLabels operation in FulfillmentInboundApi.
1136
940
  */
1137
941
  interface FulfillmentInboundApiGetLabelsRequest {
1138
- /**
1139
- * A shipment identifier originally returned by the createInboundShipmentPlan operation.
1140
- */
1141
- readonly shipmentId: string;
1142
- /**
1143
- * The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
1144
- */
1145
- readonly pageType: GetLabelsPageTypeEnum;
1146
- /**
1147
- * The type of labels requested.
1148
- */
1149
- readonly labelType: GetLabelsLabelTypeEnum;
1150
- /**
1151
- * The number of packages in the shipment.
1152
- */
1153
- readonly numberOfPackages?: number;
1154
- /**
1155
- * A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;CartonId&#x60; values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;boxID&#x60; values from the [&#x60;listShipmentBoxes&#x60;](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the &#x60;IncorrectPackageIdentifier&#x60; error code.
1156
- */
1157
- readonly packageLabelsToPrint?: Array<string>;
1158
- /**
1159
- * The number of pallets in the shipment. This returns four identical labels for each pallet.
1160
- */
1161
- readonly numberOfPallets?: number;
1162
- /**
1163
- * The page size for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
1164
- */
1165
- readonly pageSize?: number;
1166
- /**
1167
- * The page start index for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.
1168
- */
1169
- readonly pageStartIndex?: number;
942
+ /**
943
+ * A shipment identifier originally returned by the createInboundShipmentPlan operation.
944
+ */
945
+ readonly shipmentId: string;
946
+ /**
947
+ * The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
948
+ */
949
+ readonly pageType: GetLabelsPageTypeEnum;
950
+ /**
951
+ * The type of labels requested.
952
+ */
953
+ readonly labelType: GetLabelsLabelTypeEnum;
954
+ /**
955
+ * The number of packages in the shipment.
956
+ */
957
+ readonly numberOfPackages?: number;
958
+ /**
959
+ * A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;CartonId&#x60; values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then &#x60;PackageLabelsToPrint&#x60; must match the &#x60;boxID&#x60; values from the [&#x60;listShipmentBoxes&#x60;](https://developer-docs.amazon.com/sp-api/reference/listshipmentboxes) response. If these values do not match as required, the operation returns the &#x60;IncorrectPackageIdentifier&#x60; error code.
960
+ */
961
+ readonly packageLabelsToPrint?: Array<string>;
962
+ /**
963
+ * The number of pallets in the shipment. This returns four identical labels for each pallet.
964
+ */
965
+ readonly numberOfPallets?: number;
966
+ /**
967
+ * The page size for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
968
+ */
969
+ readonly pageSize?: number;
970
+ /**
971
+ * The page start index for paginating through the total packages\&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.
972
+ */
973
+ readonly pageStartIndex?: number;
1170
974
  }
1171
975
  /**
1172
976
  * Request parameters for getPrepInstructions operation in FulfillmentInboundApi.
1173
977
  */
1174
978
  interface FulfillmentInboundApiGetPrepInstructionsRequest {
1175
- /**
1176
- * The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
1177
- */
1178
- readonly shipToCountryCode: string;
1179
- /**
1180
- * A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon\&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
1181
- */
1182
- readonly sellerSKUList?: Array<string>;
1183
- /**
1184
- * A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
1185
- */
1186
- readonly aSINList?: Array<string>;
979
+ /**
980
+ * The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
981
+ */
982
+ readonly shipToCountryCode: string;
983
+ /**
984
+ * A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon\&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
985
+ */
986
+ readonly sellerSKUList?: Array<string>;
987
+ /**
988
+ * A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
989
+ */
990
+ readonly aSINList?: Array<string>;
1187
991
  }
1188
992
  /**
1189
993
  * Request parameters for getShipmentItems operation in FulfillmentInboundApi.
1190
994
  */
1191
995
  interface FulfillmentInboundApiGetShipmentItemsRequest {
1192
- /**
1193
- * Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
1194
- */
1195
- readonly queryType: GetShipmentItemsQueryTypeEnum;
1196
- /**
1197
- * A marketplace identifier. Specifies the marketplace where the product would be stored.
1198
- */
1199
- readonly marketplaceId: string;
1200
- /**
1201
- * A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1202
- */
1203
- readonly lastUpdatedAfter?: string;
1204
- /**
1205
- * A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1206
- */
1207
- readonly lastUpdatedBefore?: string;
1208
- /**
1209
- * A string token returned in the response to your previous request.
1210
- */
1211
- readonly nextToken?: string;
996
+ /**
997
+ * Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
998
+ */
999
+ readonly queryType: GetShipmentItemsQueryTypeEnum;
1000
+ /**
1001
+ * A marketplace identifier. Specifies the marketplace where the product would be stored.
1002
+ */
1003
+ readonly marketplaceId: string;
1004
+ /**
1005
+ * A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1006
+ */
1007
+ readonly lastUpdatedAfter?: string;
1008
+ /**
1009
+ * A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1010
+ */
1011
+ readonly lastUpdatedBefore?: string;
1012
+ /**
1013
+ * A string token returned in the response to your previous request.
1014
+ */
1015
+ readonly nextToken?: string;
1212
1016
  }
1213
1017
  /**
1214
1018
  * Request parameters for getShipmentItemsByShipmentId operation in FulfillmentInboundApi.
1215
1019
  */
1216
1020
  interface FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest {
1217
- /**
1218
- * A shipment identifier used for selecting items in a specific inbound shipment.
1219
- */
1220
- readonly shipmentId: string;
1221
- /**
1222
- * Deprecated. Do not use.
1223
- */
1224
- readonly marketplaceId?: string;
1021
+ /**
1022
+ * A shipment identifier used for selecting items in a specific inbound shipment.
1023
+ */
1024
+ readonly shipmentId: string;
1025
+ /**
1026
+ * Deprecated. Do not use.
1027
+ */
1028
+ readonly marketplaceId?: string;
1225
1029
  }
1226
1030
  /**
1227
1031
  * Request parameters for getShipments operation in FulfillmentInboundApi.
1228
1032
  */
1229
1033
  interface FulfillmentInboundApiGetShipmentsRequest {
1230
- /**
1231
- * Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
1232
- */
1233
- readonly queryType: GetShipmentsQueryTypeEnum;
1234
- /**
1235
- * A marketplace identifier. Specifies the marketplace where the product would be stored.
1236
- */
1237
- readonly marketplaceId: string;
1238
- /**
1239
- * A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
1240
- */
1241
- readonly shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>;
1242
- /**
1243
- * A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
1244
- */
1245
- readonly shipmentIdList?: Array<string>;
1246
- /**
1247
- * A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1248
- */
1249
- readonly lastUpdatedAfter?: string;
1250
- /**
1251
- * A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1252
- */
1253
- readonly lastUpdatedBefore?: string;
1254
- /**
1255
- * A string token returned in the response to your previous request.
1256
- */
1257
- readonly nextToken?: string;
1034
+ /**
1035
+ * Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
1036
+ */
1037
+ readonly queryType: GetShipmentsQueryTypeEnum;
1038
+ /**
1039
+ * A marketplace identifier. Specifies the marketplace where the product would be stored.
1040
+ */
1041
+ readonly marketplaceId: string;
1042
+ /**
1043
+ * A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
1044
+ */
1045
+ readonly shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>;
1046
+ /**
1047
+ * A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
1048
+ */
1049
+ readonly shipmentIdList?: Array<string>;
1050
+ /**
1051
+ * A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1052
+ */
1053
+ readonly lastUpdatedAfter?: string;
1054
+ /**
1055
+ * A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
1056
+ */
1057
+ readonly lastUpdatedBefore?: string;
1058
+ /**
1059
+ * A string token returned in the response to your previous request.
1060
+ */
1061
+ readonly nextToken?: string;
1258
1062
  }
1259
1063
  /**
1260
1064
  * FulfillmentInboundApi - object-oriented interface
1261
1065
  */
1262
1066
  declare class FulfillmentInboundApi extends BaseAPI {
1263
- /**
1264
- * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1265
- * @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
1266
- * @param {*} [options] Override http request option.
1267
- * @throws {RequiredError}
1268
- */
1269
- getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetBillOfLadingResponse, any, {}>>;
1270
- /**
1271
- * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1272
- * @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
1273
- * @param {*} [options] Override http request option.
1274
- * @throws {RequiredError}
1275
- */
1276
- getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetLabelsResponse, any, {}>>;
1277
- /**
1278
- * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1279
- * @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
1280
- * @param {*} [options] Override http request option.
1281
- * @throws {RequiredError}
1282
- */
1283
- getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetPrepInstructionsResponse, any, {}>>;
1284
- /**
1285
- * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1286
- * @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
1287
- * @param {*} [options] Override http request option.
1288
- * @throws {RequiredError}
1289
- */
1290
- getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetShipmentItemsResponse, any, {}>>;
1291
- /**
1292
- * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1293
- * @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
1294
- * @param {*} [options] Override http request option.
1295
- * @throws {RequiredError}
1296
- */
1297
- getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetShipmentItemsResponse, any, {}>>;
1298
- /**
1299
- * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1300
- * @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
1301
- * @param {*} [options] Override http request option.
1302
- * @throws {RequiredError}
1303
- */
1304
- getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetShipmentsResponse, any, {}>>;
1067
+ /**
1068
+ * Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1069
+ * @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
1070
+ * @param {*} [options] Override http request option.
1071
+ * @throws {RequiredError}
1072
+ */
1073
+ getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBillOfLadingResponse, any, {}>>;
1074
+ /**
1075
+ * Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1076
+ * @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
1077
+ * @param {*} [options] Override http request option.
1078
+ * @throws {RequiredError}
1079
+ */
1080
+ getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLabelsResponse, any, {}>>;
1081
+ /**
1082
+ * Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1083
+ * @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
1084
+ * @param {*} [options] Override http request option.
1085
+ * @throws {RequiredError}
1086
+ */
1087
+ getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrepInstructionsResponse, any, {}>>;
1088
+ /**
1089
+ * Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1090
+ * @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
1091
+ * @param {*} [options] Override http request option.
1092
+ * @throws {RequiredError}
1093
+ */
1094
+ getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetShipmentItemsResponse, any, {}>>;
1095
+ /**
1096
+ * Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1097
+ * @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
1098
+ * @param {*} [options] Override http request option.
1099
+ * @throws {RequiredError}
1100
+ */
1101
+ getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetShipmentItemsResponse, any, {}>>;
1102
+ /**
1103
+ * Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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-in-the-sp-api).
1104
+ * @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
1105
+ * @param {*} [options] Override http request option.
1106
+ * @throws {RequiredError}
1107
+ */
1108
+ getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetShipmentsResponse, any, {}>>;
1305
1109
  }
1306
1110
  declare const GetLabelsPageTypeEnum: {
1307
- readonly PackageLabelLetter2: "PackageLabel_Letter_2";
1308
- readonly PackageLabelLetter4: "PackageLabel_Letter_4";
1309
- readonly PackageLabelLetter6: "PackageLabel_Letter_6";
1310
- readonly PackageLabelLetter6CarrierLeft: "PackageLabel_Letter_6_CarrierLeft";
1311
- readonly PackageLabelA42: "PackageLabel_A4_2";
1312
- readonly PackageLabelA44: "PackageLabel_A4_4";
1313
- readonly PackageLabelPlainPaper: "PackageLabel_Plain_Paper";
1314
- readonly PackageLabelPlainPaperCarrierBottom: "PackageLabel_Plain_Paper_CarrierBottom";
1315
- readonly PackageLabelThermal: "PackageLabel_Thermal";
1316
- readonly PackageLabelThermalUnified: "PackageLabel_Thermal_Unified";
1317
- readonly PackageLabelThermalNonPcp: "PackageLabel_Thermal_NonPCP";
1318
- readonly PackageLabelThermalNoCarrierRotation: "PackageLabel_Thermal_No_Carrier_Rotation";
1111
+ readonly PackageLabelLetter2: "PackageLabel_Letter_2";
1112
+ readonly PackageLabelLetter4: "PackageLabel_Letter_4";
1113
+ readonly PackageLabelLetter6: "PackageLabel_Letter_6";
1114
+ readonly PackageLabelLetter6CarrierLeft: "PackageLabel_Letter_6_CarrierLeft";
1115
+ readonly PackageLabelA42: "PackageLabel_A4_2";
1116
+ readonly PackageLabelA44: "PackageLabel_A4_4";
1117
+ readonly PackageLabelPlainPaper: "PackageLabel_Plain_Paper";
1118
+ readonly PackageLabelPlainPaperCarrierBottom: "PackageLabel_Plain_Paper_CarrierBottom";
1119
+ readonly PackageLabelThermal: "PackageLabel_Thermal";
1120
+ readonly PackageLabelThermalUnified: "PackageLabel_Thermal_Unified";
1121
+ readonly PackageLabelThermalNonPcp: "PackageLabel_Thermal_NonPCP";
1122
+ readonly PackageLabelThermalNoCarrierRotation: "PackageLabel_Thermal_No_Carrier_Rotation";
1319
1123
  };
1320
1124
  type GetLabelsPageTypeEnum = typeof GetLabelsPageTypeEnum[keyof typeof GetLabelsPageTypeEnum];
1321
1125
  declare const GetLabelsLabelTypeEnum: {
1322
- readonly Barcode2D: "BARCODE_2D";
1323
- readonly Unique: "UNIQUE";
1324
- readonly Pallet: "PALLET";
1126
+ readonly Barcode2D: "BARCODE_2D";
1127
+ readonly Unique: "UNIQUE";
1128
+ readonly Pallet: "PALLET";
1325
1129
  };
1326
1130
  type GetLabelsLabelTypeEnum = typeof GetLabelsLabelTypeEnum[keyof typeof GetLabelsLabelTypeEnum];
1327
1131
  declare const GetShipmentItemsQueryTypeEnum: {
1328
- readonly DateRange: "DATE_RANGE";
1329
- readonly NextToken: "NEXT_TOKEN";
1132
+ readonly DateRange: "DATE_RANGE";
1133
+ readonly NextToken: "NEXT_TOKEN";
1330
1134
  };
1331
1135
  type GetShipmentItemsQueryTypeEnum = typeof GetShipmentItemsQueryTypeEnum[keyof typeof GetShipmentItemsQueryTypeEnum];
1332
1136
  declare const GetShipmentsQueryTypeEnum: {
1333
- readonly Shipment: "SHIPMENT";
1334
- readonly DateRange: "DATE_RANGE";
1335
- readonly NextToken: "NEXT_TOKEN";
1137
+ readonly Shipment: "SHIPMENT";
1138
+ readonly DateRange: "DATE_RANGE";
1139
+ readonly NextToken: "NEXT_TOKEN";
1336
1140
  };
1337
1141
  type GetShipmentsQueryTypeEnum = typeof GetShipmentsQueryTypeEnum[keyof typeof GetShipmentsQueryTypeEnum];
1338
1142
  declare const GetShipmentsShipmentStatusListEnum: {
1339
- readonly Working: "WORKING";
1340
- readonly ReadyToShip: "READY_TO_SHIP";
1341
- readonly Shipped: "SHIPPED";
1342
- readonly Receiving: "RECEIVING";
1343
- readonly Cancelled: "CANCELLED";
1344
- readonly Deleted: "DELETED";
1345
- readonly Closed: "CLOSED";
1346
- readonly Error: "ERROR";
1347
- readonly InTransit: "IN_TRANSIT";
1348
- readonly Delivered: "DELIVERED";
1349
- readonly CheckedIn: "CHECKED_IN";
1143
+ readonly Working: "WORKING";
1144
+ readonly ReadyToShip: "READY_TO_SHIP";
1145
+ readonly Shipped: "SHIPPED";
1146
+ readonly Receiving: "RECEIVING";
1147
+ readonly Cancelled: "CANCELLED";
1148
+ readonly Deleted: "DELETED";
1149
+ readonly Closed: "CLOSED";
1150
+ readonly Error: "ERROR";
1151
+ readonly InTransit: "IN_TRANSIT";
1152
+ readonly Delivered: "DELIVERED";
1153
+ readonly CheckedIn: "CHECKED_IN";
1350
1154
  };
1351
1155
  type GetShipmentsShipmentStatusListEnum = typeof GetShipmentsShipmentStatusListEnum[keyof typeof GetShipmentsShipmentStatusListEnum];
1352
-
1156
+ //#endregion
1157
+ //#region src/client.d.ts
1353
1158
  declare const clientRateLimits: RateLimit[];
1354
1159
  declare class FulfillmentInboundApiClient extends FulfillmentInboundApi {
1355
- constructor(configuration: ClientConfiguration);
1160
+ constructor(configuration: ClientConfiguration);
1356
1161
  }
1357
-
1358
- export { type ASINPrepInstructions, type Address, type AmazonPrepFeesDetails, type Amount, BarcodeInstruction, type BillOfLadingDownloadURL, type BoxContentsFeeDetails, BoxContentsSource, CurrencyCode, ErrorReason, FulfillmentInboundApi, FulfillmentInboundApiAxiosParamCreator, FulfillmentInboundApiClient, FulfillmentInboundApiFactory, FulfillmentInboundApiFp, type FulfillmentInboundApiGetBillOfLadingRequest, type FulfillmentInboundApiGetLabelsRequest, type FulfillmentInboundApiGetPrepInstructionsRequest, type FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, type FulfillmentInboundApiGetShipmentItemsRequest, type FulfillmentInboundApiGetShipmentsRequest, type GetBillOfLadingResponse, GetLabelsLabelTypeEnum, GetLabelsPageTypeEnum, type GetLabelsResponse, type GetPrepInstructionsResponse, type GetPrepInstructionsResult, GetShipmentItemsQueryTypeEnum, type GetShipmentItemsResponse, type GetShipmentItemsResult, GetShipmentsQueryTypeEnum, type GetShipmentsResponse, type GetShipmentsResult, GetShipmentsShipmentStatusListEnum, type InboundShipmentInfo, type InboundShipmentItem, type InvalidASIN, type InvalidSKU, type LabelDownloadURL, LabelPrepType, type ModelError, type PrepDetails, PrepGuidance, PrepInstruction, PrepOwner, type SKUPrepInstructions, ShipmentStatus, clientRateLimits };
1162
+ //#endregion
1163
+ export { ASINPrepInstructions, Address, AmazonPrepFeesDetails, Amount, BarcodeInstruction, BillOfLadingDownloadURL, BoxContentsFeeDetails, BoxContentsSource, CurrencyCode, ErrorReason, FulfillmentInboundApi, FulfillmentInboundApiAxiosParamCreator, FulfillmentInboundApiClient, FulfillmentInboundApiFactory, FulfillmentInboundApiFp, FulfillmentInboundApiGetBillOfLadingRequest, FulfillmentInboundApiGetLabelsRequest, FulfillmentInboundApiGetPrepInstructionsRequest, FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, FulfillmentInboundApiGetShipmentItemsRequest, FulfillmentInboundApiGetShipmentsRequest, GetBillOfLadingResponse, GetLabelsLabelTypeEnum, GetLabelsPageTypeEnum, GetLabelsResponse, GetPrepInstructionsResponse, GetPrepInstructionsResult, GetShipmentItemsQueryTypeEnum, GetShipmentItemsResponse, GetShipmentItemsResult, GetShipmentsQueryTypeEnum, GetShipmentsResponse, GetShipmentsResult, GetShipmentsShipmentStatusListEnum, InboundShipmentInfo, InboundShipmentItem, InvalidASIN, InvalidSKU, LabelDownloadURL, LabelPrepType, ModelError, PrepDetails, PrepGuidance, PrepInstruction, PrepOwner, SKUPrepInstructions, ShipmentStatus, clientRateLimits };
1164
+ //# sourceMappingURL=index.d.ts.map