@sp-api-sdk/external-fulfillment-shipments-api-2024-09-11 2.0.0 → 2.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.cts CHANGED
@@ -1,7 +1,6 @@
1
- import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
2
- import * as axios from 'axios';
3
- import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
4
-
1
+ import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
2
+ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
3
+ //#region src/api-model/configuration.d.ts
5
4
  /**
6
5
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
7
6
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -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;
101
- }
102
-
103
- /**
104
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
105
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
106
- *
107
- * The version of the OpenAPI document: 2024-09-11
108
- * Contact: marketplaceapitest@amazon.com
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
-
38
+ /**
39
+ * parameter for apiKey security
40
+ * @param name security name
41
+ */
42
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
43
+ /**
44
+ * parameter for basic security
45
+ */
46
+ username?: string;
47
+ /**
48
+ * parameter for basic security
49
+ */
50
+ password?: string;
51
+ /**
52
+ * parameter for oauth2 security
53
+ * @param name security name
54
+ * @param scopes oauth2 scope
55
+ */
56
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
57
+ /**
58
+ * parameter for aws4 signature security
59
+ * @param {Object} AWS4Signature - AWS4 Signature security
60
+ * @param {string} options.region - aws region
61
+ * @param {string} options.service - name of the service.
62
+ * @param {string} credentials.accessKeyId - aws access key id
63
+ * @param {string} credentials.secretAccessKey - aws access key
64
+ * @param {string} credentials.sessionToken - aws session token
65
+ * @memberof Configuration
66
+ */
67
+ awsv4?: AWSv4Configuration;
68
+ /**
69
+ * override base path
70
+ */
71
+ basePath?: string;
72
+ /**
73
+ * override server index
74
+ */
75
+ serverIndex?: number;
76
+ /**
77
+ * base options for axios calls
78
+ */
79
+ baseOptions?: any;
80
+ /**
81
+ * The FormData constructor that will be used to create multipart form data
82
+ * requests. You can inject this here so that execution environments that
83
+ * do not support the FormData class can still run the generated client.
84
+ *
85
+ * @type {new () => FormData}
86
+ */
87
+ formDataCtor?: new () => any;
88
+ constructor(param?: ConfigurationParameters);
89
+ /**
90
+ * Check if the given MIME is a JSON MIME.
91
+ * JSON MIME examples:
92
+ * application/json
93
+ * application/json; charset=UTF8
94
+ * APPLICATION/JSON
95
+ * application/vnd.company+json
96
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
97
+ * @return True if the given MIME is JSON, false otherwise.
98
+ */
99
+ isJsonMime(mime: string): boolean;
100
+ }
101
+ //#endregion
102
+ //#region src/api-model/base.d.ts
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/geocodes.d.ts
126
115
  /**
127
116
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
128
117
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -138,95 +127,85 @@ declare class BaseAPI {
138
127
  * Geographic coordinates.
139
128
  */
140
129
  interface Geocodes {
141
- /**
142
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
143
- */
144
- 'latitude': string;
145
- /**
146
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
147
- */
148
- 'longitude': string;
149
- /**
150
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
151
- */
152
- 'elevation'?: string;
153
- }
154
-
155
- /**
156
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
157
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
158
- *
159
- * The version of the OpenAPI document: 2024-09-11
160
- * Contact: marketplaceapitest@amazon.com
161
- *
162
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
163
- * https://openapi-generator.tech
164
- * Do not edit the class manually.
165
- */
166
-
130
+ /**
131
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
132
+ */
133
+ 'latitude': string;
134
+ /**
135
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
136
+ */
137
+ 'longitude': string;
138
+ /**
139
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
140
+ */
141
+ 'elevation'?: string;
142
+ }
143
+ //#endregion
144
+ //#region src/api-model/models/address.d.ts
167
145
  /**
168
146
  * The address.
169
147
  */
170
148
  interface Address {
171
- /**
172
- * The name of the person, business or institution at that address.
173
- */
174
- 'name'?: string;
175
- /**
176
- * The first line of the address.
177
- */
178
- 'addressLine1'?: string;
179
- /**
180
- * Additional address information, if required.
181
- */
182
- 'addressLine2'?: string;
183
- /**
184
- * Additional address information, if required.
185
- */
186
- 'addressLine3'?: string;
187
- /**
188
- * The district or state where the person, business, or institution is located.
189
- */
190
- 'district'?: string;
191
- /**
192
- * The municipality where the person, business, or institution is located.
193
- */
194
- 'municipality'?: string;
195
- /**
196
- * The state or region where the person, business, or institution is located.
197
- */
198
- 'state'?: string;
199
- /**
200
- * The city where the person, business, or institution is located.
201
- */
202
- 'city'?: string;
203
- /**
204
- * The two digit country code. In ISO 3166-1 alpha-2 format.
205
- */
206
- 'countryCode'?: string;
207
- /**
208
- * The postal code of the address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
209
- */
210
- 'postalCode': string;
211
- /**
212
- * The email address of the contact associated with the address.
213
- */
214
- 'email'?: string;
215
- /**
216
- * The email cc addresses of the contact associated with the address.
217
- */
218
- 'copyEmails'?: Array<string>;
219
- /**
220
- * The phone number of the person, business, or institution located at the address.
221
- */
222
- 'phoneNumber'?: string;
223
- /**
224
- * The type of address.
225
- */
226
- 'addressType'?: string;
227
- 'geocodes'?: Geocodes;
228
- }
229
-
149
+ /**
150
+ * The name of the person, business or institution at that address.
151
+ */
152
+ 'name'?: string;
153
+ /**
154
+ * The first line of the address.
155
+ */
156
+ 'addressLine1'?: string;
157
+ /**
158
+ * Additional address information, if required.
159
+ */
160
+ 'addressLine2'?: string;
161
+ /**
162
+ * Additional address information, if required.
163
+ */
164
+ 'addressLine3'?: string;
165
+ /**
166
+ * The district or state where the person, business, or institution is located.
167
+ */
168
+ 'district'?: string;
169
+ /**
170
+ * The municipality where the person, business, or institution is located.
171
+ */
172
+ 'municipality'?: string;
173
+ /**
174
+ * The state or region where the person, business, or institution is located.
175
+ */
176
+ 'state'?: string;
177
+ /**
178
+ * The city where the person, business, or institution is located.
179
+ */
180
+ 'city'?: string;
181
+ /**
182
+ * The two digit country code. In ISO 3166-1 alpha-2 format.
183
+ */
184
+ 'countryCode'?: string;
185
+ /**
186
+ * The postal code of the address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
187
+ */
188
+ 'postalCode': string;
189
+ /**
190
+ * The email address of the contact associated with the address.
191
+ */
192
+ 'email'?: string;
193
+ /**
194
+ * The email cc addresses of the contact associated with the address.
195
+ */
196
+ 'copyEmails'?: Array<string>;
197
+ /**
198
+ * The phone number of the person, business, or institution located at the address.
199
+ */
200
+ 'phoneNumber'?: string;
201
+ /**
202
+ * The type of address.
203
+ */
204
+ 'addressType'?: string;
205
+ 'geocodes'?: Geocodes;
206
+ }
207
+ //#endregion
208
+ //#region src/api-model/models/amount.d.ts
230
209
  /**
231
210
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
232
211
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -242,16 +221,17 @@ interface Address {
242
221
  * An amount of money, including units in the form of currency.
243
222
  */
244
223
  interface Amount {
245
- /**
246
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
247
- */
248
- 'value': string;
249
- /**
250
- * Three digit currency code in ISO 4217 format.
251
- */
252
- 'currencyCode': string;
253
- }
254
-
224
+ /**
225
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
226
+ */
227
+ 'value': string;
228
+ /**
229
+ * Three digit currency code in ISO 4217 format.
230
+ */
231
+ 'currencyCode': string;
232
+ }
233
+ //#endregion
234
+ //#region src/api-model/models/cancellation.d.ts
255
235
  /**
256
236
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
257
237
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -267,127 +247,95 @@ interface Amount {
267
247
  * A shipment item\'s cancellation details.
268
248
  */
269
249
  interface Cancellation {
270
- /**
271
- * The number of items of this particular item which have been cancelled.
272
- */
273
- 'cancelledQuantity': number;
274
- /**
275
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
276
- */
277
- 'cancelledTimestamp': string;
278
- /**
279
- * The type of cancellation of the item in the shipment.
280
- */
281
- 'cancellationType': CancellationCancellationTypeEnum;
282
- /**
283
- * The reason for the cancellation of the shipment.
284
- */
285
- 'cancellationReason'?: string;
250
+ /**
251
+ * The number of items of this particular item which have been cancelled.
252
+ */
253
+ 'cancelledQuantity': number;
254
+ /**
255
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
256
+ */
257
+ 'cancelledTimestamp': string;
258
+ /**
259
+ * The type of cancellation of the item in the shipment.
260
+ */
261
+ 'cancellationType': CancellationCancellationTypeEnum;
262
+ /**
263
+ * The reason for the cancellation of the shipment.
264
+ */
265
+ 'cancellationReason'?: string;
286
266
  }
287
267
  declare const CancellationCancellationTypeEnum: {
288
- readonly SellerRejected: "SELLER_REJECTED";
289
- readonly MarketplaceCancelled: "MARKETPLACE_CANCELLED";
290
- readonly SystemCancelled: "SYSTEM_CANCELLED";
268
+ readonly SellerRejected: "SELLER_REJECTED";
269
+ readonly MarketplaceCancelled: "MARKETPLACE_CANCELLED";
270
+ readonly SystemCancelled: "SYSTEM_CANCELLED";
291
271
  };
292
272
  type CancellationCancellationTypeEnum = typeof CancellationCancellationTypeEnum[keyof typeof CancellationCancellationTypeEnum];
293
-
294
- /**
295
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
296
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
297
- *
298
- * The version of the OpenAPI document: 2024-09-11
299
- * Contact: marketplaceapitest@amazon.com
300
- *
301
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
302
- * https://openapi-generator.tech
303
- * Do not edit the class manually.
304
- */
305
-
273
+ //#endregion
274
+ //#region src/api-model/models/charge-breakup.d.ts
306
275
  /**
307
276
  * The composition of the charge.
308
277
  */
309
278
  interface ChargeBreakup {
310
- 'baseAmount': Amount;
311
- 'discountAmount': Amount;
312
- 'netAmount': Amount;
279
+ 'baseAmount': Amount;
280
+ 'discountAmount': Amount;
281
+ 'netAmount': Amount;
313
282
  }
314
-
315
- /**
316
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
317
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
318
- *
319
- * The version of the OpenAPI document: 2024-09-11
320
- * Contact: marketplaceapitest@amazon.com
321
- *
322
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
323
- * https://openapi-generator.tech
324
- * Do not edit the class manually.
325
- */
326
-
283
+ //#endregion
284
+ //#region src/api-model/models/tax.d.ts
327
285
  /**
328
286
  * Information about taxes.
329
287
  */
330
288
  interface Tax {
331
- /**
332
- * The type of tax.
333
- */
334
- 'type'?: TaxTypeEnum;
335
- /**
336
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
337
- */
338
- 'rate'?: string;
339
- 'charge': ChargeBreakup;
289
+ /**
290
+ * The type of tax.
291
+ */
292
+ 'type'?: TaxTypeEnum;
293
+ /**
294
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
295
+ */
296
+ 'rate'?: string;
297
+ 'charge': ChargeBreakup;
340
298
  }
341
299
  declare const TaxTypeEnum: {
342
- readonly Vat: "VAT";
343
- readonly Cst: "CST";
344
- readonly Igst: "IGST";
345
- readonly Sgst: "SGST";
346
- readonly Cgst: "CGST";
347
- readonly Utgst: "UTGST";
348
- readonly Cess: "CESS";
349
- readonly Other: "OTHER";
350
- readonly Total: "TOTAL";
300
+ readonly Vat: "VAT";
301
+ readonly Cst: "CST";
302
+ readonly Igst: "IGST";
303
+ readonly Sgst: "SGST";
304
+ readonly Cgst: "CGST";
305
+ readonly Utgst: "UTGST";
306
+ readonly Cess: "CESS";
307
+ readonly Other: "OTHER";
308
+ readonly Total: "TOTAL";
351
309
  };
352
310
  type TaxTypeEnum = typeof TaxTypeEnum[keyof typeof TaxTypeEnum];
353
-
354
- /**
355
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
356
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
357
- *
358
- * The version of the OpenAPI document: 2024-09-11
359
- * Contact: marketplaceapitest@amazon.com
360
- *
361
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
362
- * https://openapi-generator.tech
363
- * Do not edit the class manually.
364
- */
365
-
311
+ //#endregion
312
+ //#region src/api-model/models/charge.d.ts
366
313
  /**
367
314
  * A shipment\'s charge with relevant tax information.
368
315
  */
369
316
  interface Charge {
370
- 'baseCharge': ChargeBreakup;
371
- /**
372
- * The tax charge details.
373
- */
374
- 'taxBreakup'?: Array<Tax>;
375
- /**
376
- * The type of charge.
377
- */
378
- 'chargeType': ChargeChargeTypeEnum;
379
- 'totalCharge': ChargeBreakup;
380
- 'totalTax': Tax;
317
+ 'baseCharge': ChargeBreakup;
318
+ /**
319
+ * The tax charge details.
320
+ */
321
+ 'taxBreakup'?: Array<Tax>;
322
+ /**
323
+ * The type of charge.
324
+ */
325
+ 'chargeType': ChargeChargeTypeEnum;
326
+ 'totalCharge': ChargeBreakup;
327
+ 'totalTax': Tax;
381
328
  }
382
329
  declare const ChargeChargeTypeEnum: {
383
- readonly Product: "PRODUCT";
384
- readonly Shipping: "SHIPPING";
385
- readonly GiftWrap: "GIFT_WRAP";
386
- readonly Total: "TOTAL";
387
- readonly Other: "OTHER";
330
+ readonly Product: "PRODUCT";
331
+ readonly Shipping: "SHIPPING";
332
+ readonly GiftWrap: "GIFT_WRAP";
333
+ readonly Total: "TOTAL";
334
+ readonly Other: "OTHER";
388
335
  };
389
336
  type ChargeChargeTypeEnum = typeof ChargeChargeTypeEnum[keyof typeof ChargeChargeTypeEnum];
390
-
337
+ //#endregion
338
+ //#region src/api-model/models/requirement-level.d.ts
391
339
  /**
392
340
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
393
341
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -403,33 +351,23 @@ type ChargeChargeTypeEnum = typeof ChargeChargeTypeEnum[keyof typeof ChargeCharg
403
351
  * The requirement level for this field.
404
352
  */
405
353
  declare const RequirementLevel: {
406
- readonly Required: "REQUIRED";
407
- readonly Disallowed: "DISALLOWED";
354
+ readonly Required: "REQUIRED";
355
+ readonly Disallowed: "DISALLOWED";
408
356
  };
409
357
  type RequirementLevel = typeof RequirementLevel[keyof typeof RequirementLevel];
410
-
411
- /**
412
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
413
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
414
- *
415
- * The version of the OpenAPI document: 2024-09-11
416
- * Contact: marketplaceapitest@amazon.com
417
- *
418
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
419
- * https://openapi-generator.tech
420
- * Do not edit the class manually.
421
- */
422
-
358
+ //#endregion
359
+ //#region src/api-model/models/compliance-attributes.d.ts
423
360
  /**
424
361
  * All necessary compliance attributes specific to the line item.
425
362
  */
426
363
  interface ComplianceAttributes {
427
- 'hazmatLabelsRequirement': RequirementLevel;
428
- 'serialNumberRequirement': RequirementLevel;
429
- 'countryOfOriginRequirement': RequirementLevel;
430
- 'itemValueRequirement': RequirementLevel;
364
+ 'hazmatLabelsRequirement': RequirementLevel;
365
+ 'serialNumberRequirement': RequirementLevel;
366
+ 'countryOfOriginRequirement': RequirementLevel;
367
+ 'itemValueRequirement': RequirementLevel;
431
368
  }
432
-
369
+ //#endregion
370
+ //#region src/api-model/models/courier-supported-attributes.d.ts
433
371
  /**
434
372
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
435
373
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -445,16 +383,17 @@ interface ComplianceAttributes {
445
383
  * The tracking details of the package if it is shipped by a third party courier. This attribute should only be provided when the value of `shipBy` is `THIRD_PARTY_CARRIER`.
446
384
  */
447
385
  interface CourierSupportedAttributes {
448
- /**
449
- * The name of the courier service used to ship the package
450
- */
451
- 'carrierName': string;
452
- /**
453
- * The tracking number of the package.
454
- */
455
- 'trackingId': string;
456
- }
457
-
386
+ /**
387
+ * The name of the courier service used to ship the package
388
+ */
389
+ 'carrierName': string;
390
+ /**
391
+ * The tracking number of the package.
392
+ */
393
+ 'trackingId': string;
394
+ }
395
+ //#endregion
396
+ //#region src/api-model/models/custom-attribute-type.d.ts
458
397
  /**
459
398
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
460
399
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -470,41 +409,31 @@ interface CourierSupportedAttributes {
470
409
  * The data type of the custom attribute value to aid with parsing during deserialization.
471
410
  */
472
411
  declare const CustomAttributeType: {
473
- readonly String: "STRING";
474
- readonly Boolean: "BOOLEAN";
475
- readonly Integer: "INTEGER";
476
- readonly Double: "DOUBLE";
477
- readonly JsonString: "JSON_STRING";
412
+ readonly String: "STRING";
413
+ readonly Boolean: "BOOLEAN";
414
+ readonly Integer: "INTEGER";
415
+ readonly Double: "DOUBLE";
416
+ readonly JsonString: "JSON_STRING";
478
417
  };
479
418
  type CustomAttributeType = typeof CustomAttributeType[keyof typeof CustomAttributeType];
480
-
481
- /**
482
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
483
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
484
- *
485
- * The version of the OpenAPI document: 2024-09-11
486
- * Contact: marketplaceapitest@amazon.com
487
- *
488
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
489
- * https://openapi-generator.tech
490
- * Do not edit the class manually.
491
- */
492
-
419
+ //#endregion
420
+ //#region src/api-model/models/custom-attribute.d.ts
493
421
  /**
494
422
  * A custom attribute that is loosely typed, modeled through a key-value pair and its data type.
495
423
  */
496
424
  interface CustomAttribute {
497
- /**
498
- * The key of the custom attribute. Must be unique.
499
- */
500
- 'key'?: string;
501
- 'type'?: CustomAttributeType;
502
- /**
503
- * The value of the custom attribute.
504
- */
505
- 'value'?: string;
506
- }
507
-
425
+ /**
426
+ * The key of the custom attribute. Must be unique.
427
+ */
428
+ 'key'?: string;
429
+ 'type'?: CustomAttributeType;
430
+ /**
431
+ * The value of the custom attribute.
432
+ */
433
+ 'value'?: string;
434
+ }
435
+ //#endregion
436
+ //#region src/api-model/models/dimension.d.ts
508
437
  /**
509
438
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
510
439
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -520,22 +449,23 @@ interface CustomAttribute {
520
449
  * A dimension of a package.
521
450
  */
522
451
  interface Dimension {
523
- /**
524
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
525
- */
526
- 'value': string;
527
- /**
528
- * The unit of measurement of the dimension.
529
- */
530
- 'dimensionUnit': DimensionDimensionUnitEnum;
452
+ /**
453
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
454
+ */
455
+ 'value': string;
456
+ /**
457
+ * The unit of measurement of the dimension.
458
+ */
459
+ 'dimensionUnit': DimensionDimensionUnitEnum;
531
460
  }
532
461
  declare const DimensionDimensionUnitEnum: {
533
- readonly Cm: "CM";
534
- readonly M: "M";
535
- readonly In: "IN";
462
+ readonly Cm: "CM";
463
+ readonly M: "M";
464
+ readonly In: "IN";
536
465
  };
537
466
  type DimensionDimensionUnitEnum = typeof DimensionDimensionUnitEnum[keyof typeof DimensionDimensionUnitEnum];
538
-
467
+ //#endregion
468
+ //#region src/api-model/models/distance.d.ts
539
469
  /**
540
470
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
541
471
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -551,21 +481,22 @@ type DimensionDimensionUnitEnum = typeof DimensionDimensionUnitEnum[keyof typeof
551
481
  * A distance measurement.
552
482
  */
553
483
  interface Distance {
554
- /**
555
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
556
- */
557
- 'value': string;
558
- /**
559
- * The unit of measurement of the distance.
560
- */
561
- 'distanceUnit': DistanceDistanceUnitEnum;
484
+ /**
485
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
486
+ */
487
+ 'value': string;
488
+ /**
489
+ * The unit of measurement of the distance.
490
+ */
491
+ 'distanceUnit': DistanceDistanceUnitEnum;
562
492
  }
563
493
  declare const DistanceDistanceUnitEnum: {
564
- readonly Mi: "MI";
565
- readonly Km: "KM";
494
+ readonly Mi: "MI";
495
+ readonly Km: "KM";
566
496
  };
567
497
  type DistanceDistanceUnitEnum = typeof DistanceDistanceUnitEnum[keyof typeof DistanceDistanceUnitEnum];
568
-
498
+ //#endregion
499
+ //#region src/api-model/models/document.d.ts
569
500
  /**
570
501
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
571
502
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -581,23 +512,24 @@ type DistanceDistanceUnitEnum = typeof DistanceDistanceUnitEnum[keyof typeof Dis
581
512
  * A document, described by its file type and data.
582
513
  */
583
514
  interface Document {
584
- /**
585
- * The type of the file.
586
- */
587
- 'format'?: DocumentFormatEnum;
588
- /**
589
- * Base 64 encoded file contents.
590
- */
591
- 'content'?: string;
515
+ /**
516
+ * The type of the file.
517
+ */
518
+ 'format'?: DocumentFormatEnum;
519
+ /**
520
+ * Base 64 encoded file contents.
521
+ */
522
+ 'content'?: string;
592
523
  }
593
524
  declare const DocumentFormatEnum: {
594
- readonly Zpl: "ZPL";
595
- readonly Pdf: "PDF";
596
- readonly Png: "PNG";
597
- readonly PlainText: "PLAIN_TEXT";
525
+ readonly Zpl: "ZPL";
526
+ readonly Pdf: "PDF";
527
+ readonly Png: "PNG";
528
+ readonly PlainText: "PLAIN_TEXT";
598
529
  };
599
530
  type DocumentFormatEnum = typeof DocumentFormatEnum[keyof typeof DocumentFormatEnum];
600
-
531
+ //#endregion
532
+ //#region src/api-model/models/document-v2.d.ts
601
533
  /**
602
534
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
603
535
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -613,12 +545,13 @@ type DocumentFormatEnum = typeof DocumentFormatEnum[keyof typeof DocumentFormatE
613
545
  * An [S3-Presigned URL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html) you can use to retrieve file contents.
614
546
  */
615
547
  interface DocumentV2 {
616
- /**
617
- * A presigned URL to fetch the ship label file using an HTTP GET request. To determine file type, use the `contentType` header of the file response. The file retrieved will be in one of the following supported formats: - **ZPL**: `x.application/zpl` - **PDF**: `application/pdf` - **PNG**: `image/png` - **Plain Text**: `text/plain`
618
- */
619
- 'url': string;
548
+ /**
549
+ * A presigned URL to fetch the ship label file using an HTTP GET request. To determine file type, use the `contentType` header of the file response. The file retrieved will be in one of the following supported formats: - **ZPL**: `x.application/zpl` - **PDF**: `application/pdf` - **PNG**: `image/png` - **Plain Text**: `text/plain`
550
+ */
551
+ 'url': string;
620
552
  }
621
-
553
+ //#endregion
554
+ //#region src/api-model/models/error-list.d.ts
622
555
  /**
623
556
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
624
557
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -634,12 +567,13 @@ interface DocumentV2 {
634
567
  * An object containing a list of error responses returned when a request is unsuccessful.
635
568
  */
636
569
  interface ErrorList {
637
- /**
638
- * A list of error responses returned when a request is unsuccessful.
639
- */
640
- 'errors': Array<Error>;
570
+ /**
571
+ * A list of error responses returned when a request is unsuccessful.
572
+ */
573
+ 'errors': Array<Error>;
641
574
  }
642
-
575
+ //#endregion
576
+ //#region src/api-model/models/presence-status.d.ts
643
577
  /**
644
578
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
645
579
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -655,60 +589,39 @@ interface ErrorList {
655
589
  * Whether the element is present or absent.
656
590
  */
657
591
  declare const PresenceStatus: {
658
- readonly Absent: "ABSENT";
659
- readonly Present: "PRESENT";
592
+ readonly Absent: "ABSENT";
593
+ readonly Present: "PRESENT";
660
594
  };
661
595
  type PresenceStatus = typeof PresenceStatus[keyof typeof PresenceStatus];
662
-
663
- /**
664
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
665
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
666
- *
667
- * The version of the OpenAPI document: 2024-09-11
668
- * Contact: marketplaceapitest@amazon.com
669
- *
670
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
671
- * https://openapi-generator.tech
672
- * Do not edit the class manually.
673
- */
674
-
596
+ //#endregion
597
+ //#region src/api-model/models/gift-attributes.d.ts
675
598
  /**
676
599
  * Information about any gift wrapping that is needed for this line item.
677
600
  */
678
601
  interface GiftAttributes {
679
- 'giftWrapRequirement': RequirementLevel;
680
- /**
681
- * The label to be printed on the wrapped gift.
682
- */
683
- 'giftWrapLabel'?: string;
684
- 'giftMessagePresence': PresenceStatus;
685
- 'giftMessage'?: Document;
602
+ 'giftWrapRequirement': RequirementLevel;
603
+ /**
604
+ * The label to be printed on the wrapped gift.
605
+ */
606
+ 'giftWrapLabel'?: string;
607
+ 'giftMessagePresence': PresenceStatus;
608
+ 'giftMessage'?: Document;
686
609
  }
687
-
688
- /**
689
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
690
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
691
- *
692
- * The version of the OpenAPI document: 2024-09-11
693
- * Contact: marketplaceapitest@amazon.com
694
- *
695
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
696
- * https://openapi-generator.tech
697
- * Do not edit the class manually.
698
- */
699
-
610
+ //#endregion
611
+ //#region src/api-model/models/handover-location.d.ts
700
612
  /**
701
613
  * The drop-off location details for package handover.
702
614
  */
703
615
  interface HandoverLocation {
704
- 'address'?: Address;
705
- 'distance'?: Distance;
706
- /**
707
- * URL to the map that shows the drop-off location.
708
- */
709
- 'mapUrl'?: string;
616
+ 'address'?: Address;
617
+ 'distance'?: Distance;
618
+ /**
619
+ * URL to the map that shows the drop-off location.
620
+ */
621
+ 'mapUrl'?: string;
710
622
  }
711
-
623
+ //#endregion
624
+ //#region src/api-model/models/invoice-info.d.ts
712
625
  /**
713
626
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
714
627
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -724,16 +637,17 @@ interface HandoverLocation {
724
637
  * Information about the shipment\'s invoice.
725
638
  */
726
639
  interface InvoiceInfo {
727
- /**
728
- * The unique ID of the invoice that corresponds to the shipment.
729
- */
730
- 'invoiceId': string;
731
- /**
732
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
733
- */
734
- 'creationDateTime': string;
735
- }
736
-
640
+ /**
641
+ * The unique ID of the invoice that corresponds to the shipment.
642
+ */
643
+ 'invoiceId': string;
644
+ /**
645
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
646
+ */
647
+ 'creationDateTime': string;
648
+ }
649
+ //#endregion
650
+ //#region src/api-model/models/invoice-requirement.d.ts
737
651
  /**
738
652
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
739
653
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -749,46 +663,36 @@ interface InvoiceInfo {
749
663
  * Whether the invoice document is required to be attached to the shipment and its corresponding status.
750
664
  */
751
665
  interface InvoiceRequirement {
752
- /**
753
- * Whether the invoice document is required to be attached to the shipment.
754
- */
755
- 'requirement'?: InvoiceRequirementRequirementEnum;
756
- /**
757
- * The status of the of the invoice document that is attached to the shipment.
758
- */
759
- 'status'?: InvoiceRequirementStatusEnum;
666
+ /**
667
+ * Whether the invoice document is required to be attached to the shipment.
668
+ */
669
+ 'requirement'?: InvoiceRequirementRequirementEnum;
670
+ /**
671
+ * The status of the of the invoice document that is attached to the shipment.
672
+ */
673
+ 'status'?: InvoiceRequirementStatusEnum;
760
674
  }
761
675
  declare const InvoiceRequirementRequirementEnum: {
762
- readonly Required: "REQUIRED";
763
- readonly NotRequired: "NOT_REQUIRED";
676
+ readonly Required: "REQUIRED";
677
+ readonly NotRequired: "NOT_REQUIRED";
764
678
  };
765
679
  type InvoiceRequirementRequirementEnum = typeof InvoiceRequirementRequirementEnum[keyof typeof InvoiceRequirementRequirementEnum];
766
680
  declare const InvoiceRequirementStatusEnum: {
767
- readonly Pending: "PENDING";
768
- readonly Available: "AVAILABLE";
769
- readonly NotAvailable: "NOT_AVAILABLE";
681
+ readonly Pending: "PENDING";
682
+ readonly Available: "AVAILABLE";
683
+ readonly NotAvailable: "NOT_AVAILABLE";
770
684
  };
771
685
  type InvoiceRequirementStatusEnum = typeof InvoiceRequirementStatusEnum[keyof typeof InvoiceRequirementStatusEnum];
772
-
773
- /**
774
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
775
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
776
- *
777
- * The version of the OpenAPI document: 2024-09-11
778
- * Contact: marketplaceapitest@amazon.com
779
- *
780
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
781
- * https://openapi-generator.tech
782
- * Do not edit the class manually.
783
- */
784
-
686
+ //#endregion
687
+ //#region src/api-model/models/invoice-response.d.ts
785
688
  /**
786
689
  * The response of the `generateInvoice` operation.
787
690
  */
788
691
  interface InvoiceResponse {
789
- 'document': Document;
692
+ 'document': Document;
790
693
  }
791
-
694
+ //#endregion
695
+ //#region src/api-model/models/line-item.d.ts
792
696
  /**
793
697
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
794
698
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -804,44 +708,34 @@ interface InvoiceResponse {
804
708
  * Information about the line item being confirmed or rejected.
805
709
  */
806
710
  interface LineItem {
807
- /**
808
- * The identifier of the line item from the shipment that is being confirmed or rejected by the seller.
809
- */
810
- 'id': string;
811
- /**
812
- * The quantity of the line item.
813
- */
814
- 'quantity'?: number;
815
- }
816
-
817
- /**
818
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
819
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
820
- *
821
- * The version of the OpenAPI document: 2024-09-11
822
- * Contact: marketplaceapitest@amazon.com
823
- *
824
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
825
- * https://openapi-generator.tech
826
- * Do not edit the class manually.
827
- */
828
-
711
+ /**
712
+ * The identifier of the line item from the shipment that is being confirmed or rejected by the seller.
713
+ */
714
+ 'id': string;
715
+ /**
716
+ * The quantity of the line item.
717
+ */
718
+ 'quantity'?: number;
719
+ }
720
+ //#endregion
721
+ //#region src/api-model/models/line-item-with-reason.d.ts
829
722
  /**
830
723
  * Information about the line item being confirmed or rejected and the reason for the rejection.
831
724
  */
832
725
  interface LineItemWithReason {
833
- 'lineItem': LineItem;
834
- /**
835
- * The reason for the rejection of the line item.
836
- */
837
- 'reason'?: LineItemWithReasonReasonEnum;
726
+ 'lineItem': LineItem;
727
+ /**
728
+ * The reason for the rejection of the line item.
729
+ */
730
+ 'reason'?: LineItemWithReasonReasonEnum;
838
731
  }
839
732
  declare const LineItemWithReasonReasonEnum: {
840
- readonly OutOfStock: "OUT_OF_STOCK";
841
- readonly CustomerRequested: "CUSTOMER_REQUESTED";
733
+ readonly OutOfStock: "OUT_OF_STOCK";
734
+ readonly CustomerRequested: "CUSTOMER_REQUESTED";
842
735
  };
843
736
  type LineItemWithReasonReasonEnum = typeof LineItemWithReasonReasonEnum[keyof typeof LineItemWithReasonReasonEnum];
844
-
737
+ //#endregion
738
+ //#region src/api-model/models/marketplace-attributes.d.ts
845
739
  /**
846
740
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
847
741
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -857,29 +751,30 @@ type LineItemWithReasonReasonEnum = typeof LineItemWithReasonReasonEnum[keyof ty
857
751
  * The marketplace attributes associated with the location.
858
752
  */
859
753
  interface MarketplaceAttributes {
860
- /**
861
- * The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
862
- */
863
- 'marketplaceId': string;
864
- /**
865
- * The channel name associated with the location.
866
- */
867
- 'channelName': string;
868
- /**
869
- * The ID of the merchant or seller to whom this order is created.
870
- */
871
- 'merchantId'?: string;
872
- /**
873
- * Marketplace channel-specific attribute value.
874
- */
875
- 'customAttributes'?: Array<MarketplaceAttributesCustomAttributesEnum>;
754
+ /**
755
+ * The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
756
+ */
757
+ 'marketplaceId': string;
758
+ /**
759
+ * The channel name associated with the location.
760
+ */
761
+ 'channelName': string;
762
+ /**
763
+ * The ID of the merchant or seller to whom this order is created.
764
+ */
765
+ 'merchantId'?: string;
766
+ /**
767
+ * Marketplace channel-specific attribute value.
768
+ */
769
+ 'customAttributes'?: Array<MarketplaceAttributesCustomAttributesEnum>;
876
770
  }
877
771
  declare const MarketplaceAttributesCustomAttributesEnum: {
878
- readonly Prime: "PRIME";
879
- readonly Fasttrack: "FASTTRACK";
772
+ readonly Prime: "PRIME";
773
+ readonly Fasttrack: "FASTTRACK";
880
774
  };
881
775
  type MarketplaceAttributesCustomAttributesEnum = typeof MarketplaceAttributesCustomAttributesEnum[keyof typeof MarketplaceAttributesCustomAttributesEnum];
882
-
776
+ //#endregion
777
+ //#region src/api-model/models/model-error.d.ts
883
778
  /**
884
779
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
885
780
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -895,110 +790,78 @@ type MarketplaceAttributesCustomAttributesEnum = typeof MarketplaceAttributesCus
895
790
  * Error response returned when the request is unsuccessful.
896
791
  */
897
792
  interface ModelError {
898
- /**
899
- * An error code that identifies the type of error that occurred.
900
- */
901
- 'code': string;
902
- /**
903
- * A message that describes the error condition.
904
- */
905
- 'message': string;
906
- /**
907
- * Additional details that can help the caller understand or fix the issue.
908
- */
909
- 'details'?: string;
910
- }
911
-
912
- /**
913
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
914
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
915
- *
916
- * The version of the OpenAPI document: 2024-09-11
917
- * Contact: marketplaceapitest@amazon.com
918
- *
919
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
920
- * https://openapi-generator.tech
921
- * Do not edit the class manually.
922
- */
923
-
793
+ /**
794
+ * An error code that identifies the type of error that occurred.
795
+ */
796
+ 'code': string;
797
+ /**
798
+ * A message that describes the error condition.
799
+ */
800
+ 'message': string;
801
+ /**
802
+ * Additional details that can help the caller understand or fix the issue.
803
+ */
804
+ 'details'?: string;
805
+ }
806
+ //#endregion
807
+ //#region src/api-model/models/original-line-item.d.ts
924
808
  /**
925
809
  * A line item from the original shipment that corresponds to this shipment.
926
810
  */
927
811
  interface OriginalLineItem {
928
- /**
929
- * The SKU ID for this shipment
930
- */
931
- 'replacingSku': string;
932
- /**
933
- * The SKU ID for the original shipment.
934
- */
935
- 'originalSku': string;
936
- /**
937
- * The charges associated with the shipment.
938
- */
939
- 'charges': Array<Charge>;
940
- }
941
-
942
- /**
943
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
944
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
945
- *
946
- * The version of the OpenAPI document: 2024-09-11
947
- * Contact: marketplaceapitest@amazon.com
948
- *
949
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
950
- * https://openapi-generator.tech
951
- * Do not edit the class manually.
952
- */
953
-
812
+ /**
813
+ * The SKU ID for this shipment
814
+ */
815
+ 'replacingSku': string;
816
+ /**
817
+ * The SKU ID for the original shipment.
818
+ */
819
+ 'originalSku': string;
820
+ /**
821
+ * The charges associated with the shipment.
822
+ */
823
+ 'charges': Array<Charge>;
824
+ }
825
+ //#endregion
826
+ //#region src/api-model/models/package-dimensions.d.ts
954
827
  /**
955
828
  * The dimensions of a package.
956
829
  */
957
830
  interface PackageDimensions {
958
- 'length': Dimension;
959
- 'width': Dimension;
960
- 'height': Dimension;
831
+ 'length': Dimension;
832
+ 'width': Dimension;
833
+ 'height': Dimension;
961
834
  }
962
-
963
- /**
964
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
965
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
966
- *
967
- * The version of the OpenAPI document: 2024-09-11
968
- * Contact: marketplaceapitest@amazon.com
969
- *
970
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
971
- * https://openapi-generator.tech
972
- * Do not edit the class manually.
973
- */
974
-
835
+ //#endregion
836
+ //#region src/api-model/models/package-line-item.d.ts
975
837
  /**
976
838
  * A line item in a package.
977
839
  */
978
840
  interface PackageLineItem {
979
- /**
980
- * The line item ID.
981
- */
982
- 'packageLineItemId': string;
983
- /**
984
- * The number of items of a particular line item of a shipment that are packed into the package.
985
- */
986
- 'quantity': number;
987
- /**
988
- * The list of serial numbers of items in the package, if required to be provided.
989
- */
990
- 'serialNumbers'?: Array<string>;
991
- /**
992
- * The number of pieces of a multi-piece item that are in this package. This is applicable only for items that are shipped in multiple pieces.
993
- */
994
- 'pieces'?: number;
995
- /**
996
- * A two-letter country code, as defined by the ISO-3166 alpha-2 standard.
997
- */
998
- 'countryOfOrigin'?: string;
999
- 'itemValue'?: Amount;
1000
- }
1001
-
841
+ /**
842
+ * The line item ID.
843
+ */
844
+ 'packageLineItemId': string;
845
+ /**
846
+ * The number of items of a particular line item of a shipment that are packed into the package.
847
+ */
848
+ 'quantity': number;
849
+ /**
850
+ * The list of serial numbers of items in the package, if required to be provided.
851
+ */
852
+ 'serialNumbers'?: Array<string>;
853
+ /**
854
+ * The number of pieces of a multi-piece item that are in this package. This is applicable only for items that are shipped in multiple pieces.
855
+ */
856
+ 'pieces'?: number;
857
+ /**
858
+ * A two-letter country code, as defined by the ISO-3166 alpha-2 standard.
859
+ */
860
+ 'countryOfOrigin'?: string;
861
+ 'itemValue'?: Amount;
862
+ }
863
+ //#endregion
864
+ //#region src/api-model/models/weight.d.ts
1002
865
  /**
1003
866
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1004
867
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1014,78 +877,68 @@ interface PackageLineItem {
1014
877
  * The weight of a package.
1015
878
  */
1016
879
  interface Weight {
1017
- /**
1018
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
1019
- */
1020
- 'value': string;
1021
- /**
1022
- * The unit of measurement of the weight.
1023
- */
1024
- 'weightUnit': WeightWeightUnitEnum;
880
+ /**
881
+ * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies.
882
+ */
883
+ 'value': string;
884
+ /**
885
+ * The unit of measurement of the weight.
886
+ */
887
+ 'weightUnit': WeightWeightUnitEnum;
1025
888
  }
1026
889
  declare const WeightWeightUnitEnum: {
1027
- readonly G: "G";
1028
- readonly Kg: "KG";
1029
- readonly Lb: "LB";
1030
- readonly Oz: "OZ";
890
+ readonly G: "G";
891
+ readonly Kg: "KG";
892
+ readonly Lb: "LB";
893
+ readonly Oz: "OZ";
1031
894
  };
1032
895
  type WeightWeightUnitEnum = typeof WeightWeightUnitEnum[keyof typeof WeightWeightUnitEnum];
1033
-
1034
- /**
1035
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1036
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1037
- *
1038
- * The version of the OpenAPI document: 2024-09-11
1039
- * Contact: marketplaceapitest@amazon.com
1040
- *
1041
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1042
- * https://openapi-generator.tech
1043
- * Do not edit the class manually.
1044
- */
1045
-
896
+ //#endregion
897
+ //#region src/api-model/models/package.d.ts
1046
898
  /**
1047
899
  * A package that is created to ship one or more of a shipment\'s line items.
1048
900
  */
1049
901
  interface Package {
1050
- /**
1051
- * An ID that uniquely identifies a package within a shipment.
1052
- */
1053
- 'id': string;
1054
- 'dimensions': PackageDimensions;
1055
- 'weight': Weight;
1056
- /**
1057
- * The optional list of HAZMAT labels applied to the package.
1058
- */
1059
- 'hazmatLabels'?: Array<string>;
1060
- /**
1061
- * The list of line items in a package.
1062
- */
1063
- 'packageLineItems': Array<PackageLineItem>;
1064
- /**
1065
- * The current status of the package.
1066
- */
1067
- 'status'?: PackageStatusEnum;
1068
- /**
1069
- * Whether the package requires standard handling or extra care.
1070
- */
1071
- 'packageHandlingRequirements'?: PackagePackageHandlingRequirementsEnum;
902
+ /**
903
+ * An ID that uniquely identifies a package within a shipment.
904
+ */
905
+ 'id': string;
906
+ 'dimensions': PackageDimensions;
907
+ 'weight': Weight;
908
+ /**
909
+ * The optional list of HAZMAT labels applied to the package.
910
+ */
911
+ 'hazmatLabels'?: Array<string>;
912
+ /**
913
+ * The list of line items in a package.
914
+ */
915
+ 'packageLineItems': Array<PackageLineItem>;
916
+ /**
917
+ * The current status of the package.
918
+ */
919
+ 'status'?: PackageStatusEnum;
920
+ /**
921
+ * Whether the package requires standard handling or extra care.
922
+ */
923
+ 'packageHandlingRequirements'?: PackagePackageHandlingRequirementsEnum;
1072
924
  }
1073
925
  declare const PackageStatusEnum: {
1074
- readonly Created: "CREATED";
1075
- readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
1076
- readonly InvoiceGenerated: "INVOICE_GENERATED";
1077
- readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
1078
- readonly Shipped: "SHIPPED";
1079
- readonly Delivered: "DELIVERED";
1080
- readonly Cancelled: "CANCELLED";
926
+ readonly Created: "CREATED";
927
+ readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
928
+ readonly InvoiceGenerated: "INVOICE_GENERATED";
929
+ readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
930
+ readonly Shipped: "SHIPPED";
931
+ readonly Delivered: "DELIVERED";
932
+ readonly Cancelled: "CANCELLED";
1081
933
  };
1082
934
  type PackageStatusEnum = typeof PackageStatusEnum[keyof typeof PackageStatusEnum];
1083
935
  declare const PackagePackageHandlingRequirementsEnum: {
1084
- readonly Normal: "NORMAL";
1085
- readonly Fragile: "FRAGILE";
936
+ readonly Normal: "NORMAL";
937
+ readonly Fragile: "FRAGILE";
1086
938
  };
1087
939
  type PackagePackageHandlingRequirementsEnum = typeof PackagePackageHandlingRequirementsEnum[keyof typeof PackagePackageHandlingRequirementsEnum];
1088
-
940
+ //#endregion
941
+ //#region src/api-model/models/package-status.d.ts
1089
942
  /**
1090
943
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1091
944
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1101,15 +954,16 @@ type PackagePackageHandlingRequirementsEnum = typeof PackagePackageHandlingRequi
1101
954
  * The status of a package.
1102
955
  */
1103
956
  declare const PackageStatus: {
1104
- readonly Created: "CREATED";
1105
- readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
1106
- readonly InvoiceGenerated: "INVOICE_GENERATED";
1107
- readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
1108
- readonly Shipped: "SHIPPED";
1109
- readonly Delivered: "DELIVERED";
957
+ readonly Created: "CREATED";
958
+ readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
959
+ readonly InvoiceGenerated: "INVOICE_GENERATED";
960
+ readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
961
+ readonly Shipped: "SHIPPED";
962
+ readonly Delivered: "DELIVERED";
1110
963
  };
1111
964
  type PackageStatus = typeof PackageStatus[keyof typeof PackageStatus];
1112
-
965
+ //#endregion
966
+ //#region src/api-model/models/package-sub-status.d.ts
1113
967
  /**
1114
968
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1115
969
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1125,37 +979,27 @@ type PackageStatus = typeof PackageStatus[keyof typeof PackageStatus];
1125
979
  * The sub-status of a package.
1126
980
  */
1127
981
  declare const PackageSubStatus: {
1128
- readonly OutForDelivery: "OUT_FOR_DELIVERY";
1129
- readonly Delivered: "DELIVERED";
1130
- readonly NotDelivered: "NOT_DELIVERED";
1131
- readonly Undeliverable: "UNDELIVERABLE";
982
+ readonly OutForDelivery: "OUT_FOR_DELIVERY";
983
+ readonly Delivered: "DELIVERED";
984
+ readonly NotDelivered: "NOT_DELIVERED";
985
+ readonly Undeliverable: "UNDELIVERABLE";
1132
986
  };
1133
987
  type PackageSubStatus = typeof PackageSubStatus[keyof typeof PackageSubStatus];
1134
-
1135
- /**
1136
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1137
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1138
- *
1139
- * The version of the OpenAPI document: 2024-09-11
1140
- * Contact: marketplaceapitest@amazon.com
1141
- *
1142
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1143
- * https://openapi-generator.tech
1144
- * Do not edit the class manually.
1145
- */
1146
-
988
+ //#endregion
989
+ //#region src/api-model/models/package-delivery-status.d.ts
1147
990
  /**
1148
991
  * The delivery status of the package.
1149
992
  */
1150
993
  interface PackageDeliveryStatus {
1151
- 'status'?: PackageStatus;
1152
- 'subStatus'?: PackageSubStatus;
1153
- /**
1154
- * The reason for the sub-status.
1155
- */
1156
- 'reason'?: string;
994
+ 'status'?: PackageStatus;
995
+ 'subStatus'?: PackageSubStatus;
996
+ /**
997
+ * The reason for the sub-status.
998
+ */
999
+ 'reason'?: string;
1157
1000
  }
1158
-
1001
+ //#endregion
1002
+ //#region src/api-model/models/time-window.d.ts
1159
1003
  /**
1160
1004
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1161
1005
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1171,58 +1015,48 @@ interface PackageDeliveryStatus {
1171
1015
  * Time duration used to specify the interval of an event, such as pick up and delivery.
1172
1016
  */
1173
1017
  interface TimeWindow {
1174
- /**
1175
- * The start time of the window.
1176
- */
1177
- 'startTime': number;
1178
- /**
1179
- * The end time of the window.
1180
- */
1181
- 'endTime': number;
1182
- /**
1183
- * Whether the seller picks up from Amazon Logistics or drops off to Amazon Logistics.
1184
- */
1185
- 'handoverMethod'?: TimeWindowHandoverMethodEnum;
1018
+ /**
1019
+ * The start time of the window.
1020
+ */
1021
+ 'startTime': number;
1022
+ /**
1023
+ * The end time of the window.
1024
+ */
1025
+ 'endTime': number;
1026
+ /**
1027
+ * Whether the seller picks up from Amazon Logistics or drops off to Amazon Logistics.
1028
+ */
1029
+ 'handoverMethod'?: TimeWindowHandoverMethodEnum;
1186
1030
  }
1187
1031
  declare const TimeWindowHandoverMethodEnum: {
1188
- readonly Pickup: "PICKUP";
1189
- readonly Dropoff: "DROPOFF";
1032
+ readonly Pickup: "PICKUP";
1033
+ readonly Dropoff: "DROPOFF";
1190
1034
  };
1191
1035
  type TimeWindowHandoverMethodEnum = typeof TimeWindowHandoverMethodEnum[keyof typeof TimeWindowHandoverMethodEnum];
1192
-
1193
- /**
1194
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1195
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1196
- *
1197
- * The version of the OpenAPI document: 2024-09-11
1198
- * Contact: marketplaceapitest@amazon.com
1199
- *
1200
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1201
- * https://openapi-generator.tech
1202
- * Do not edit the class manually.
1203
- */
1204
-
1036
+ //#endregion
1037
+ //#region src/api-model/models/ship-label-metadata.d.ts
1205
1038
  /**
1206
1039
  * Metadata for a ship label document.
1207
1040
  */
1208
1041
  interface ShipLabelMetadata {
1209
- /**
1210
- * The selected slot for the ship label.
1211
- */
1212
- 'shippingOptionId'?: string;
1213
- /**
1214
- * The name of the carrier.
1215
- */
1216
- 'carrierName': string;
1217
- /**
1218
- * The tracking number of the package.
1219
- */
1220
- 'trackingId': string;
1221
- 'pickupWindow'?: TimeWindow;
1222
- 'timeSlot'?: TimeWindow;
1223
- 'handoverLocation'?: HandoverLocation;
1224
- }
1225
-
1042
+ /**
1043
+ * The selected slot for the ship label.
1044
+ */
1045
+ 'shippingOptionId'?: string;
1046
+ /**
1047
+ * The name of the carrier.
1048
+ */
1049
+ 'carrierName': string;
1050
+ /**
1051
+ * The tracking number of the package.
1052
+ */
1053
+ 'trackingId': string;
1054
+ 'pickupWindow'?: TimeWindow;
1055
+ 'timeSlot'?: TimeWindow;
1056
+ 'handoverLocation'?: HandoverLocation;
1057
+ }
1058
+ //#endregion
1059
+ //#region src/api-model/models/status.d.ts
1226
1060
  /**
1227
1061
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1228
1062
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1238,59 +1072,38 @@ interface ShipLabelMetadata {
1238
1072
  * The outcome of the operation.
1239
1073
  */
1240
1074
  declare const Status: {
1241
- readonly Success: "SUCCESS";
1242
- readonly Failure: "FAILURE";
1075
+ readonly Success: "SUCCESS";
1076
+ readonly Failure: "FAILURE";
1243
1077
  };
1244
1078
  type Status = typeof Status[keyof typeof Status];
1245
-
1246
- /**
1247
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1248
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1249
- *
1250
- * The version of the OpenAPI document: 2024-09-11
1251
- * Contact: marketplaceapitest@amazon.com
1252
- *
1253
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1254
- * https://openapi-generator.tech
1255
- * Do not edit the class manually.
1256
- */
1257
-
1079
+ //#endregion
1080
+ //#region src/api-model/models/package-ship-label.d.ts
1258
1081
  /**
1259
1082
  * A shipping label with a label document for a single package. If label generation fails, you can use the `status` and `errorDetails` attributes to determine the cause of failure.
1260
1083
  */
1261
1084
  interface PackageShipLabel {
1262
- /**
1263
- * The package ID of the package.
1264
- */
1265
- 'packageId'?: string;
1266
- 'shipLabelMetadata'?: ShipLabelMetadata;
1267
- 'fileData'?: DocumentV2;
1268
- 'status'?: Status;
1269
- 'errorDetails'?: Error;
1270
- }
1271
-
1272
- /**
1273
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1274
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1275
- *
1276
- * The version of the OpenAPI document: 2024-09-11
1277
- * Contact: marketplaceapitest@amazon.com
1278
- *
1279
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1280
- * https://openapi-generator.tech
1281
- * Do not edit the class manually.
1282
- */
1283
-
1085
+ /**
1086
+ * The package ID of the package.
1087
+ */
1088
+ 'packageId'?: string;
1089
+ 'shipLabelMetadata'?: ShipLabelMetadata;
1090
+ 'fileData'?: DocumentV2;
1091
+ 'status'?: Status;
1092
+ 'errorDetails'?: Error;
1093
+ }
1094
+ //#endregion
1095
+ //#region src/api-model/models/packages.d.ts
1284
1096
  /**
1285
1097
  * The request schema of the `createPackages` operation.
1286
1098
  */
1287
1099
  interface Packages {
1288
- /**
1289
- * A list of packages.
1290
- */
1291
- 'packages': Array<Package>;
1100
+ /**
1101
+ * A list of packages.
1102
+ */
1103
+ 'packages': Array<Package>;
1292
1104
  }
1293
-
1105
+ //#endregion
1106
+ //#region src/api-model/models/packing-slip-requirement.d.ts
1294
1107
  /**
1295
1108
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1296
1109
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1306,26 +1119,27 @@ interface Packages {
1306
1119
  * Whether the packing slip is required to be attached to the shipment, and its corresponding status.
1307
1120
  */
1308
1121
  interface PackingSlipRequirement {
1309
- /**
1310
- * Whether the packing slip is required to be attached to the shipment.
1311
- */
1312
- 'requirement'?: PackingSlipRequirementRequirementEnum;
1313
- /**
1314
- * The status of the packing slip that is attached to the shipment.
1315
- */
1316
- 'status'?: PackingSlipRequirementStatusEnum;
1122
+ /**
1123
+ * Whether the packing slip is required to be attached to the shipment.
1124
+ */
1125
+ 'requirement'?: PackingSlipRequirementRequirementEnum;
1126
+ /**
1127
+ * The status of the packing slip that is attached to the shipment.
1128
+ */
1129
+ 'status'?: PackingSlipRequirementStatusEnum;
1317
1130
  }
1318
1131
  declare const PackingSlipRequirementRequirementEnum: {
1319
- readonly Required: "REQUIRED";
1320
- readonly NotRequired: "NOT_REQUIRED";
1132
+ readonly Required: "REQUIRED";
1133
+ readonly NotRequired: "NOT_REQUIRED";
1321
1134
  };
1322
1135
  type PackingSlipRequirementRequirementEnum = typeof PackingSlipRequirementRequirementEnum[keyof typeof PackingSlipRequirementRequirementEnum];
1323
1136
  declare const PackingSlipRequirementStatusEnum: {
1324
- readonly Generated: "GENERATED";
1325
- readonly NotGenerated: "NOT_GENERATED";
1137
+ readonly Generated: "GENERATED";
1138
+ readonly NotGenerated: "NOT_GENERATED";
1326
1139
  };
1327
1140
  type PackingSlipRequirementStatusEnum = typeof PackingSlipRequirementStatusEnum[keyof typeof PackingSlipRequirementStatusEnum];
1328
-
1141
+ //#endregion
1142
+ //#region src/api-model/models/pagination.d.ts
1329
1143
  /**
1330
1144
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1331
1145
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1341,83 +1155,62 @@ type PackingSlipRequirementStatusEnum = typeof PackingSlipRequirementStatusEnum[
1341
1155
  * An object representing data required for pagination of results.
1342
1156
  */
1343
1157
  interface Pagination {
1344
- /**
1345
- * A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
1346
- */
1347
- 'nextToken'?: string;
1158
+ /**
1159
+ * A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
1160
+ */
1161
+ 'nextToken'?: string;
1348
1162
  }
1349
-
1350
- /**
1351
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1352
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1353
- *
1354
- * The version of the OpenAPI document: 2024-09-11
1355
- * Contact: marketplaceapitest@amazon.com
1356
- *
1357
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1358
- * https://openapi-generator.tech
1359
- * Do not edit the class manually.
1360
- */
1361
-
1163
+ //#endregion
1164
+ //#region src/api-model/models/tax-registration-info.d.ts
1362
1165
  /**
1363
1166
  * Tax registration details of the entity. Applicable to direct fulfillment shipments.
1364
1167
  */
1365
1168
  interface TaxRegistrationInfo {
1366
- /**
1367
- * Tax registration type for the entity
1368
- */
1369
- 'type'?: TaxRegistrationInfoTypeEnum;
1370
- /**
1371
- * The tax registration number for the party. For example, their VAT ID.
1372
- */
1373
- 'number'?: string;
1374
- 'address'?: Address;
1375
- /**
1376
- * Tax registration message that can be used for additional tax related details.
1377
- */
1378
- 'messages'?: string;
1169
+ /**
1170
+ * Tax registration type for the entity
1171
+ */
1172
+ 'type'?: TaxRegistrationInfoTypeEnum;
1173
+ /**
1174
+ * The tax registration number for the party. For example, their VAT ID.
1175
+ */
1176
+ 'number'?: string;
1177
+ 'address'?: Address;
1178
+ /**
1179
+ * Tax registration message that can be used for additional tax related details.
1180
+ */
1181
+ 'messages'?: string;
1379
1182
  }
1380
1183
  declare const TaxRegistrationInfoTypeEnum: {
1381
- readonly Vat: "VAT";
1382
- readonly Gst: "GST";
1184
+ readonly Vat: "VAT";
1185
+ readonly Gst: "GST";
1383
1186
  };
1384
1187
  type TaxRegistrationInfoTypeEnum = typeof TaxRegistrationInfoTypeEnum[keyof typeof TaxRegistrationInfoTypeEnum];
1385
-
1386
- /**
1387
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1388
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1389
- *
1390
- * The version of the OpenAPI document: 2024-09-11
1391
- * Contact: marketplaceapitest@amazon.com
1392
- *
1393
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1394
- * https://openapi-generator.tech
1395
- * Do not edit the class manually.
1396
- */
1397
-
1188
+ //#endregion
1189
+ //#region src/api-model/models/party-identification-info.d.ts
1398
1190
  /**
1399
1191
  * Party identification details for the shipment, applicable to direct fulfillment shipments.
1400
1192
  */
1401
1193
  interface PartyIdentificationInfo {
1402
- /**
1403
- * Assigned identification for the party. For example, a warehouse code or vendor code.
1404
- */
1405
- 'partyId': string;
1406
- /**
1407
- * Assigned identification for the party. For example, a warehouse code or vendor code.
1408
- */
1409
- 'partyType': PartyIdentificationInfoPartyTypeEnum;
1410
- 'address'?: Address;
1411
- 'taxInfo'?: TaxRegistrationInfo;
1194
+ /**
1195
+ * Assigned identification for the party. For example, a warehouse code or vendor code.
1196
+ */
1197
+ 'partyId': string;
1198
+ /**
1199
+ * Assigned identification for the party. For example, a warehouse code or vendor code.
1200
+ */
1201
+ 'partyType': PartyIdentificationInfoPartyTypeEnum;
1202
+ 'address'?: Address;
1203
+ 'taxInfo'?: TaxRegistrationInfo;
1412
1204
  }
1413
1205
  declare const PartyIdentificationInfoPartyTypeEnum: {
1414
- readonly BillToParty: "BILL_TO_PARTY";
1415
- readonly ShipToParty: "SHIP_TO_PARTY";
1416
- readonly ShipFromParty: "SHIP_FROM_PARTY";
1417
- readonly SellingParty: "SELLING_PARTY";
1206
+ readonly BillToParty: "BILL_TO_PARTY";
1207
+ readonly ShipToParty: "SHIP_TO_PARTY";
1208
+ readonly ShipFromParty: "SHIP_FROM_PARTY";
1209
+ readonly SellingParty: "SELLING_PARTY";
1418
1210
  };
1419
1211
  type PartyIdentificationInfoPartyTypeEnum = typeof PartyIdentificationInfoPartyTypeEnum[keyof typeof PartyIdentificationInfoPartyTypeEnum];
1420
-
1212
+ //#endregion
1213
+ //#region src/api-model/models/piece-type.d.ts
1421
1214
  /**
1422
1215
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1423
1216
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1433,11 +1226,12 @@ type PartyIdentificationInfoPartyTypeEnum = typeof PartyIdentificationInfoPartyT
1433
1226
  * Whether the item is a single piece or multiple pieces.
1434
1227
  */
1435
1228
  declare const PieceType: {
1436
- readonly Single: "SINGLE";
1437
- readonly Multiple: "MULTIPLE";
1229
+ readonly Single: "SINGLE";
1230
+ readonly Multiple: "MULTIPLE";
1438
1231
  };
1439
1232
  type PieceType = typeof PieceType[keyof typeof PieceType];
1440
-
1233
+ //#endregion
1234
+ //#region src/api-model/models/priority.d.ts
1441
1235
  /**
1442
1236
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1443
1237
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1453,11 +1247,12 @@ type PieceType = typeof PieceType[keyof typeof PieceType];
1453
1247
  * The priority of the order.
1454
1248
  */
1455
1249
  declare const Priority: {
1456
- readonly High: "HIGH";
1457
- readonly Low: "LOW";
1250
+ readonly High: "HIGH";
1251
+ readonly Low: "LOW";
1458
1252
  };
1459
1253
  type Priority = typeof Priority[keyof typeof Priority];
1460
-
1254
+ //#endregion
1255
+ //#region src/api-model/models/recommended-package-line-item.d.ts
1461
1256
  /**
1462
1257
  * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1463
1258
  * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
@@ -1473,1054 +1268,914 @@ type Priority = typeof Priority[keyof typeof Priority];
1473
1268
  * A line item to be contained in a recommended package. This attribute is provided only for orders that come with a specific recommendation of line-item distribution within the package recommendations.
1474
1269
  */
1475
1270
  interface RecommendedPackageLineItem {
1476
- /**
1477
- * An ID for a line item in an order. The line item should be present in the recommended package. This identifier has the same value as the ID of the line item present in the order.
1478
- */
1479
- 'lineItemId': string;
1271
+ /**
1272
+ * An ID for a line item in an order. The line item should be present in the recommended package. This identifier has the same value as the ID of the line item present in the order.
1273
+ */
1274
+ 'lineItemId': string;
1480
1275
  }
1481
-
1482
- /**
1483
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1484
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1485
- *
1486
- * The version of the OpenAPI document: 2024-09-11
1487
- * Contact: marketplaceapitest@amazon.com
1488
- *
1489
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1490
- * https://openapi-generator.tech
1491
- * Do not edit the class manually.
1492
- */
1493
-
1276
+ //#endregion
1277
+ //#region src/api-model/models/recommended-package.d.ts
1494
1278
  /**
1495
1279
  * Recommendations for a package
1496
1280
  */
1497
1281
  interface RecommendedPackage {
1498
- 'dimensions': PackageDimensions;
1499
- 'weight': Weight;
1500
- /**
1501
- * A list of line items to be contained in a recommended package. This attribute is only for orders that come with specific recommendations for line-item distribution.
1502
- */
1503
- 'lineItems': Array<RecommendedPackageLineItem>;
1282
+ 'dimensions': PackageDimensions;
1283
+ 'weight': Weight;
1284
+ /**
1285
+ * A list of line items to be contained in a recommended package. This attribute is only for orders that come with specific recommendations for line-item distribution.
1286
+ */
1287
+ 'lineItems': Array<RecommendedPackageLineItem>;
1504
1288
  }
1505
-
1506
- /**
1507
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1508
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1509
- *
1510
- * The version of the OpenAPI document: 2024-09-11
1511
- * Contact: marketplaceapitest@amazon.com
1512
- *
1513
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1514
- * https://openapi-generator.tech
1515
- * Do not edit the class manually.
1516
- */
1517
-
1289
+ //#endregion
1290
+ //#region src/api-model/models/replaced-shipment-info.d.ts
1518
1291
  /**
1519
1292
  * Details of the original shipment if `shipmentType` is either `REPLACEMENT` or `EXCHANGE`.
1520
1293
  */
1521
1294
  interface ReplacedShipmentInfo {
1522
- /**
1523
- * The original shipment\'s ID.
1524
- */
1525
- 'id': string;
1526
- /**
1527
- * The original shipment\'s location ID.
1528
- */
1529
- 'locationId': string;
1530
- 'marketplaceAttributes': MarketplaceAttributes;
1531
- /**
1532
- * The line items from the original shipment that corresponds to this shipment.
1533
- */
1534
- 'originalLineItems'?: Array<OriginalLineItem>;
1535
- }
1536
-
1537
- /**
1538
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1539
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1540
- *
1541
- * The version of the OpenAPI document: 2024-09-11
1542
- * Contact: marketplaceapitest@amazon.com
1543
- *
1544
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1545
- * https://openapi-generator.tech
1546
- * Do not edit the class manually.
1547
- */
1548
-
1295
+ /**
1296
+ * The original shipment\'s ID.
1297
+ */
1298
+ 'id': string;
1299
+ /**
1300
+ * The original shipment\'s location ID.
1301
+ */
1302
+ 'locationId': string;
1303
+ 'marketplaceAttributes': MarketplaceAttributes;
1304
+ /**
1305
+ * The line items from the original shipment that corresponds to this shipment.
1306
+ */
1307
+ 'originalLineItems'?: Array<OriginalLineItem>;
1308
+ }
1309
+ //#endregion
1310
+ //#region src/api-model/models/ship-labels-input.d.ts
1549
1311
  /**
1550
1312
  * Tracking details for multiple packages.
1551
1313
  */
1552
1314
  interface ShipLabelsInput {
1553
- /**
1554
- * The subset of package IDs used to generate a label.
1555
- */
1556
- 'packageIds': Array<string>;
1557
- 'courierSupportedAttributes'?: CourierSupportedAttributes;
1315
+ /**
1316
+ * The subset of package IDs used to generate a label.
1317
+ */
1318
+ 'packageIds': Array<string>;
1319
+ 'courierSupportedAttributes'?: CourierSupportedAttributes;
1558
1320
  }
1559
-
1560
- /**
1561
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1562
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1563
- *
1564
- * The version of the OpenAPI document: 2024-09-11
1565
- * Contact: marketplaceapitest@amazon.com
1566
- *
1567
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1568
- * https://openapi-generator.tech
1569
- * Do not edit the class manually.
1570
- */
1571
-
1321
+ //#endregion
1322
+ //#region src/api-model/models/ship-labels-response.d.ts
1572
1323
  /**
1573
1324
  * The response to the `generateShipLabels` operation.
1574
1325
  */
1575
1326
  interface ShipLabelsResponse {
1576
- /**
1577
- * A list of label documents for each package specified in the request. In case of partial failures when generating labels, the `isErrored` and `errorDetails` attributes detail the cause of failure.
1578
- */
1579
- 'packageShipLabelList': Array<PackageShipLabel>;
1327
+ /**
1328
+ * A list of label documents for each package specified in the request. In case of partial failures when generating labels, the `isErrored` and `errorDetails` attributes detail the cause of failure.
1329
+ */
1330
+ 'packageShipLabelList': Array<PackageShipLabel>;
1580
1331
  }
1581
-
1582
- /**
1583
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1584
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1585
- *
1586
- * The version of the OpenAPI document: 2024-09-11
1587
- * Contact: marketplaceapitest@amazon.com
1588
- *
1589
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1590
- * https://openapi-generator.tech
1591
- * Do not edit the class manually.
1592
- */
1593
-
1332
+ //#endregion
1333
+ //#region src/api-model/models/shipment-info.d.ts
1594
1334
  /**
1595
1335
  * High-level details of the shipment.
1596
1336
  */
1597
1337
  interface ShipmentInfo {
1598
- /**
1599
- * The type of shipment.
1600
- */
1601
- 'shipmentType': ShipmentInfoShipmentTypeEnum;
1602
- 'originalShipmentInfo'?: ReplacedShipmentInfo;
1603
- /**
1604
- * Total number of units in the shipment.
1605
- */
1606
- 'numberOfUnits': number;
1607
- 'priority': Priority;
1608
- /**
1609
- * The buyer\'s order ID.
1610
- */
1611
- 'buyerOrderId': string;
1612
- /**
1613
- * A list of order statuses for which the marketplace allows order rejection (seller cancellation). If the order has a status that does not belong to this list, then seller cancellation is not possible.
1614
- */
1615
- 'orderStatesEligibleForRejection'?: Array<string>;
1616
- /**
1617
- * The timestamp of when the order was placed, in UTC
1618
- */
1619
- 'orderPlacedTimestamp'?: string;
1620
- /**
1621
- * The source of the order operation.
1622
- */
1623
- 'processingSource'?: ShipmentInfoProcessingSourceEnum;
1624
- /**
1625
- * The payment method for the shipment.
1626
- */
1627
- 'paymentMethod'?: ShipmentInfoPaymentMethodEnum;
1338
+ /**
1339
+ * The type of shipment.
1340
+ */
1341
+ 'shipmentType': ShipmentInfoShipmentTypeEnum;
1342
+ 'originalShipmentInfo'?: ReplacedShipmentInfo;
1343
+ /**
1344
+ * Total number of units in the shipment.
1345
+ */
1346
+ 'numberOfUnits': number;
1347
+ 'priority': Priority;
1348
+ /**
1349
+ * The buyer\'s order ID.
1350
+ */
1351
+ 'buyerOrderId': string;
1352
+ /**
1353
+ * A list of order statuses for which the marketplace allows order rejection (seller cancellation). If the order has a status that does not belong to this list, then seller cancellation is not possible.
1354
+ */
1355
+ 'orderStatesEligibleForRejection'?: Array<string>;
1356
+ /**
1357
+ * The timestamp of when the order was placed, in UTC
1358
+ */
1359
+ 'orderPlacedTimestamp'?: string;
1360
+ /**
1361
+ * The source of the order operation.
1362
+ */
1363
+ 'processingSource'?: ShipmentInfoProcessingSourceEnum;
1364
+ /**
1365
+ * The payment method for the shipment.
1366
+ */
1367
+ 'paymentMethod'?: ShipmentInfoPaymentMethodEnum;
1628
1368
  }
1629
1369
  declare const ShipmentInfoShipmentTypeEnum: {
1630
- readonly New: "NEW";
1631
- readonly Exchange: "EXCHANGE";
1632
- readonly Replacement: "REPLACEMENT";
1370
+ readonly New: "NEW";
1371
+ readonly Exchange: "EXCHANGE";
1372
+ readonly Replacement: "REPLACEMENT";
1633
1373
  };
1634
1374
  type ShipmentInfoShipmentTypeEnum = typeof ShipmentInfoShipmentTypeEnum[keyof typeof ShipmentInfoShipmentTypeEnum];
1635
1375
  declare const ShipmentInfoProcessingSourceEnum: {
1636
- readonly ExternalPlatform: "EXTERNAL_PLATFORM";
1637
- readonly InternalPlatform: "INTERNAL_PLATFORM";
1376
+ readonly ExternalPlatform: "EXTERNAL_PLATFORM";
1377
+ readonly InternalPlatform: "INTERNAL_PLATFORM";
1638
1378
  };
1639
1379
  type ShipmentInfoProcessingSourceEnum = typeof ShipmentInfoProcessingSourceEnum[keyof typeof ShipmentInfoProcessingSourceEnum];
1640
1380
  declare const ShipmentInfoPaymentMethodEnum: {
1641
- readonly CashOnDelivery: "CASH_ON_DELIVERY";
1642
- readonly Prepaid: "PREPAID";
1381
+ readonly CashOnDelivery: "CASH_ON_DELIVERY";
1382
+ readonly Prepaid: "PREPAID";
1643
1383
  };
1644
1384
  type ShipmentInfoPaymentMethodEnum = typeof ShipmentInfoPaymentMethodEnum[keyof typeof ShipmentInfoPaymentMethodEnum];
1645
-
1646
- /**
1647
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1648
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1649
- *
1650
- * The version of the OpenAPI document: 2024-09-11
1651
- * Contact: marketplaceapitest@amazon.com
1652
- *
1653
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1654
- * https://openapi-generator.tech
1655
- * Do not edit the class manually.
1656
- */
1657
-
1385
+ //#endregion
1386
+ //#region src/api-model/models/shipment-line-item.d.ts
1658
1387
  /**
1659
1388
  * Information about a line item in a shipment.
1660
1389
  */
1661
1390
  interface ShipmentLineItem {
1662
- /**
1663
- * An identifier for a shipment\'s line item. This identifier is guaranteed to be unique within the scope of its containing shipment.
1664
- */
1665
- 'shipmentLineItemId': string;
1666
- /**
1667
- * The seller SKU of a product (catalog item). A unique number assigned by the seller when listing an item.
1668
- */
1669
- 'merchantSku': string;
1670
- /**
1671
- * The number of items of the SKU in this line item.
1672
- */
1673
- 'numberOfUnits': number;
1674
- /**
1675
- * The serial numbers for each item in this line item.
1676
- */
1677
- 'serialNumbers'?: Array<string>;
1678
- 'pieceType'?: PieceType;
1679
- /**
1680
- * A list of HAZMAT label identifiers that must be applied to the packages for this line item.
1681
- */
1682
- 'hazmatLabels'?: Array<string>;
1683
- 'giftAttributes'?: GiftAttributes;
1684
- /**
1685
- * The charges associated with the shipment.
1686
- */
1687
- 'charges': Array<Charge>;
1688
- /**
1689
- * A list of cancellations for the given line item. **Note:** Currently, SmartConnect does not support partial cancellation of a shipment or its line items. This list will contain a single value with all the cancellation details.
1690
- */
1691
- 'cancellations'?: Array<Cancellation>;
1692
- /**
1693
- * The HSN code of SKU in this line item.
1694
- */
1695
- 'hsnCode'?: string;
1696
- /**
1697
- * A two-letter country code, as defined by the ISO-3166 alpha-2 standard.
1698
- */
1699
- 'recommendedCountryOfOrigin'?: string;
1700
- /**
1701
- * A two-letter country code, as defined by the ISO-3166 alpha-2 standard.
1702
- */
1703
- 'countryOfOrigin'?: string;
1704
- /**
1705
- * The three digit currency code of the currency recommended by the marketplace, in ISO 4217 format.
1706
- */
1707
- 'recommendedCurrencyCode'?: string;
1708
- 'itemValue'?: Amount;
1709
- 'complianceAttributes': ComplianceAttributes;
1710
- /**
1711
- * A list of custom passthrough attributes. For details on these attributes, reach out to your respective program teams at Amazon.
1712
- */
1713
- 'customAttributes'?: Array<CustomAttribute>;
1714
- }
1715
-
1716
- /**
1717
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1718
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1719
- *
1720
- * The version of the OpenAPI document: 2024-09-11
1721
- * Contact: marketplaceapitest@amazon.com
1722
- *
1723
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1724
- * https://openapi-generator.tech
1725
- * Do not edit the class manually.
1726
- */
1727
-
1391
+ /**
1392
+ * An identifier for a shipment\'s line item. This identifier is guaranteed to be unique within the scope of its containing shipment.
1393
+ */
1394
+ 'shipmentLineItemId': string;
1395
+ /**
1396
+ * The seller SKU of a product (catalog item). A unique number assigned by the seller when listing an item.
1397
+ */
1398
+ 'merchantSku': string;
1399
+ /**
1400
+ * The number of items of the SKU in this line item.
1401
+ */
1402
+ 'numberOfUnits': number;
1403
+ /**
1404
+ * The serial numbers for each item in this line item.
1405
+ */
1406
+ 'serialNumbers'?: Array<string>;
1407
+ 'pieceType'?: PieceType;
1408
+ /**
1409
+ * A list of HAZMAT label identifiers that must be applied to the packages for this line item.
1410
+ */
1411
+ 'hazmatLabels'?: Array<string>;
1412
+ 'giftAttributes'?: GiftAttributes;
1413
+ /**
1414
+ * The charges associated with the shipment.
1415
+ */
1416
+ 'charges': Array<Charge>;
1417
+ /**
1418
+ * A list of cancellations for the given line item. **Note:** Currently, SmartConnect does not support partial cancellation of a shipment or its line items. This list will contain a single value with all the cancellation details.
1419
+ */
1420
+ 'cancellations'?: Array<Cancellation>;
1421
+ /**
1422
+ * The HSN code of SKU in this line item.
1423
+ */
1424
+ 'hsnCode'?: string;
1425
+ /**
1426
+ * A two-letter country code, as defined by the ISO-3166 alpha-2 standard.
1427
+ */
1428
+ 'recommendedCountryOfOrigin'?: string;
1429
+ /**
1430
+ * A two-letter country code, as defined by the ISO-3166 alpha-2 standard.
1431
+ */
1432
+ 'countryOfOrigin'?: string;
1433
+ /**
1434
+ * The three digit currency code of the currency recommended by the marketplace, in ISO 4217 format.
1435
+ */
1436
+ 'recommendedCurrencyCode'?: string;
1437
+ 'itemValue'?: Amount;
1438
+ 'complianceAttributes': ComplianceAttributes;
1439
+ /**
1440
+ * A list of custom passthrough attributes. For details on these attributes, reach out to your respective program teams at Amazon.
1441
+ */
1442
+ 'customAttributes'?: Array<CustomAttribute>;
1443
+ }
1444
+ //#endregion
1445
+ //#region src/api-model/models/shipment-requirements.d.ts
1728
1446
  /**
1729
1447
  * Whether specific capabilities are enabled or required for the shipment.
1730
1448
  */
1731
1449
  interface ShipmentRequirements {
1732
- 'pSlip': PackingSlipRequirement;
1733
- 'invoice': InvoiceRequirement;
1450
+ 'pSlip': PackingSlipRequirement;
1451
+ 'invoice': InvoiceRequirement;
1734
1452
  }
1735
-
1736
- /**
1737
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1738
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1739
- *
1740
- * The version of the OpenAPI document: 2024-09-11
1741
- * Contact: marketplaceapitest@amazon.com
1742
- *
1743
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1744
- * https://openapi-generator.tech
1745
- * Do not edit the class manually.
1746
- */
1747
-
1453
+ //#endregion
1454
+ //#region src/api-model/models/shipping-info.d.ts
1748
1455
  /**
1749
1456
  * Shipping information for the packages in a shipment.
1750
1457
  */
1751
1458
  interface ShippingInfo {
1752
- /**
1753
- * The ship method recommended by the Amazon Fulfillment Network for the packages in this shipment.
1754
- */
1755
- 'recommendedShipMethod'?: string;
1756
- /**
1757
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1758
- */
1759
- 'expectedShippingDateTimeInUTC': string;
1760
- 'shipToAddress'?: Address;
1761
- /**
1762
- * The type of shipping that the seller uses to deliver a customer order.
1763
- */
1764
- 'shippingType'?: ShippingInfoShippingTypeEnum;
1765
- /**
1766
- * Recommendations for the packages in an order.
1767
- */
1768
- 'recommendedPackages'?: Array<RecommendedPackage>;
1459
+ /**
1460
+ * The ship method recommended by the Amazon Fulfillment Network for the packages in this shipment.
1461
+ */
1462
+ 'recommendedShipMethod'?: string;
1463
+ /**
1464
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1465
+ */
1466
+ 'expectedShippingDateTimeInUTC': string;
1467
+ 'shipToAddress'?: Address;
1468
+ /**
1469
+ * The type of shipping that the seller uses to deliver a customer order.
1470
+ */
1471
+ 'shippingType'?: ShippingInfoShippingTypeEnum;
1472
+ /**
1473
+ * Recommendations for the packages in an order.
1474
+ */
1475
+ 'recommendedPackages'?: Array<RecommendedPackage>;
1769
1476
  }
1770
1477
  declare const ShippingInfoShippingTypeEnum: {
1771
- readonly Marketplace: "MARKETPLACE";
1772
- readonly Self: "SELF";
1478
+ readonly Marketplace: "MARKETPLACE";
1479
+ readonly Self: "SELF";
1773
1480
  };
1774
1481
  type ShippingInfoShippingTypeEnum = typeof ShippingInfoShippingTypeEnum[keyof typeof ShippingInfoShippingTypeEnum];
1775
-
1776
- /**
1777
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1778
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1779
- *
1780
- * The version of the OpenAPI document: 2024-09-11
1781
- * Contact: marketplaceapitest@amazon.com
1782
- *
1783
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1784
- * https://openapi-generator.tech
1785
- * Do not edit the class manually.
1786
- */
1787
-
1482
+ //#endregion
1483
+ //#region src/api-model/models/shipment.d.ts
1788
1484
  /**
1789
1485
  * Information about a shipment.
1790
1486
  */
1791
1487
  interface Shipment {
1792
- /**
1793
- * The shipment\'s ID.
1794
- */
1795
- 'id': string;
1796
- /**
1797
- * The location identifier of the seller\'s location in the marketplace channel to which the shipment has been created for fulfillment.
1798
- */
1799
- 'locationId': string;
1800
- 'marketplaceAttributes': MarketplaceAttributes;
1801
- 'shipmentInfo': ShipmentInfo;
1802
- 'invoiceInfo'?: InvoiceInfo;
1803
- /**
1804
- * All involved party identification and metadata for the vendor, buyer, and seller. Applicable for direct-fulfillment sellers.
1805
- */
1806
- 'partyInfoList'?: Array<PartyIdentificationInfo>;
1807
- 'shipmentRequirements': ShipmentRequirements;
1808
- /**
1809
- * The charges associated with the shipment.
1810
- */
1811
- 'charges': Array<Charge>;
1812
- /**
1813
- * The current status of the shipment.
1814
- */
1815
- 'status': ShipmentStatusEnum;
1816
- /**
1817
- * The sub status of the shipment.
1818
- */
1819
- 'subStatus'?: ShipmentSubStatusEnum;
1820
- /**
1821
- * The reason for the sub-status.
1822
- */
1823
- 'reason'?: string;
1824
- /**
1825
- * The line items in the shipment.
1826
- */
1827
- 'lineItems': Array<ShipmentLineItem>;
1828
- 'shippingInfo': ShippingInfo;
1829
- /**
1830
- * The list of packages in the shipment.
1831
- */
1832
- 'packages'?: Array<Package>;
1833
- /**
1834
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1835
- */
1836
- 'creationDateTime': string;
1837
- /**
1838
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1839
- */
1840
- 'lastUpdatedDateTime': string;
1841
- /**
1842
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1843
- */
1844
- 'earliestPackDateTime'?: string;
1488
+ /**
1489
+ * The shipment\'s ID.
1490
+ */
1491
+ 'id': string;
1492
+ /**
1493
+ * The location identifier of the seller\'s location in the marketplace channel to which the shipment has been created for fulfillment.
1494
+ */
1495
+ 'locationId': string;
1496
+ 'marketplaceAttributes': MarketplaceAttributes;
1497
+ 'shipmentInfo': ShipmentInfo;
1498
+ 'invoiceInfo'?: InvoiceInfo;
1499
+ /**
1500
+ * All involved party identification and metadata for the vendor, buyer, and seller. Applicable for direct-fulfillment sellers.
1501
+ */
1502
+ 'partyInfoList'?: Array<PartyIdentificationInfo>;
1503
+ 'shipmentRequirements': ShipmentRequirements;
1504
+ /**
1505
+ * The charges associated with the shipment.
1506
+ */
1507
+ 'charges': Array<Charge>;
1508
+ /**
1509
+ * The current status of the shipment.
1510
+ */
1511
+ 'status': ShipmentStatusEnum;
1512
+ /**
1513
+ * The sub status of the shipment.
1514
+ */
1515
+ 'subStatus'?: ShipmentSubStatusEnum;
1516
+ /**
1517
+ * The reason for the sub-status.
1518
+ */
1519
+ 'reason'?: string;
1520
+ /**
1521
+ * The line items in the shipment.
1522
+ */
1523
+ 'lineItems': Array<ShipmentLineItem>;
1524
+ 'shippingInfo': ShippingInfo;
1525
+ /**
1526
+ * The list of packages in the shipment.
1527
+ */
1528
+ 'packages'?: Array<Package>;
1529
+ /**
1530
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1531
+ */
1532
+ 'creationDateTime': string;
1533
+ /**
1534
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1535
+ */
1536
+ 'lastUpdatedDateTime': string;
1537
+ /**
1538
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
1539
+ */
1540
+ 'earliestPackDateTime'?: string;
1845
1541
  }
1846
1542
  declare const ShipmentStatusEnum: {
1847
- readonly Created: "CREATED";
1848
- readonly Accepted: "ACCEPTED";
1849
- readonly Confirmed: "CONFIRMED";
1850
- readonly PackageCreated: "PACKAGE_CREATED";
1851
- readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
1852
- readonly InvoiceGenerated: "INVOICE_GENERATED";
1853
- readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
1854
- readonly Cancelled: "CANCELLED";
1855
- readonly Shipped: "SHIPPED";
1856
- readonly Delivered: "DELIVERED";
1543
+ readonly Created: "CREATED";
1544
+ readonly Accepted: "ACCEPTED";
1545
+ readonly Confirmed: "CONFIRMED";
1546
+ readonly PackageCreated: "PACKAGE_CREATED";
1547
+ readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
1548
+ readonly InvoiceGenerated: "INVOICE_GENERATED";
1549
+ readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
1550
+ readonly Cancelled: "CANCELLED";
1551
+ readonly Shipped: "SHIPPED";
1552
+ readonly Delivered: "DELIVERED";
1857
1553
  };
1858
1554
  type ShipmentStatusEnum = typeof ShipmentStatusEnum[keyof typeof ShipmentStatusEnum];
1859
1555
  declare const ShipmentSubStatusEnum: {
1860
- readonly PendingSchedule: "PENDING_SCHEDULE";
1861
- readonly PendingPickup: "PENDING_PICKUP";
1862
- readonly PendingDropOff: "PENDING_DROP_OFF";
1863
- readonly LabelCanceled: "LABEL_CANCELED";
1864
- readonly PickedUp: "PICKED_UP";
1865
- readonly DroppedOff: "DROPPED_OFF";
1866
- readonly AtOriginFc: "AT_ORIGIN_FC";
1867
- readonly AtDestinationFc: "AT_DESTINATION_FC";
1868
- readonly Delivered: "DELIVERED";
1869
- readonly NotDelivered: "NOT_DELIVERED";
1870
- readonly Undeliverable: "UNDELIVERABLE";
1871
- readonly Lost: "LOST";
1872
- readonly OutForDelivery: "OUT_FOR_DELIVERY";
1873
- readonly Damaged: "DAMAGED";
1556
+ readonly PendingSchedule: "PENDING_SCHEDULE";
1557
+ readonly PendingPickup: "PENDING_PICKUP";
1558
+ readonly PendingDropOff: "PENDING_DROP_OFF";
1559
+ readonly LabelCanceled: "LABEL_CANCELED";
1560
+ readonly PickedUp: "PICKED_UP";
1561
+ readonly DroppedOff: "DROPPED_OFF";
1562
+ readonly AtOriginFc: "AT_ORIGIN_FC";
1563
+ readonly AtDestinationFc: "AT_DESTINATION_FC";
1564
+ readonly Delivered: "DELIVERED";
1565
+ readonly NotDelivered: "NOT_DELIVERED";
1566
+ readonly Undeliverable: "UNDELIVERABLE";
1567
+ readonly Lost: "LOST";
1568
+ readonly OutForDelivery: "OUT_FOR_DELIVERY";
1569
+ readonly Damaged: "DAMAGED";
1874
1570
  };
1875
1571
  type ShipmentSubStatusEnum = typeof ShipmentSubStatusEnum[keyof typeof ShipmentSubStatusEnum];
1876
-
1877
- /**
1878
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1879
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1880
- *
1881
- * The version of the OpenAPI document: 2024-09-11
1882
- * Contact: marketplaceapitest@amazon.com
1883
- *
1884
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1885
- * https://openapi-generator.tech
1886
- * Do not edit the class manually.
1887
- */
1888
-
1572
+ //#endregion
1573
+ //#region src/api-model/models/shipment-acknowledgement-request.d.ts
1889
1574
  /**
1890
1575
  * Information about the shipment and its line items, used to confirm or reject line items.
1891
1576
  */
1892
1577
  interface ShipmentAcknowledgementRequest {
1893
- /**
1894
- * A unique identifier for every shipment rejection.
1895
- */
1896
- 'referenceId'?: string;
1897
- /**
1898
- * Details about the line items from the shipment that are being confirmed or rejected by the seller.
1899
- */
1900
- 'lineItems': Array<LineItemWithReason>;
1901
- }
1902
-
1903
- /**
1904
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1905
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1906
- *
1907
- * The version of the OpenAPI document: 2024-09-11
1908
- * Contact: marketplaceapitest@amazon.com
1909
- *
1910
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1911
- * https://openapi-generator.tech
1912
- * Do not edit the class manually.
1913
- */
1914
-
1578
+ /**
1579
+ * A unique identifier for every shipment rejection.
1580
+ */
1581
+ 'referenceId'?: string;
1582
+ /**
1583
+ * Details about the line items from the shipment that are being confirmed or rejected by the seller.
1584
+ */
1585
+ 'lineItems': Array<LineItemWithReason>;
1586
+ }
1587
+ //#endregion
1588
+ //#region src/api-model/models/shipments-response.d.ts
1915
1589
  /**
1916
1590
  * The response of the `getShipments` operation.
1917
1591
  */
1918
1592
  interface ShipmentsResponse {
1919
- /**
1920
- * A list of shipments.
1921
- */
1922
- 'shipments'?: Array<Shipment>;
1923
- 'pagination'?: Pagination;
1593
+ /**
1594
+ * A list of shipments.
1595
+ */
1596
+ 'shipments'?: Array<Shipment>;
1597
+ 'pagination'?: Pagination;
1924
1598
  }
1925
-
1926
- /**
1927
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1928
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1929
- *
1930
- * The version of the OpenAPI document: 2024-09-11
1931
- * Contact: marketplaceapitest@amazon.com
1932
- *
1933
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1934
- * https://openapi-generator.tech
1935
- * Do not edit the class manually.
1936
- */
1937
-
1599
+ //#endregion
1600
+ //#region src/api-model/models/shipping-options.d.ts
1938
1601
  /**
1939
1602
  * Shipping options for a single package.
1940
1603
  */
1941
1604
  interface ShippingOptions {
1942
- /**
1943
- * An identifier for the shipping option.
1944
- */
1945
- 'shippingOptionId': string;
1946
- /**
1947
- * The shipper type.
1948
- */
1949
- 'shipBy': ShippingOptionsShipByEnum;
1950
- /**
1951
- * The carrier name for the offering.
1952
- */
1953
- 'carrierName'?: string;
1954
- 'pickupWindow'?: TimeWindow;
1955
- 'timeSlot'?: TimeWindow;
1956
- 'handoverLocation'?: HandoverLocation;
1605
+ /**
1606
+ * An identifier for the shipping option.
1607
+ */
1608
+ 'shippingOptionId': string;
1609
+ /**
1610
+ * The shipper type.
1611
+ */
1612
+ 'shipBy': ShippingOptionsShipByEnum;
1613
+ /**
1614
+ * The carrier name for the offering.
1615
+ */
1616
+ 'carrierName'?: string;
1617
+ 'pickupWindow'?: TimeWindow;
1618
+ 'timeSlot'?: TimeWindow;
1619
+ 'handoverLocation'?: HandoverLocation;
1957
1620
  }
1958
1621
  declare const ShippingOptionsShipByEnum: {
1959
- readonly Marketplace: "MARKETPLACE";
1960
- readonly Seller: "SELLER";
1961
- readonly ThirdPartyCarrier: "THIRD_PARTY_CARRIER";
1962
- readonly Other: "OTHER";
1622
+ readonly Marketplace: "MARKETPLACE";
1623
+ readonly Seller: "SELLER";
1624
+ readonly ThirdPartyCarrier: "THIRD_PARTY_CARRIER";
1625
+ readonly Other: "OTHER";
1963
1626
  };
1964
1627
  type ShippingOptionsShipByEnum = typeof ShippingOptionsShipByEnum[keyof typeof ShippingOptionsShipByEnum];
1965
-
1966
- /**
1967
- * The Selling Partner API for Amazon External Fulfillment Shipments Processing
1968
- * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
1969
- *
1970
- * The version of the OpenAPI document: 2024-09-11
1971
- * Contact: marketplaceapitest@amazon.com
1972
- *
1973
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1974
- * https://openapi-generator.tech
1975
- * Do not edit the class manually.
1976
- */
1977
-
1628
+ //#endregion
1629
+ //#region src/api-model/models/shipping-options-response.d.ts
1978
1630
  /**
1979
1631
  * The response to the `retrieveShippingOptions` operation. The response contains shipping options on a per-package basis from which the seller has to select one shipping option while they retrieve the shipping label. If the particular marketplace channel does not support scheduled shipping options, then this response will be empty.
1980
1632
  */
1981
1633
  interface ShippingOptionsResponse {
1982
- /**
1983
- * A list of shipping options.
1984
- */
1985
- 'shippingOptions'?: Array<ShippingOptions>;
1986
- 'recommendedShippingOption'?: ShippingOptions;
1634
+ /**
1635
+ * A list of shipping options.
1636
+ */
1637
+ 'shippingOptions'?: Array<ShippingOptions>;
1638
+ 'recommendedShippingOption'?: ShippingOptions;
1987
1639
  }
1988
-
1640
+ //#endregion
1641
+ //#region src/api-model/api/external-fulfillment-shipments-api.d.ts
1989
1642
  /**
1990
1643
  * ExternalFulfillmentShipmentsApi - axios parameter creator
1991
1644
  */
1992
1645
  declare const ExternalFulfillmentShipmentsApiAxiosParamCreator: (configuration?: Configuration) => {
1993
- /**
1994
- * Provide details about the packages in the specified shipment.
1995
- * @param {string} shipmentId The ID of the shipment.
1996
- * @param {Packages} body A list of packages in the shipment.
1997
- * @param {*} [options] Override http request option.
1998
- * @throws {RequiredError}
1999
- */
2000
- createPackages: (shipmentId: string, body: Packages, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2001
- /**
2002
- * Get invoices for the shipment you specify.
2003
- * @param {string} shipmentId The ID of the shipment whose invoice you want.
2004
- * @param {*} [options] Override http request option.
2005
- * @throws {RequiredError}
2006
- */
2007
- generateInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2008
- /**
2009
- * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
2010
- * @param {string} shipmentId The ID of the shipment whose shipping labels you want to generate and retrieve.
2011
- * @param {GenerateShipLabelsOperationEnum} operation Specify whether you want to generate or regenerate a label.
2012
- * @param {string} [shippingOptionId] The ID of the shipping option whose shipping labels you want.
2013
- * @param {ShipLabelsInput} [body] Shipping details for when shipping is not done by the marketplace channel.
2014
- * @param {*} [options] Override http request option.
2015
- * @throws {RequiredError}
2016
- */
2017
- generateShipLabels: (shipmentId: string, operation: GenerateShipLabelsOperationEnum, shippingOptionId?: string, body?: ShipLabelsInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2018
- /**
2019
- * Get a single shipment with the ID you specify.
2020
- * @param {string} shipmentId The ID of the shipment you want to retrieve.
2021
- * @param {*} [options] Override http request option.
2022
- * @throws {RequiredError}
2023
- */
2024
- getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2025
- /**
2026
- * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
2027
- * @param {GetShipmentsStatusEnum} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;CREATED&#x60; or &#x60;ACCEPTED&#x60;.
2028
- * @param {string} [locationId] The Amazon channel location identifier for the shipments you want to retrieve.
2029
- * @param {string} [marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
2030
- * @param {string} [channelName] The channel name associated with the location.
2031
- * @param {string} [lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
2032
- * @param {string} [lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
2033
- * @param {number} [maxResults] The maximum number of shipments to include in the response.
2034
- * @param {string} [paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
2035
- * @param {*} [options] Override http request option.
2036
- * @throws {RequiredError}
2037
- */
2038
- getShipments: (status: GetShipmentsStatusEnum, locationId?: string, marketplaceId?: string, channelName?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2039
- /**
2040
- * Confirm or reject the specified shipment.
2041
- * @param {string} shipmentId The ID of the shipment you want to confirm or reject.
2042
- * @param {ProcessShipmentOperationEnum} operation The status of the shipment.
2043
- * @param {ShipmentAcknowledgementRequest} [body] Information about the shipment and its line items.
2044
- * @param {*} [options] Override http request option.
2045
- * @throws {RequiredError}
2046
- */
2047
- processShipment: (shipmentId: string, operation: ProcessShipmentOperationEnum, body?: ShipmentAcknowledgementRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2048
- /**
2049
- * Retrieve invoices for the shipment you specify.
2050
- * @param {string} shipmentId The ID of the shipment whose invoice you want to retrieve.
2051
- * @param {*} [options] Override http request option.
2052
- * @throws {RequiredError}
2053
- */
2054
- retrieveInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2055
- /**
2056
- * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
2057
- * @param {string} shipmentId The ID of the shipment to which the package belongs.
2058
- * @param {string} packageId The ID of the package for which you want to retrieve shipping options.
2059
- * @param {*} [options] Override http request option.
2060
- * @throws {RequiredError}
2061
- */
2062
- retrieveShippingOptions: (shipmentId: string, packageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2063
- /**
2064
- * Updates the details about the packages that will be used to fulfill the specified shipment.
2065
- * @param {string} shipmentId The ID of the shipment to which the package belongs.
2066
- * @param {string} packageId The ID of the package whose information you want to update.
2067
- * @param {Package} body The body of the request.
2068
- * @param {*} [options] Override http request option.
2069
- * @throws {RequiredError}
2070
- */
2071
- updatePackage: (shipmentId: string, packageId: string, body: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2072
- /**
2073
- * Updates the status of the packages.
2074
- * @param {string} shipmentId The ID of the shipment to which the package belongs.
2075
- * @param {string} packageId The ID of the package whose status you want to update.
2076
- * @param {UpdatePackageStatusStatusEnum} [status] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
2077
- * @param {PackageDeliveryStatus} [body] The body of the request.
2078
- * @param {*} [options] Override http request option.
2079
- * @throws {RequiredError}
2080
- */
2081
- updatePackageStatus: (shipmentId: string, packageId: string, status?: UpdatePackageStatusStatusEnum, body?: PackageDeliveryStatus, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1646
+ /**
1647
+ * Provide details about the packages in the specified shipment.
1648
+ * @param {string} shipmentId The ID of the shipment.
1649
+ * @param {Packages} body A list of packages in the shipment.
1650
+ * @param {*} [options] Override http request option.
1651
+ * @throws {RequiredError}
1652
+ */
1653
+ createPackages: (shipmentId: string, body: Packages, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1654
+ /**
1655
+ * Get invoices for the shipment you specify.
1656
+ * @param {string} shipmentId The ID of the shipment whose invoice you want.
1657
+ * @param {*} [options] Override http request option.
1658
+ * @throws {RequiredError}
1659
+ */
1660
+ generateInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1661
+ /**
1662
+ * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
1663
+ * @param {string} shipmentId The ID of the shipment whose shipping labels you want to generate and retrieve.
1664
+ * @param {GenerateShipLabelsOperationEnum} operation Specify whether you want to generate or regenerate a label.
1665
+ * @param {string} [shippingOptionId] The ID of the shipping option whose shipping labels you want.
1666
+ * @param {ShipLabelsInput} [body] Shipping details for when shipping is not done by the marketplace channel.
1667
+ * @param {*} [options] Override http request option.
1668
+ * @throws {RequiredError}
1669
+ */
1670
+ generateShipLabels: (shipmentId: string, operation: GenerateShipLabelsOperationEnum, shippingOptionId?: string, body?: ShipLabelsInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1671
+ /**
1672
+ * Get a single shipment with the ID you specify.
1673
+ * @param {string} shipmentId The ID of the shipment you want to retrieve.
1674
+ * @param {*} [options] Override http request option.
1675
+ * @throws {RequiredError}
1676
+ */
1677
+ getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1678
+ /**
1679
+ * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
1680
+ * @param {GetShipmentsStatusEnum} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;CREATED&#x60; or &#x60;ACCEPTED&#x60;.
1681
+ * @param {string} [locationId] The Amazon channel location identifier for the shipments you want to retrieve.
1682
+ * @param {string} [marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1683
+ * @param {string} [channelName] The channel name associated with the location.
1684
+ * @param {string} [lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1685
+ * @param {string} [lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1686
+ * @param {number} [maxResults] The maximum number of shipments to include in the response.
1687
+ * @param {string} [paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1688
+ * @param {*} [options] Override http request option.
1689
+ * @throws {RequiredError}
1690
+ */
1691
+ getShipments: (status: GetShipmentsStatusEnum, locationId?: string, marketplaceId?: string, channelName?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1692
+ /**
1693
+ * Confirm or reject the specified shipment.
1694
+ * @param {string} shipmentId The ID of the shipment you want to confirm or reject.
1695
+ * @param {ProcessShipmentOperationEnum} operation The status of the shipment.
1696
+ * @param {ShipmentAcknowledgementRequest} [body] Information about the shipment and its line items.
1697
+ * @param {*} [options] Override http request option.
1698
+ * @throws {RequiredError}
1699
+ */
1700
+ processShipment: (shipmentId: string, operation: ProcessShipmentOperationEnum, body?: ShipmentAcknowledgementRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1701
+ /**
1702
+ * Retrieve invoices for the shipment you specify.
1703
+ * @param {string} shipmentId The ID of the shipment whose invoice you want to retrieve.
1704
+ * @param {*} [options] Override http request option.
1705
+ * @throws {RequiredError}
1706
+ */
1707
+ retrieveInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1708
+ /**
1709
+ * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
1710
+ * @param {string} shipmentId The ID of the shipment to which the package belongs.
1711
+ * @param {string} packageId The ID of the package for which you want to retrieve shipping options.
1712
+ * @param {*} [options] Override http request option.
1713
+ * @throws {RequiredError}
1714
+ */
1715
+ retrieveShippingOptions: (shipmentId: string, packageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1716
+ /**
1717
+ * Updates the details about the packages that will be used to fulfill the specified shipment.
1718
+ * @param {string} shipmentId The ID of the shipment to which the package belongs.
1719
+ * @param {string} packageId The ID of the package whose information you want to update.
1720
+ * @param {Package} body The body of the request.
1721
+ * @param {*} [options] Override http request option.
1722
+ * @throws {RequiredError}
1723
+ */
1724
+ updatePackage: (shipmentId: string, packageId: string, body: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1725
+ /**
1726
+ * Updates the status of the packages.
1727
+ * @param {string} shipmentId The ID of the shipment to which the package belongs.
1728
+ * @param {string} packageId The ID of the package whose status you want to update.
1729
+ * @param {UpdatePackageStatusStatusEnum} [status] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
1730
+ * @param {PackageDeliveryStatus} [body] The body of the request.
1731
+ * @param {*} [options] Override http request option.
1732
+ * @throws {RequiredError}
1733
+ */
1734
+ updatePackageStatus: (shipmentId: string, packageId: string, status?: UpdatePackageStatusStatusEnum, body?: PackageDeliveryStatus, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2082
1735
  };
2083
1736
  /**
2084
1737
  * ExternalFulfillmentShipmentsApi - functional programming interface
2085
1738
  */
2086
1739
  declare const ExternalFulfillmentShipmentsApiFp: (configuration?: Configuration) => {
2087
- /**
2088
- * Provide details about the packages in the specified shipment.
2089
- * @param {string} shipmentId The ID of the shipment.
2090
- * @param {Packages} body A list of packages in the shipment.
2091
- * @param {*} [options] Override http request option.
2092
- * @throws {RequiredError}
2093
- */
2094
- createPackages(shipmentId: string, body: Packages, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2095
- /**
2096
- * Get invoices for the shipment you specify.
2097
- * @param {string} shipmentId The ID of the shipment whose invoice you want.
2098
- * @param {*} [options] Override http request option.
2099
- * @throws {RequiredError}
2100
- */
2101
- generateInvoice(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceResponse>>;
2102
- /**
2103
- * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
2104
- * @param {string} shipmentId The ID of the shipment whose shipping labels you want to generate and retrieve.
2105
- * @param {GenerateShipLabelsOperationEnum} operation Specify whether you want to generate or regenerate a label.
2106
- * @param {string} [shippingOptionId] The ID of the shipping option whose shipping labels you want.
2107
- * @param {ShipLabelsInput} [body] Shipping details for when shipping is not done by the marketplace channel.
2108
- * @param {*} [options] Override http request option.
2109
- * @throws {RequiredError}
2110
- */
2111
- generateShipLabels(shipmentId: string, operation: GenerateShipLabelsOperationEnum, shippingOptionId?: string, body?: ShipLabelsInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipLabelsResponse>>;
2112
- /**
2113
- * Get a single shipment with the ID you specify.
2114
- * @param {string} shipmentId The ID of the shipment you want to retrieve.
2115
- * @param {*} [options] Override http request option.
2116
- * @throws {RequiredError}
2117
- */
2118
- getShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>;
2119
- /**
2120
- * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
2121
- * @param {GetShipmentsStatusEnum} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;CREATED&#x60; or &#x60;ACCEPTED&#x60;.
2122
- * @param {string} [locationId] The Amazon channel location identifier for the shipments you want to retrieve.
2123
- * @param {string} [marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
2124
- * @param {string} [channelName] The channel name associated with the location.
2125
- * @param {string} [lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
2126
- * @param {string} [lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
2127
- * @param {number} [maxResults] The maximum number of shipments to include in the response.
2128
- * @param {string} [paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
2129
- * @param {*} [options] Override http request option.
2130
- * @throws {RequiredError}
2131
- */
2132
- getShipments(status: GetShipmentsStatusEnum, locationId?: string, marketplaceId?: string, channelName?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentsResponse>>;
2133
- /**
2134
- * Confirm or reject the specified shipment.
2135
- * @param {string} shipmentId The ID of the shipment you want to confirm or reject.
2136
- * @param {ProcessShipmentOperationEnum} operation The status of the shipment.
2137
- * @param {ShipmentAcknowledgementRequest} [body] Information about the shipment and its line items.
2138
- * @param {*} [options] Override http request option.
2139
- * @throws {RequiredError}
2140
- */
2141
- processShipment(shipmentId: string, operation: ProcessShipmentOperationEnum, body?: ShipmentAcknowledgementRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2142
- /**
2143
- * Retrieve invoices for the shipment you specify.
2144
- * @param {string} shipmentId The ID of the shipment whose invoice you want to retrieve.
2145
- * @param {*} [options] Override http request option.
2146
- * @throws {RequiredError}
2147
- */
2148
- retrieveInvoice(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceResponse>>;
2149
- /**
2150
- * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
2151
- * @param {string} shipmentId The ID of the shipment to which the package belongs.
2152
- * @param {string} packageId The ID of the package for which you want to retrieve shipping options.
2153
- * @param {*} [options] Override http request option.
2154
- * @throws {RequiredError}
2155
- */
2156
- retrieveShippingOptions(shipmentId: string, packageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShippingOptionsResponse>>;
2157
- /**
2158
- * Updates the details about the packages that will be used to fulfill the specified shipment.
2159
- * @param {string} shipmentId The ID of the shipment to which the package belongs.
2160
- * @param {string} packageId The ID of the package whose information you want to update.
2161
- * @param {Package} body The body of the request.
2162
- * @param {*} [options] Override http request option.
2163
- * @throws {RequiredError}
2164
- */
2165
- updatePackage(shipmentId: string, packageId: string, body: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2166
- /**
2167
- * Updates the status of the packages.
2168
- * @param {string} shipmentId The ID of the shipment to which the package belongs.
2169
- * @param {string} packageId The ID of the package whose status you want to update.
2170
- * @param {UpdatePackageStatusStatusEnum} [status] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
2171
- * @param {PackageDeliveryStatus} [body] The body of the request.
2172
- * @param {*} [options] Override http request option.
2173
- * @throws {RequiredError}
2174
- */
2175
- updatePackageStatus(shipmentId: string, packageId: string, status?: UpdatePackageStatusStatusEnum, body?: PackageDeliveryStatus, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1740
+ /**
1741
+ * Provide details about the packages in the specified shipment.
1742
+ * @param {string} shipmentId The ID of the shipment.
1743
+ * @param {Packages} body A list of packages in the shipment.
1744
+ * @param {*} [options] Override http request option.
1745
+ * @throws {RequiredError}
1746
+ */
1747
+ createPackages(shipmentId: string, body: Packages, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1748
+ /**
1749
+ * Get invoices for the shipment you specify.
1750
+ * @param {string} shipmentId The ID of the shipment whose invoice you want.
1751
+ * @param {*} [options] Override http request option.
1752
+ * @throws {RequiredError}
1753
+ */
1754
+ generateInvoice(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceResponse>>;
1755
+ /**
1756
+ * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
1757
+ * @param {string} shipmentId The ID of the shipment whose shipping labels you want to generate and retrieve.
1758
+ * @param {GenerateShipLabelsOperationEnum} operation Specify whether you want to generate or regenerate a label.
1759
+ * @param {string} [shippingOptionId] The ID of the shipping option whose shipping labels you want.
1760
+ * @param {ShipLabelsInput} [body] Shipping details for when shipping is not done by the marketplace channel.
1761
+ * @param {*} [options] Override http request option.
1762
+ * @throws {RequiredError}
1763
+ */
1764
+ generateShipLabels(shipmentId: string, operation: GenerateShipLabelsOperationEnum, shippingOptionId?: string, body?: ShipLabelsInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipLabelsResponse>>;
1765
+ /**
1766
+ * Get a single shipment with the ID you specify.
1767
+ * @param {string} shipmentId The ID of the shipment you want to retrieve.
1768
+ * @param {*} [options] Override http request option.
1769
+ * @throws {RequiredError}
1770
+ */
1771
+ getShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>;
1772
+ /**
1773
+ * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
1774
+ * @param {GetShipmentsStatusEnum} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;CREATED&#x60; or &#x60;ACCEPTED&#x60;.
1775
+ * @param {string} [locationId] The Amazon channel location identifier for the shipments you want to retrieve.
1776
+ * @param {string} [marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1777
+ * @param {string} [channelName] The channel name associated with the location.
1778
+ * @param {string} [lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1779
+ * @param {string} [lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1780
+ * @param {number} [maxResults] The maximum number of shipments to include in the response.
1781
+ * @param {string} [paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1782
+ * @param {*} [options] Override http request option.
1783
+ * @throws {RequiredError}
1784
+ */
1785
+ getShipments(status: GetShipmentsStatusEnum, locationId?: string, marketplaceId?: string, channelName?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentsResponse>>;
1786
+ /**
1787
+ * Confirm or reject the specified shipment.
1788
+ * @param {string} shipmentId The ID of the shipment you want to confirm or reject.
1789
+ * @param {ProcessShipmentOperationEnum} operation The status of the shipment.
1790
+ * @param {ShipmentAcknowledgementRequest} [body] Information about the shipment and its line items.
1791
+ * @param {*} [options] Override http request option.
1792
+ * @throws {RequiredError}
1793
+ */
1794
+ processShipment(shipmentId: string, operation: ProcessShipmentOperationEnum, body?: ShipmentAcknowledgementRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1795
+ /**
1796
+ * Retrieve invoices for the shipment you specify.
1797
+ * @param {string} shipmentId The ID of the shipment whose invoice you want to retrieve.
1798
+ * @param {*} [options] Override http request option.
1799
+ * @throws {RequiredError}
1800
+ */
1801
+ retrieveInvoice(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceResponse>>;
1802
+ /**
1803
+ * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
1804
+ * @param {string} shipmentId The ID of the shipment to which the package belongs.
1805
+ * @param {string} packageId The ID of the package for which you want to retrieve shipping options.
1806
+ * @param {*} [options] Override http request option.
1807
+ * @throws {RequiredError}
1808
+ */
1809
+ retrieveShippingOptions(shipmentId: string, packageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShippingOptionsResponse>>;
1810
+ /**
1811
+ * Updates the details about the packages that will be used to fulfill the specified shipment.
1812
+ * @param {string} shipmentId The ID of the shipment to which the package belongs.
1813
+ * @param {string} packageId The ID of the package whose information you want to update.
1814
+ * @param {Package} body The body of the request.
1815
+ * @param {*} [options] Override http request option.
1816
+ * @throws {RequiredError}
1817
+ */
1818
+ updatePackage(shipmentId: string, packageId: string, body: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1819
+ /**
1820
+ * Updates the status of the packages.
1821
+ * @param {string} shipmentId The ID of the shipment to which the package belongs.
1822
+ * @param {string} packageId The ID of the package whose status you want to update.
1823
+ * @param {UpdatePackageStatusStatusEnum} [status] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
1824
+ * @param {PackageDeliveryStatus} [body] The body of the request.
1825
+ * @param {*} [options] Override http request option.
1826
+ * @throws {RequiredError}
1827
+ */
1828
+ updatePackageStatus(shipmentId: string, packageId: string, status?: UpdatePackageStatusStatusEnum, body?: PackageDeliveryStatus, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2176
1829
  };
2177
1830
  /**
2178
1831
  * ExternalFulfillmentShipmentsApi - factory interface
2179
1832
  */
2180
1833
  declare const ExternalFulfillmentShipmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2181
- /**
2182
- * Provide details about the packages in the specified shipment.
2183
- * @param {ExternalFulfillmentShipmentsApiCreatePackagesRequest} requestParameters Request parameters.
2184
- * @param {*} [options] Override http request option.
2185
- * @throws {RequiredError}
2186
- */
2187
- createPackages(requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2188
- /**
2189
- * Get invoices for the shipment you specify.
2190
- * @param {ExternalFulfillmentShipmentsApiGenerateInvoiceRequest} requestParameters Request parameters.
2191
- * @param {*} [options] Override http request option.
2192
- * @throws {RequiredError}
2193
- */
2194
- generateInvoice(requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<InvoiceResponse>;
2195
- /**
2196
- * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
2197
- * @param {ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest} requestParameters Request parameters.
2198
- * @param {*} [options] Override http request option.
2199
- * @throws {RequiredError}
2200
- */
2201
- generateShipLabels(requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipLabelsResponse>;
2202
- /**
2203
- * Get a single shipment with the ID you specify.
2204
- * @param {ExternalFulfillmentShipmentsApiGetShipmentRequest} requestParameters Request parameters.
2205
- * @param {*} [options] Override http request option.
2206
- * @throws {RequiredError}
2207
- */
2208
- getShipment(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Shipment>;
2209
- /**
2210
- * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
2211
- * @param {ExternalFulfillmentShipmentsApiGetShipmentsRequest} requestParameters Request parameters.
2212
- * @param {*} [options] Override http request option.
2213
- * @throws {RequiredError}
2214
- */
2215
- getShipments(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentsResponse>;
2216
- /**
2217
- * Confirm or reject the specified shipment.
2218
- * @param {ExternalFulfillmentShipmentsApiProcessShipmentRequest} requestParameters Request parameters.
2219
- * @param {*} [options] Override http request option.
2220
- * @throws {RequiredError}
2221
- */
2222
- processShipment(requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2223
- /**
2224
- * Retrieve invoices for the shipment you specify.
2225
- * @param {ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest} requestParameters Request parameters.
2226
- * @param {*} [options] Override http request option.
2227
- * @throws {RequiredError}
2228
- */
2229
- retrieveInvoice(requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<InvoiceResponse>;
2230
- /**
2231
- * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
2232
- * @param {ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest} requestParameters Request parameters.
2233
- * @param {*} [options] Override http request option.
2234
- * @throws {RequiredError}
2235
- */
2236
- retrieveShippingOptions(requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShippingOptionsResponse>;
2237
- /**
2238
- * Updates the details about the packages that will be used to fulfill the specified shipment.
2239
- * @param {ExternalFulfillmentShipmentsApiUpdatePackageRequest} requestParameters Request parameters.
2240
- * @param {*} [options] Override http request option.
2241
- * @throws {RequiredError}
2242
- */
2243
- updatePackage(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2244
- /**
2245
- * Updates the status of the packages.
2246
- * @param {ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest} requestParameters Request parameters.
2247
- * @param {*} [options] Override http request option.
2248
- * @throws {RequiredError}
2249
- */
2250
- updatePackageStatus(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1834
+ /**
1835
+ * Provide details about the packages in the specified shipment.
1836
+ * @param {ExternalFulfillmentShipmentsApiCreatePackagesRequest} requestParameters Request parameters.
1837
+ * @param {*} [options] Override http request option.
1838
+ * @throws {RequiredError}
1839
+ */
1840
+ createPackages(requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1841
+ /**
1842
+ * Get invoices for the shipment you specify.
1843
+ * @param {ExternalFulfillmentShipmentsApiGenerateInvoiceRequest} requestParameters Request parameters.
1844
+ * @param {*} [options] Override http request option.
1845
+ * @throws {RequiredError}
1846
+ */
1847
+ generateInvoice(requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<InvoiceResponse>;
1848
+ /**
1849
+ * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
1850
+ * @param {ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest} requestParameters Request parameters.
1851
+ * @param {*} [options] Override http request option.
1852
+ * @throws {RequiredError}
1853
+ */
1854
+ generateShipLabels(requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipLabelsResponse>;
1855
+ /**
1856
+ * Get a single shipment with the ID you specify.
1857
+ * @param {ExternalFulfillmentShipmentsApiGetShipmentRequest} requestParameters Request parameters.
1858
+ * @param {*} [options] Override http request option.
1859
+ * @throws {RequiredError}
1860
+ */
1861
+ getShipment(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Shipment>;
1862
+ /**
1863
+ * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
1864
+ * @param {ExternalFulfillmentShipmentsApiGetShipmentsRequest} requestParameters Request parameters.
1865
+ * @param {*} [options] Override http request option.
1866
+ * @throws {RequiredError}
1867
+ */
1868
+ getShipments(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentsResponse>;
1869
+ /**
1870
+ * Confirm or reject the specified shipment.
1871
+ * @param {ExternalFulfillmentShipmentsApiProcessShipmentRequest} requestParameters Request parameters.
1872
+ * @param {*} [options] Override http request option.
1873
+ * @throws {RequiredError}
1874
+ */
1875
+ processShipment(requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1876
+ /**
1877
+ * Retrieve invoices for the shipment you specify.
1878
+ * @param {ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest} requestParameters Request parameters.
1879
+ * @param {*} [options] Override http request option.
1880
+ * @throws {RequiredError}
1881
+ */
1882
+ retrieveInvoice(requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<InvoiceResponse>;
1883
+ /**
1884
+ * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
1885
+ * @param {ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest} requestParameters Request parameters.
1886
+ * @param {*} [options] Override http request option.
1887
+ * @throws {RequiredError}
1888
+ */
1889
+ retrieveShippingOptions(requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShippingOptionsResponse>;
1890
+ /**
1891
+ * Updates the details about the packages that will be used to fulfill the specified shipment.
1892
+ * @param {ExternalFulfillmentShipmentsApiUpdatePackageRequest} requestParameters Request parameters.
1893
+ * @param {*} [options] Override http request option.
1894
+ * @throws {RequiredError}
1895
+ */
1896
+ updatePackage(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1897
+ /**
1898
+ * Updates the status of the packages.
1899
+ * @param {ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest} requestParameters Request parameters.
1900
+ * @param {*} [options] Override http request option.
1901
+ * @throws {RequiredError}
1902
+ */
1903
+ updatePackageStatus(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2251
1904
  };
2252
1905
  /**
2253
1906
  * Request parameters for createPackages operation in ExternalFulfillmentShipmentsApi.
2254
1907
  */
2255
1908
  interface ExternalFulfillmentShipmentsApiCreatePackagesRequest {
2256
- /**
2257
- * The ID of the shipment.
2258
- */
2259
- readonly shipmentId: string;
2260
- /**
2261
- * A list of packages in the shipment.
2262
- */
2263
- readonly body: Packages;
1909
+ /**
1910
+ * The ID of the shipment.
1911
+ */
1912
+ readonly shipmentId: string;
1913
+ /**
1914
+ * A list of packages in the shipment.
1915
+ */
1916
+ readonly body: Packages;
2264
1917
  }
2265
1918
  /**
2266
1919
  * Request parameters for generateInvoice operation in ExternalFulfillmentShipmentsApi.
2267
1920
  */
2268
1921
  interface ExternalFulfillmentShipmentsApiGenerateInvoiceRequest {
2269
- /**
2270
- * The ID of the shipment whose invoice you want.
2271
- */
2272
- readonly shipmentId: string;
1922
+ /**
1923
+ * The ID of the shipment whose invoice you want.
1924
+ */
1925
+ readonly shipmentId: string;
2273
1926
  }
2274
1927
  /**
2275
1928
  * Request parameters for generateShipLabels operation in ExternalFulfillmentShipmentsApi.
2276
1929
  */
2277
1930
  interface ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest {
2278
- /**
2279
- * The ID of the shipment whose shipping labels you want to generate and retrieve.
2280
- */
2281
- readonly shipmentId: string;
2282
- /**
2283
- * Specify whether you want to generate or regenerate a label.
2284
- */
2285
- readonly operation: GenerateShipLabelsOperationEnum;
2286
- /**
2287
- * The ID of the shipping option whose shipping labels you want.
2288
- */
2289
- readonly shippingOptionId?: string;
2290
- /**
2291
- * Shipping details for when shipping is not done by the marketplace channel.
2292
- */
2293
- readonly body?: ShipLabelsInput;
1931
+ /**
1932
+ * The ID of the shipment whose shipping labels you want to generate and retrieve.
1933
+ */
1934
+ readonly shipmentId: string;
1935
+ /**
1936
+ * Specify whether you want to generate or regenerate a label.
1937
+ */
1938
+ readonly operation: GenerateShipLabelsOperationEnum;
1939
+ /**
1940
+ * The ID of the shipping option whose shipping labels you want.
1941
+ */
1942
+ readonly shippingOptionId?: string;
1943
+ /**
1944
+ * Shipping details for when shipping is not done by the marketplace channel.
1945
+ */
1946
+ readonly body?: ShipLabelsInput;
2294
1947
  }
2295
1948
  /**
2296
1949
  * Request parameters for getShipment operation in ExternalFulfillmentShipmentsApi.
2297
1950
  */
2298
1951
  interface ExternalFulfillmentShipmentsApiGetShipmentRequest {
2299
- /**
2300
- * The ID of the shipment you want to retrieve.
2301
- */
2302
- readonly shipmentId: string;
1952
+ /**
1953
+ * The ID of the shipment you want to retrieve.
1954
+ */
1955
+ readonly shipmentId: string;
2303
1956
  }
2304
1957
  /**
2305
1958
  * Request parameters for getShipments operation in ExternalFulfillmentShipmentsApi.
2306
1959
  */
2307
1960
  interface ExternalFulfillmentShipmentsApiGetShipmentsRequest {
2308
- /**
2309
- * The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;CREATED&#x60; or &#x60;ACCEPTED&#x60;.
2310
- */
2311
- readonly status: GetShipmentsStatusEnum;
2312
- /**
2313
- * The Amazon channel location identifier for the shipments you want to retrieve.
2314
- */
2315
- readonly locationId?: string;
2316
- /**
2317
- * The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
2318
- */
2319
- readonly marketplaceId?: string;
2320
- /**
2321
- * The channel name associated with the location.
2322
- */
2323
- readonly channelName?: string;
2324
- /**
2325
- * The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
2326
- */
2327
- readonly lastUpdatedAfter?: string;
2328
- /**
2329
- * The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
2330
- */
2331
- readonly lastUpdatedBefore?: string;
2332
- /**
2333
- * The maximum number of shipments to include in the response.
2334
- */
2335
- readonly maxResults?: number;
2336
- /**
2337
- * A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
2338
- */
2339
- readonly paginationToken?: string;
1961
+ /**
1962
+ * The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;CREATED&#x60; or &#x60;ACCEPTED&#x60;.
1963
+ */
1964
+ readonly status: GetShipmentsStatusEnum;
1965
+ /**
1966
+ * The Amazon channel location identifier for the shipments you want to retrieve.
1967
+ */
1968
+ readonly locationId?: string;
1969
+ /**
1970
+ * The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1971
+ */
1972
+ readonly marketplaceId?: string;
1973
+ /**
1974
+ * The channel name associated with the location.
1975
+ */
1976
+ readonly channelName?: string;
1977
+ /**
1978
+ * The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1979
+ */
1980
+ readonly lastUpdatedAfter?: string;
1981
+ /**
1982
+ * The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
1983
+ */
1984
+ readonly lastUpdatedBefore?: string;
1985
+ /**
1986
+ * The maximum number of shipments to include in the response.
1987
+ */
1988
+ readonly maxResults?: number;
1989
+ /**
1990
+ * A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
1991
+ */
1992
+ readonly paginationToken?: string;
2340
1993
  }
2341
1994
  /**
2342
1995
  * Request parameters for processShipment operation in ExternalFulfillmentShipmentsApi.
2343
1996
  */
2344
1997
  interface ExternalFulfillmentShipmentsApiProcessShipmentRequest {
2345
- /**
2346
- * The ID of the shipment you want to confirm or reject.
2347
- */
2348
- readonly shipmentId: string;
2349
- /**
2350
- * The status of the shipment.
2351
- */
2352
- readonly operation: ProcessShipmentOperationEnum;
2353
- /**
2354
- * Information about the shipment and its line items.
2355
- */
2356
- readonly body?: ShipmentAcknowledgementRequest;
1998
+ /**
1999
+ * The ID of the shipment you want to confirm or reject.
2000
+ */
2001
+ readonly shipmentId: string;
2002
+ /**
2003
+ * The status of the shipment.
2004
+ */
2005
+ readonly operation: ProcessShipmentOperationEnum;
2006
+ /**
2007
+ * Information about the shipment and its line items.
2008
+ */
2009
+ readonly body?: ShipmentAcknowledgementRequest;
2357
2010
  }
2358
2011
  /**
2359
2012
  * Request parameters for retrieveInvoice operation in ExternalFulfillmentShipmentsApi.
2360
2013
  */
2361
2014
  interface ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest {
2362
- /**
2363
- * The ID of the shipment whose invoice you want to retrieve.
2364
- */
2365
- readonly shipmentId: string;
2015
+ /**
2016
+ * The ID of the shipment whose invoice you want to retrieve.
2017
+ */
2018
+ readonly shipmentId: string;
2366
2019
  }
2367
2020
  /**
2368
2021
  * Request parameters for retrieveShippingOptions operation in ExternalFulfillmentShipmentsApi.
2369
2022
  */
2370
2023
  interface ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest {
2371
- /**
2372
- * The ID of the shipment to which the package belongs.
2373
- */
2374
- readonly shipmentId: string;
2375
- /**
2376
- * The ID of the package for which you want to retrieve shipping options.
2377
- */
2378
- readonly packageId: string;
2024
+ /**
2025
+ * The ID of the shipment to which the package belongs.
2026
+ */
2027
+ readonly shipmentId: string;
2028
+ /**
2029
+ * The ID of the package for which you want to retrieve shipping options.
2030
+ */
2031
+ readonly packageId: string;
2379
2032
  }
2380
2033
  /**
2381
2034
  * Request parameters for updatePackage operation in ExternalFulfillmentShipmentsApi.
2382
2035
  */
2383
2036
  interface ExternalFulfillmentShipmentsApiUpdatePackageRequest {
2384
- /**
2385
- * The ID of the shipment to which the package belongs.
2386
- */
2387
- readonly shipmentId: string;
2388
- /**
2389
- * The ID of the package whose information you want to update.
2390
- */
2391
- readonly packageId: string;
2392
- /**
2393
- * The body of the request.
2394
- */
2395
- readonly body: Package;
2037
+ /**
2038
+ * The ID of the shipment to which the package belongs.
2039
+ */
2040
+ readonly shipmentId: string;
2041
+ /**
2042
+ * The ID of the package whose information you want to update.
2043
+ */
2044
+ readonly packageId: string;
2045
+ /**
2046
+ * The body of the request.
2047
+ */
2048
+ readonly body: Package;
2396
2049
  }
2397
2050
  /**
2398
2051
  * Request parameters for updatePackageStatus operation in ExternalFulfillmentShipmentsApi.
2399
2052
  */
2400
2053
  interface ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest {
2401
- /**
2402
- * The ID of the shipment to which the package belongs.
2403
- */
2404
- readonly shipmentId: string;
2405
- /**
2406
- * The ID of the package whose status you want to update.
2407
- */
2408
- readonly packageId: string;
2409
- /**
2410
- * **DEPRECATED**. Do not use. Package status is defined in the body parameter.
2411
- */
2412
- readonly status?: UpdatePackageStatusStatusEnum;
2413
- /**
2414
- * The body of the request.
2415
- */
2416
- readonly body?: PackageDeliveryStatus;
2054
+ /**
2055
+ * The ID of the shipment to which the package belongs.
2056
+ */
2057
+ readonly shipmentId: string;
2058
+ /**
2059
+ * The ID of the package whose status you want to update.
2060
+ */
2061
+ readonly packageId: string;
2062
+ /**
2063
+ * **DEPRECATED**. Do not use. Package status is defined in the body parameter.
2064
+ */
2065
+ readonly status?: UpdatePackageStatusStatusEnum;
2066
+ /**
2067
+ * The body of the request.
2068
+ */
2069
+ readonly body?: PackageDeliveryStatus;
2417
2070
  }
2418
2071
  /**
2419
2072
  * ExternalFulfillmentShipmentsApi - object-oriented interface
2420
2073
  */
2421
2074
  declare class ExternalFulfillmentShipmentsApi extends BaseAPI {
2422
- /**
2423
- * Provide details about the packages in the specified shipment.
2424
- * @param {ExternalFulfillmentShipmentsApiCreatePackagesRequest} requestParameters Request parameters.
2425
- * @param {*} [options] Override http request option.
2426
- * @throws {RequiredError}
2427
- */
2428
- createPackages(requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
2429
- /**
2430
- * Get invoices for the shipment you specify.
2431
- * @param {ExternalFulfillmentShipmentsApiGenerateInvoiceRequest} requestParameters Request parameters.
2432
- * @param {*} [options] Override http request option.
2433
- * @throws {RequiredError}
2434
- */
2435
- generateInvoice(requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<InvoiceResponse, any, {}>>;
2436
- /**
2437
- * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
2438
- * @param {ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest} requestParameters Request parameters.
2439
- * @param {*} [options] Override http request option.
2440
- * @throws {RequiredError}
2441
- */
2442
- generateShipLabels(requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShipLabelsResponse, any, {}>>;
2443
- /**
2444
- * Get a single shipment with the ID you specify.
2445
- * @param {ExternalFulfillmentShipmentsApiGetShipmentRequest} requestParameters Request parameters.
2446
- * @param {*} [options] Override http request option.
2447
- * @throws {RequiredError}
2448
- */
2449
- getShipment(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Shipment, any, {}>>;
2450
- /**
2451
- * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
2452
- * @param {ExternalFulfillmentShipmentsApiGetShipmentsRequest} requestParameters Request parameters.
2453
- * @param {*} [options] Override http request option.
2454
- * @throws {RequiredError}
2455
- */
2456
- getShipments(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShipmentsResponse, any, {}>>;
2457
- /**
2458
- * Confirm or reject the specified shipment.
2459
- * @param {ExternalFulfillmentShipmentsApiProcessShipmentRequest} requestParameters Request parameters.
2460
- * @param {*} [options] Override http request option.
2461
- * @throws {RequiredError}
2462
- */
2463
- processShipment(requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
2464
- /**
2465
- * Retrieve invoices for the shipment you specify.
2466
- * @param {ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest} requestParameters Request parameters.
2467
- * @param {*} [options] Override http request option.
2468
- * @throws {RequiredError}
2469
- */
2470
- retrieveInvoice(requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<InvoiceResponse, any, {}>>;
2471
- /**
2472
- * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
2473
- * @param {ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest} requestParameters Request parameters.
2474
- * @param {*} [options] Override http request option.
2475
- * @throws {RequiredError}
2476
- */
2477
- retrieveShippingOptions(requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ShippingOptionsResponse, any, {}>>;
2478
- /**
2479
- * Updates the details about the packages that will be used to fulfill the specified shipment.
2480
- * @param {ExternalFulfillmentShipmentsApiUpdatePackageRequest} requestParameters Request parameters.
2481
- * @param {*} [options] Override http request option.
2482
- * @throws {RequiredError}
2483
- */
2484
- updatePackage(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
2485
- /**
2486
- * Updates the status of the packages.
2487
- * @param {ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest} requestParameters Request parameters.
2488
- * @param {*} [options] Override http request option.
2489
- * @throws {RequiredError}
2490
- */
2491
- updatePackageStatus(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
2075
+ /**
2076
+ * Provide details about the packages in the specified shipment.
2077
+ * @param {ExternalFulfillmentShipmentsApiCreatePackagesRequest} requestParameters Request parameters.
2078
+ * @param {*} [options] Override http request option.
2079
+ * @throws {RequiredError}
2080
+ */
2081
+ createPackages(requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2082
+ /**
2083
+ * Get invoices for the shipment you specify.
2084
+ * @param {ExternalFulfillmentShipmentsApiGenerateInvoiceRequest} requestParameters Request parameters.
2085
+ * @param {*} [options] Override http request option.
2086
+ * @throws {RequiredError}
2087
+ */
2088
+ generateInvoice(requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
2089
+ /**
2090
+ * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
2091
+ * @param {ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest} requestParameters Request parameters.
2092
+ * @param {*} [options] Override http request option.
2093
+ * @throws {RequiredError}
2094
+ */
2095
+ generateShipLabels(requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipLabelsResponse, any, {}>>;
2096
+ /**
2097
+ * Get a single shipment with the ID you specify.
2098
+ * @param {ExternalFulfillmentShipmentsApiGetShipmentRequest} requestParameters Request parameters.
2099
+ * @param {*} [options] Override http request option.
2100
+ * @throws {RequiredError}
2101
+ */
2102
+ getShipment(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Shipment, any, {}>>;
2103
+ /**
2104
+ * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
2105
+ * @param {ExternalFulfillmentShipmentsApiGetShipmentsRequest} requestParameters Request parameters.
2106
+ * @param {*} [options] Override http request option.
2107
+ * @throws {RequiredError}
2108
+ */
2109
+ getShipments(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentsResponse, any, {}>>;
2110
+ /**
2111
+ * Confirm or reject the specified shipment.
2112
+ * @param {ExternalFulfillmentShipmentsApiProcessShipmentRequest} requestParameters Request parameters.
2113
+ * @param {*} [options] Override http request option.
2114
+ * @throws {RequiredError}
2115
+ */
2116
+ processShipment(requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2117
+ /**
2118
+ * Retrieve invoices for the shipment you specify.
2119
+ * @param {ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest} requestParameters Request parameters.
2120
+ * @param {*} [options] Override http request option.
2121
+ * @throws {RequiredError}
2122
+ */
2123
+ retrieveInvoice(requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceResponse, any, {}>>;
2124
+ /**
2125
+ * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
2126
+ * @param {ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest} requestParameters Request parameters.
2127
+ * @param {*} [options] Override http request option.
2128
+ * @throws {RequiredError}
2129
+ */
2130
+ retrieveShippingOptions(requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShippingOptionsResponse, any, {}>>;
2131
+ /**
2132
+ * Updates the details about the packages that will be used to fulfill the specified shipment.
2133
+ * @param {ExternalFulfillmentShipmentsApiUpdatePackageRequest} requestParameters Request parameters.
2134
+ * @param {*} [options] Override http request option.
2135
+ * @throws {RequiredError}
2136
+ */
2137
+ updatePackage(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2138
+ /**
2139
+ * Updates the status of the packages.
2140
+ * @param {ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest} requestParameters Request parameters.
2141
+ * @param {*} [options] Override http request option.
2142
+ * @throws {RequiredError}
2143
+ */
2144
+ updatePackageStatus(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2492
2145
  }
2493
2146
  declare const GenerateShipLabelsOperationEnum: {
2494
- readonly Generate: "GENERATE";
2495
- readonly Regenerate: "REGENERATE";
2147
+ readonly Generate: "GENERATE";
2148
+ readonly Regenerate: "REGENERATE";
2496
2149
  };
2497
2150
  type GenerateShipLabelsOperationEnum = typeof GenerateShipLabelsOperationEnum[keyof typeof GenerateShipLabelsOperationEnum];
2498
2151
  declare const GetShipmentsStatusEnum: {
2499
- readonly Created: "CREATED";
2500
- readonly Accepted: "ACCEPTED";
2501
- readonly Confirmed: "CONFIRMED";
2502
- readonly PackageCreated: "PACKAGE_CREATED";
2503
- readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
2504
- readonly InvoiceGenerated: "INVOICE_GENERATED";
2505
- readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
2506
- readonly Cancelled: "CANCELLED";
2507
- readonly Shipped: "SHIPPED";
2508
- readonly Delivered: "DELIVERED";
2152
+ readonly Created: "CREATED";
2153
+ readonly Accepted: "ACCEPTED";
2154
+ readonly Confirmed: "CONFIRMED";
2155
+ readonly PackageCreated: "PACKAGE_CREATED";
2156
+ readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
2157
+ readonly InvoiceGenerated: "INVOICE_GENERATED";
2158
+ readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
2159
+ readonly Cancelled: "CANCELLED";
2160
+ readonly Shipped: "SHIPPED";
2161
+ readonly Delivered: "DELIVERED";
2509
2162
  };
2510
2163
  type GetShipmentsStatusEnum = typeof GetShipmentsStatusEnum[keyof typeof GetShipmentsStatusEnum];
2511
2164
  declare const ProcessShipmentOperationEnum: {
2512
- readonly Confirm: "CONFIRM";
2513
- readonly Reject: "REJECT";
2165
+ readonly Confirm: "CONFIRM";
2166
+ readonly Reject: "REJECT";
2514
2167
  };
2515
2168
  type ProcessShipmentOperationEnum = typeof ProcessShipmentOperationEnum[keyof typeof ProcessShipmentOperationEnum];
2516
2169
  declare const UpdatePackageStatusStatusEnum: {
2517
- readonly Shipped: "SHIPPED";
2170
+ readonly Shipped: "SHIPPED";
2518
2171
  };
2519
2172
  type UpdatePackageStatusStatusEnum = typeof UpdatePackageStatusStatusEnum[keyof typeof UpdatePackageStatusStatusEnum];
2520
-
2173
+ //#endregion
2174
+ //#region src/client.d.ts
2521
2175
  declare const clientRateLimits: RateLimit[];
2522
2176
  declare class ExternalFulfillmentShipmentsApiClient extends ExternalFulfillmentShipmentsApi {
2523
- constructor(configuration: ClientConfiguration);
2177
+ constructor(configuration: ClientConfiguration);
2524
2178
  }
2525
-
2526
- export { type Address, type Amount, type Cancellation, CancellationCancellationTypeEnum, type Charge, type ChargeBreakup, ChargeChargeTypeEnum, type ComplianceAttributes, type CourierSupportedAttributes, type CustomAttribute, CustomAttributeType, type Dimension, DimensionDimensionUnitEnum, type Distance, DistanceDistanceUnitEnum, type Document, DocumentFormatEnum, type DocumentV2, type ErrorList, ExternalFulfillmentShipmentsApi, ExternalFulfillmentShipmentsApiAxiosParamCreator, ExternalFulfillmentShipmentsApiClient, type ExternalFulfillmentShipmentsApiCreatePackagesRequest, ExternalFulfillmentShipmentsApiFactory, ExternalFulfillmentShipmentsApiFp, type ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, type ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, type ExternalFulfillmentShipmentsApiGetShipmentRequest, type ExternalFulfillmentShipmentsApiGetShipmentsRequest, type ExternalFulfillmentShipmentsApiProcessShipmentRequest, type ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, type ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, type ExternalFulfillmentShipmentsApiUpdatePackageRequest, type ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, GenerateShipLabelsOperationEnum, type Geocodes, GetShipmentsStatusEnum, type GiftAttributes, type HandoverLocation, type InvoiceInfo, type InvoiceRequirement, InvoiceRequirementRequirementEnum, InvoiceRequirementStatusEnum, type InvoiceResponse, type LineItem, type LineItemWithReason, LineItemWithReasonReasonEnum, type MarketplaceAttributes, MarketplaceAttributesCustomAttributesEnum, type ModelError, type OriginalLineItem, type Package, type PackageDeliveryStatus, type PackageDimensions, type PackageLineItem, PackagePackageHandlingRequirementsEnum, type PackageShipLabel, PackageStatus, PackageStatusEnum, PackageSubStatus, type Packages, type PackingSlipRequirement, PackingSlipRequirementRequirementEnum, PackingSlipRequirementStatusEnum, type Pagination, type PartyIdentificationInfo, PartyIdentificationInfoPartyTypeEnum, PieceType, PresenceStatus, Priority, ProcessShipmentOperationEnum, type RecommendedPackage, type RecommendedPackageLineItem, type ReplacedShipmentInfo, RequirementLevel, type ShipLabelMetadata, type ShipLabelsInput, type ShipLabelsResponse, type Shipment, type ShipmentAcknowledgementRequest, type ShipmentInfo, ShipmentInfoPaymentMethodEnum, ShipmentInfoProcessingSourceEnum, ShipmentInfoShipmentTypeEnum, type ShipmentLineItem, type ShipmentRequirements, ShipmentStatusEnum, ShipmentSubStatusEnum, type ShipmentsResponse, type ShippingInfo, ShippingInfoShippingTypeEnum, type ShippingOptions, type ShippingOptionsResponse, ShippingOptionsShipByEnum, Status, type Tax, type TaxRegistrationInfo, TaxRegistrationInfoTypeEnum, TaxTypeEnum, type TimeWindow, TimeWindowHandoverMethodEnum, UpdatePackageStatusStatusEnum, type Weight, WeightWeightUnitEnum, clientRateLimits };
2179
+ //#endregion
2180
+ export { Address, Amount, Cancellation, CancellationCancellationTypeEnum, Charge, ChargeBreakup, ChargeChargeTypeEnum, ComplianceAttributes, CourierSupportedAttributes, CustomAttribute, CustomAttributeType, Dimension, DimensionDimensionUnitEnum, Distance, DistanceDistanceUnitEnum, Document, DocumentFormatEnum, DocumentV2, ErrorList, ExternalFulfillmentShipmentsApi, ExternalFulfillmentShipmentsApiAxiosParamCreator, ExternalFulfillmentShipmentsApiClient, ExternalFulfillmentShipmentsApiCreatePackagesRequest, ExternalFulfillmentShipmentsApiFactory, ExternalFulfillmentShipmentsApiFp, ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, ExternalFulfillmentShipmentsApiGetShipmentRequest, ExternalFulfillmentShipmentsApiGetShipmentsRequest, ExternalFulfillmentShipmentsApiProcessShipmentRequest, ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, ExternalFulfillmentShipmentsApiUpdatePackageRequest, ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, GenerateShipLabelsOperationEnum, Geocodes, GetShipmentsStatusEnum, GiftAttributes, HandoverLocation, InvoiceInfo, InvoiceRequirement, InvoiceRequirementRequirementEnum, InvoiceRequirementStatusEnum, InvoiceResponse, LineItem, LineItemWithReason, LineItemWithReasonReasonEnum, MarketplaceAttributes, MarketplaceAttributesCustomAttributesEnum, ModelError, OriginalLineItem, Package, PackageDeliveryStatus, PackageDimensions, PackageLineItem, PackagePackageHandlingRequirementsEnum, PackageShipLabel, PackageStatus, PackageStatusEnum, PackageSubStatus, Packages, PackingSlipRequirement, PackingSlipRequirementRequirementEnum, PackingSlipRequirementStatusEnum, Pagination, PartyIdentificationInfo, PartyIdentificationInfoPartyTypeEnum, PieceType, PresenceStatus, Priority, ProcessShipmentOperationEnum, RecommendedPackage, RecommendedPackageLineItem, ReplacedShipmentInfo, RequirementLevel, ShipLabelMetadata, ShipLabelsInput, ShipLabelsResponse, Shipment, ShipmentAcknowledgementRequest, ShipmentInfo, ShipmentInfoPaymentMethodEnum, ShipmentInfoProcessingSourceEnum, ShipmentInfoShipmentTypeEnum, ShipmentLineItem, ShipmentRequirements, ShipmentStatusEnum, ShipmentSubStatusEnum, ShipmentsResponse, ShippingInfo, ShippingInfoShippingTypeEnum, ShippingOptions, ShippingOptionsResponse, ShippingOptionsShipByEnum, Status, Tax, TaxRegistrationInfo, TaxRegistrationInfoTypeEnum, TaxTypeEnum, TimeWindow, TimeWindowHandoverMethodEnum, UpdatePackageStatusStatusEnum, Weight, WeightWeightUnitEnum, clientRateLimits };
2181
+ //# sourceMappingURL=index.d.cts.map