@sp-api-sdk/external-fulfillment-returns-api-2024-09-11 2.0.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,7 +1,6 @@
1
- import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
2
- import * as axios from 'axios';
3
- import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
4
-
1
+ import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
2
+ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
3
+ //#region src/api-model/configuration.d.ts
5
4
  /**
6
5
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
7
6
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
14
13
  * Do not edit the class manually.
15
14
  */
16
15
  interface AWSv4Configuration {
17
- options?: {
18
- region?: string;
19
- service?: string;
20
- };
21
- credentials?: {
22
- accessKeyId?: string;
23
- secretAccessKey?: string;
24
- sessionToken?: string;
25
- };
16
+ options?: {
17
+ region?: string;
18
+ service?: string;
19
+ };
20
+ credentials?: {
21
+ accessKeyId?: string;
22
+ secretAccessKey?: string;
23
+ sessionToken?: string;
24
+ };
26
25
  }
27
26
  interface ConfigurationParameters {
28
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
- username?: string;
30
- password?: string;
31
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
32
- awsv4?: AWSv4Configuration;
33
- basePath?: string;
34
- serverIndex?: number;
35
- baseOptions?: any;
36
- formDataCtor?: new () => any;
27
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
+ username?: string;
29
+ password?: string;
30
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
31
+ awsv4?: AWSv4Configuration;
32
+ basePath?: string;
33
+ serverIndex?: number;
34
+ baseOptions?: any;
35
+ formDataCtor?: new () => any;
37
36
  }
38
37
  declare class Configuration {
39
- /**
40
- * parameter for apiKey security
41
- * @param name security name
42
- */
43
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
44
- /**
45
- * parameter for basic security
46
- */
47
- username?: string;
48
- /**
49
- * parameter for basic security
50
- */
51
- password?: string;
52
- /**
53
- * parameter for oauth2 security
54
- * @param name security name
55
- * @param scopes oauth2 scope
56
- */
57
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
58
- /**
59
- * parameter for aws4 signature security
60
- * @param {Object} AWS4Signature - AWS4 Signature security
61
- * @param {string} options.region - aws region
62
- * @param {string} options.service - name of the service.
63
- * @param {string} credentials.accessKeyId - aws access key id
64
- * @param {string} credentials.secretAccessKey - aws access key
65
- * @param {string} credentials.sessionToken - aws session token
66
- * @memberof Configuration
67
- */
68
- awsv4?: AWSv4Configuration;
69
- /**
70
- * override base path
71
- */
72
- basePath?: string;
73
- /**
74
- * override server index
75
- */
76
- serverIndex?: number;
77
- /**
78
- * base options for axios calls
79
- */
80
- baseOptions?: any;
81
- /**
82
- * The FormData constructor that will be used to create multipart form data
83
- * requests. You can inject this here so that execution environments that
84
- * do not support the FormData class can still run the generated client.
85
- *
86
- * @type {new () => FormData}
87
- */
88
- formDataCtor?: new () => any;
89
- constructor(param?: ConfigurationParameters);
90
- /**
91
- * Check if the given MIME is a JSON MIME.
92
- * JSON MIME examples:
93
- * application/json
94
- * application/json; charset=UTF8
95
- * APPLICATION/JSON
96
- * application/vnd.company+json
97
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
98
- * @return True if the given MIME is JSON, false otherwise.
99
- */
100
- isJsonMime(mime: string): boolean;
38
+ /**
39
+ * parameter for apiKey security
40
+ * @param name security name
41
+ */
42
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
43
+ /**
44
+ * parameter for basic security
45
+ */
46
+ username?: string;
47
+ /**
48
+ * parameter for basic security
49
+ */
50
+ password?: string;
51
+ /**
52
+ * parameter for oauth2 security
53
+ * @param name security name
54
+ * @param scopes oauth2 scope
55
+ */
56
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
57
+ /**
58
+ * parameter for aws4 signature security
59
+ * @param {Object} AWS4Signature - AWS4 Signature security
60
+ * @param {string} options.region - aws region
61
+ * @param {string} options.service - name of the service.
62
+ * @param {string} credentials.accessKeyId - aws access key id
63
+ * @param {string} credentials.secretAccessKey - aws access key
64
+ * @param {string} credentials.sessionToken - aws session token
65
+ * @memberof Configuration
66
+ */
67
+ awsv4?: AWSv4Configuration;
68
+ /**
69
+ * override base path
70
+ */
71
+ basePath?: string;
72
+ /**
73
+ * override server index
74
+ */
75
+ serverIndex?: number;
76
+ /**
77
+ * base options for axios calls
78
+ */
79
+ baseOptions?: any;
80
+ /**
81
+ * The FormData constructor that will be used to create multipart form data
82
+ * requests. You can inject this here so that execution environments that
83
+ * do not support the FormData class can still run the generated client.
84
+ *
85
+ * @type {new () => FormData}
86
+ */
87
+ formDataCtor?: new () => any;
88
+ constructor(param?: ConfigurationParameters);
89
+ /**
90
+ * Check if the given MIME is a JSON MIME.
91
+ * JSON MIME examples:
92
+ * application/json
93
+ * application/json; charset=UTF8
94
+ * APPLICATION/JSON
95
+ * application/vnd.company+json
96
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
97
+ * @return True if the given MIME is JSON, false otherwise.
98
+ */
99
+ isJsonMime(mime: string): boolean;
101
100
  }
102
-
103
- /**
104
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
105
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
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
-
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/error-list.d.ts
126
115
  /**
127
116
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
128
117
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -138,12 +127,13 @@ declare class BaseAPI {
138
127
  * An object containing a list of error responses returned when a request is unsuccessful.
139
128
  */
140
129
  interface ErrorList {
141
- /**
142
- * A list of error responses returned when a request is unsuccessful.
143
- */
144
- 'errors': Array<Error>;
130
+ /**
131
+ * A list of error responses returned when a request is unsuccessful.
132
+ */
133
+ 'errors': Array<Error>;
145
134
  }
146
-
135
+ //#endregion
136
+ //#region src/api-model/models/invoice-information.d.ts
147
137
  /**
148
138
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
149
139
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -159,12 +149,13 @@ interface ErrorList {
159
149
  * Invoice-related information for the return created for Amazon SmartConnect.
160
150
  */
161
151
  interface InvoiceInformation {
162
- /**
163
- * The unique ID of the invoice that corresponds to the return.
164
- */
165
- 'id': string;
152
+ /**
153
+ * The unique ID of the invoice that corresponds to the return.
154
+ */
155
+ 'id': string;
166
156
  }
167
-
157
+ //#endregion
158
+ //#region src/api-model/models/marketplace-channel.d.ts
168
159
  /**
169
160
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
170
161
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -180,59 +171,49 @@ interface InvoiceInformation {
180
171
  * The marketplace and channel name.
181
172
  */
182
173
  interface MarketplaceChannel {
183
- /**
184
- * The name of the marketplace.
185
- */
186
- 'marketplaceName'?: string;
187
- /**
188
- * The name of the channel within the marketplace.
189
- */
190
- 'channelName'?: string;
174
+ /**
175
+ * The name of the marketplace.
176
+ */
177
+ 'marketplaceName'?: string;
178
+ /**
179
+ * The name of the channel within the marketplace.
180
+ */
181
+ 'channelName'?: string;
191
182
  }
192
-
193
- /**
194
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
195
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
196
- *
197
- * The version of the OpenAPI document: 2024-09-11
198
- * Contact: marketplaceapitest@amazon.com
199
- *
200
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
201
- * https://openapi-generator.tech
202
- * Do not edit the class manually.
203
- */
204
-
183
+ //#endregion
184
+ //#region src/api-model/models/marketplace-channel-details.d.ts
205
185
  /**
206
186
  * Marketplace channel-specific attributes for the return. These attributes are not mandatory and each channel can provide them differently.
207
187
  */
208
188
  interface MarketplaceChannelDetails {
209
- 'marketplaceChannel'?: MarketplaceChannel;
210
- /**
211
- * The ID of the merchant or seller to whom this return is created in the marketplace.
212
- */
213
- 'merchantId'?: string;
214
- /**
215
- * The marketplace-specific shipment ID.
216
- */
217
- 'shipmentId'?: string;
218
- /**
219
- * The marketplace-specific customer order ID.
220
- */
221
- 'customerOrderId'?: string;
222
- /**
223
- * The Amazon SmartConnect ID of the location to which this return is created.
224
- */
225
- 'returnLocationId'?: string;
226
- /**
227
- * The Amazon SmartConnect SKU of the channel.
228
- */
229
- 'channelSku'?: string;
230
- /**
231
- * The Amazon SmartConnect ID of the exchange order.
232
- */
233
- 'exchangeOrderId'?: string;
189
+ 'marketplaceChannel'?: MarketplaceChannel;
190
+ /**
191
+ * The ID of the merchant or seller to whom this return is created in the marketplace.
192
+ */
193
+ 'merchantId'?: string;
194
+ /**
195
+ * The marketplace-specific shipment ID.
196
+ */
197
+ 'shipmentId'?: string;
198
+ /**
199
+ * The marketplace-specific customer order ID.
200
+ */
201
+ 'customerOrderId'?: string;
202
+ /**
203
+ * The Amazon SmartConnect ID of the location to which this return is created.
204
+ */
205
+ 'returnLocationId'?: string;
206
+ /**
207
+ * The Amazon SmartConnect SKU of the channel.
208
+ */
209
+ 'channelSku'?: string;
210
+ /**
211
+ * The Amazon SmartConnect ID of the exchange order.
212
+ */
213
+ 'exchangeOrderId'?: string;
234
214
  }
235
-
215
+ //#endregion
216
+ //#region src/api-model/models/model-error.d.ts
236
217
  /**
237
218
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
238
219
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -248,20 +229,21 @@ interface MarketplaceChannelDetails {
248
229
  * Error response returned when the request is unsuccessful.
249
230
  */
250
231
  interface ModelError {
251
- /**
252
- * An error code that identifies the type of error that occurred.
253
- */
254
- 'code': string;
255
- /**
256
- * A message that describes the error condition.
257
- */
258
- 'message': string;
259
- /**
260
- * Additional details that can help the caller understand or fix the issue.
261
- */
262
- 'details'?: string;
232
+ /**
233
+ * An error code that identifies the type of error that occurred.
234
+ */
235
+ 'code': string;
236
+ /**
237
+ * A message that describes the error condition.
238
+ */
239
+ 'message': string;
240
+ /**
241
+ * Additional details that can help the caller understand or fix the issue.
242
+ */
243
+ 'details'?: string;
263
244
  }
264
-
245
+ //#endregion
246
+ //#region src/api-model/models/otp-details.d.ts
265
247
  /**
266
248
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
267
249
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -277,16 +259,17 @@ interface ModelError {
277
259
  * One-time password (OTP) details of the return item.
278
260
  */
279
261
  interface OtpDetails {
280
- /**
281
- * One-time password to validate the return delivered to the seller.
282
- */
283
- 'otp': string;
284
- /**
285
- * The UNIX timestamp of when the verification code expires.
286
- */
287
- 'validTill': number;
262
+ /**
263
+ * One-time password to validate the return delivered to the seller.
264
+ */
265
+ 'otp': string;
266
+ /**
267
+ * The UNIX timestamp of when the verification code expires.
268
+ */
269
+ 'validTill': number;
288
270
  }
289
-
271
+ //#endregion
272
+ //#region src/api-model/models/tracking-info.d.ts
290
273
  /**
291
274
  * The Selling Partner API for Amazon External Fulfillment Return Item Processing
292
275
  * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
@@ -302,406 +285,354 @@ interface OtpDetails {
302
285
  * Information for tracking a return.
303
286
  */
304
287
  interface TrackingInfo {
305
- /**
306
- * The name of the third party courier service used to ship the return package.
307
- */
308
- 'carrierName': string;
309
- /**
310
- * The tracking ID of the return package.
311
- */
312
- 'trackingId': string;
288
+ /**
289
+ * The name of the third party courier service used to ship the return package.
290
+ */
291
+ 'carrierName': string;
292
+ /**
293
+ * The tracking ID of the return package.
294
+ */
295
+ 'trackingId': string;
313
296
  }
314
-
315
- /**
316
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
317
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
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
-
297
+ //#endregion
298
+ //#region src/api-model/models/replanning-details.d.ts
327
299
  /**
328
300
  * Provides details about the replanned returns.
329
301
  */
330
302
  interface ReplanningDetails {
331
- /**
332
- * A list of all the previous tracking information for the return.
333
- */
334
- 'previousTrackingInfo'?: Array<TrackingInfo>;
303
+ /**
304
+ * A list of all the previous tracking information for the return.
305
+ */
306
+ 'previousTrackingInfo'?: Array<TrackingInfo>;
335
307
  }
336
-
337
- /**
338
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
339
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
340
- *
341
- * The version of the OpenAPI document: 2024-09-11
342
- * Contact: marketplaceapitest@amazon.com
343
- *
344
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
345
- * https://openapi-generator.tech
346
- * Do not edit the class manually.
347
- */
348
-
308
+ //#endregion
309
+ //#region src/api-model/models/return-metadata.d.ts
349
310
  /**
350
311
  * Metadata about the return item.
351
312
  */
352
313
  interface ReturnMetadata {
353
- /**
354
- * The reason for the return.
355
- */
356
- 'returnReason': string;
357
- /**
358
- * The RMA ID of the return.
359
- */
360
- 'rmaId'?: string;
361
- /**
362
- * The SmartConnect ID of the fulfillment order for which the return was placed.
363
- */
364
- 'fulfillmentOrderId'?: string;
365
- 'invoiceInformation'?: InvoiceInformation;
314
+ /**
315
+ * The reason for the return.
316
+ */
317
+ 'returnReason': string;
318
+ /**
319
+ * The RMA ID of the return.
320
+ */
321
+ 'rmaId'?: string;
322
+ /**
323
+ * The SmartConnect ID of the fulfillment order for which the return was placed.
324
+ */
325
+ 'fulfillmentOrderId'?: string;
326
+ 'invoiceInformation'?: InvoiceInformation;
366
327
  }
367
-
368
- /**
369
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
370
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
371
- *
372
- * The version of the OpenAPI document: 2024-09-11
373
- * Contact: marketplaceapitest@amazon.com
374
- *
375
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
376
- * https://openapi-generator.tech
377
- * Do not edit the class manually.
378
- */
379
-
328
+ //#endregion
329
+ //#region src/api-model/models/return-shipping-info.d.ts
380
330
  /**
381
331
  * Information about the shipping of the return packages.
382
332
  */
383
333
  interface ReturnShippingInfo {
384
- /**
385
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
386
- */
387
- 'deliveryDateTime'?: string;
388
- /**
389
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
390
- */
391
- 'pickupDateTime'?: string;
392
- 'forwardTrackingInfo'?: TrackingInfo;
393
- 'reverseTrackingInfo'?: TrackingInfo;
334
+ /**
335
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
336
+ */
337
+ 'deliveryDateTime'?: string;
338
+ /**
339
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
340
+ */
341
+ 'pickupDateTime'?: string;
342
+ 'forwardTrackingInfo'?: TrackingInfo;
343
+ 'reverseTrackingInfo'?: TrackingInfo;
394
344
  }
395
-
396
- /**
397
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
398
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
399
- *
400
- * The version of the OpenAPI document: 2024-09-11
401
- * Contact: marketplaceapitest@amazon.com
402
- *
403
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
404
- * https://openapi-generator.tech
405
- * Do not edit the class manually.
406
- */
407
-
345
+ //#endregion
346
+ //#region src/api-model/models/return.d.ts
408
347
  /**
409
348
  * Information about the return item.
410
349
  */
411
350
  interface Return {
412
- /**
413
- * The return item\'s ID.
414
- */
415
- 'id': string;
416
- /**
417
- * The SmartConnect identifier for where the return item was dropped for delivery.
418
- */
419
- 'returnLocationId'?: string;
420
- /**
421
- * The seller\'s identifier for the SKU.
422
- */
423
- 'merchantSku'?: string;
424
- /**
425
- * The type of return.
426
- */
427
- 'returnType': ReturnReturnTypeEnum;
428
- /**
429
- * The sub-type of return.
430
- */
431
- 'returnSubType'?: ReturnReturnSubTypeEnum;
432
- /**
433
- * The total number of units in the return.
434
- */
435
- 'numberOfUnits'?: number;
436
- /**
437
- * The current status of the return.
438
- */
439
- 'status': ReturnStatusEnum;
440
- /**
441
- * The ID of the location that fulfilled the order.
442
- */
443
- 'fulfillmentLocationId': string;
444
- /**
445
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
446
- */
447
- 'creationDateTime'?: string;
448
- /**
449
- * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
450
- */
451
- 'lastUpdatedDateTime': string;
452
- 'returnMetadata': ReturnMetadata;
453
- 'returnShippingInfo': ReturnShippingInfo;
454
- 'marketplaceChannelDetails': MarketplaceChannelDetails;
455
- 'otpDetails'?: OtpDetails;
456
- /**
457
- * The package delivery mode. This indicates whether the return was delivered to the seller with or without a one-time password (OTP).
458
- */
459
- 'packageDeliveryMode'?: ReturnPackageDeliveryModeEnum;
460
- 'replanningDetails'?: ReplanningDetails;
351
+ /**
352
+ * The return item\'s ID.
353
+ */
354
+ 'id': string;
355
+ /**
356
+ * The SmartConnect identifier for where the return item was dropped for delivery.
357
+ */
358
+ 'returnLocationId'?: string;
359
+ /**
360
+ * The seller\'s identifier for the SKU.
361
+ */
362
+ 'merchantSku'?: string;
363
+ /**
364
+ * The type of return.
365
+ */
366
+ 'returnType': ReturnReturnTypeEnum;
367
+ /**
368
+ * The sub-type of return.
369
+ */
370
+ 'returnSubType'?: ReturnReturnSubTypeEnum;
371
+ /**
372
+ * The total number of units in the return.
373
+ */
374
+ 'numberOfUnits'?: number;
375
+ /**
376
+ * The current status of the return.
377
+ */
378
+ 'status': ReturnStatusEnum;
379
+ /**
380
+ * The ID of the location that fulfilled the order.
381
+ */
382
+ 'fulfillmentLocationId': string;
383
+ /**
384
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
385
+ */
386
+ 'creationDateTime'?: string;
387
+ /**
388
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
389
+ */
390
+ 'lastUpdatedDateTime': string;
391
+ 'returnMetadata': ReturnMetadata;
392
+ 'returnShippingInfo': ReturnShippingInfo;
393
+ 'marketplaceChannelDetails': MarketplaceChannelDetails;
394
+ 'otpDetails'?: OtpDetails;
395
+ /**
396
+ * The package delivery mode. This indicates whether the return was delivered to the seller with or without a one-time password (OTP).
397
+ */
398
+ 'packageDeliveryMode'?: ReturnPackageDeliveryModeEnum;
399
+ 'replanningDetails'?: ReplanningDetails;
461
400
  }
462
401
  declare const ReturnReturnTypeEnum: {
463
- readonly Customer: "CUSTOMER";
464
- readonly Reject: "REJECT";
402
+ readonly Customer: "CUSTOMER";
403
+ readonly Reject: "REJECT";
465
404
  };
466
405
  type ReturnReturnTypeEnum = typeof ReturnReturnTypeEnum[keyof typeof ReturnReturnTypeEnum];
467
406
  declare const ReturnReturnSubTypeEnum: {
468
- readonly Normal: "NORMAL";
469
- readonly Replacement: "REPLACEMENT";
470
- readonly Exchange: "EXCHANGE";
407
+ readonly Normal: "NORMAL";
408
+ readonly Replacement: "REPLACEMENT";
409
+ readonly Exchange: "EXCHANGE";
471
410
  };
472
411
  type ReturnReturnSubTypeEnum = typeof ReturnReturnSubTypeEnum[keyof typeof ReturnReturnSubTypeEnum];
473
412
  declare const ReturnStatusEnum: {
474
- readonly Created: "CREATED";
475
- readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
476
- readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
477
- readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
478
- readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
479
- readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
480
- readonly InTransit: "IN_TRANSIT";
481
- readonly OutForDelivery: "OUT_FOR_DELIVERY";
482
- readonly Delivered: "DELIVERED";
483
- readonly Replanned: "REPLANNED";
484
- readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
485
- readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
486
- readonly Processed: "PROCESSED";
487
- readonly Rejected: "REJECTED";
488
- readonly Cancelled: "CANCELLED";
413
+ readonly Created: "CREATED";
414
+ readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
415
+ readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
416
+ readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
417
+ readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
418
+ readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
419
+ readonly InTransit: "IN_TRANSIT";
420
+ readonly OutForDelivery: "OUT_FOR_DELIVERY";
421
+ readonly Delivered: "DELIVERED";
422
+ readonly Replanned: "REPLANNED";
423
+ readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
424
+ readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
425
+ readonly Processed: "PROCESSED";
426
+ readonly Rejected: "REJECTED";
427
+ readonly Cancelled: "CANCELLED";
489
428
  };
490
429
  type ReturnStatusEnum = typeof ReturnStatusEnum[keyof typeof ReturnStatusEnum];
491
430
  declare const ReturnPackageDeliveryModeEnum: {
492
- readonly WithOtp: "WITH_OTP";
493
- readonly WithoutOtp: "WITHOUT_OTP";
431
+ readonly WithOtp: "WITH_OTP";
432
+ readonly WithoutOtp: "WITHOUT_OTP";
494
433
  };
495
434
  type ReturnPackageDeliveryModeEnum = typeof ReturnPackageDeliveryModeEnum[keyof typeof ReturnPackageDeliveryModeEnum];
496
-
497
- /**
498
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
499
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
500
- *
501
- * The version of the OpenAPI document: 2024-09-11
502
- * Contact: marketplaceapitest@amazon.com
503
- *
504
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
505
- * https://openapi-generator.tech
506
- * Do not edit the class manually.
507
- */
508
-
435
+ //#endregion
436
+ //#region src/api-model/models/returns-response.d.ts
509
437
  /**
510
438
  * The response to the `listReturns` operation.
511
439
  */
512
440
  interface ReturnsResponse {
513
- /**
514
- * A list of returns.
515
- */
516
- 'returns'?: Array<Return>;
517
- /**
518
- * 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.
519
- */
520
- 'nextToken'?: string;
441
+ /**
442
+ * A list of returns.
443
+ */
444
+ 'returns'?: Array<Return>;
445
+ /**
446
+ * 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.
447
+ */
448
+ 'nextToken'?: string;
521
449
  }
522
-
450
+ //#endregion
451
+ //#region src/api-model/api/external-fulfillment-returns-api.d.ts
523
452
  /**
524
453
  * ExternalFulfillmentReturnsApi - axios parameter creator
525
454
  */
526
455
  declare const ExternalFulfillmentReturnsApiAxiosParamCreator: (configuration?: Configuration) => {
527
- /**
528
- * Retrieve the return item with the specified ID.
529
- * @param {string} returnId The ID of the return item you want.
530
- * @param {*} [options] Override http request option.
531
- * @throws {RequiredError}
532
- */
533
- getReturn: (returnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
534
- /**
535
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
536
- * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
537
- * @param {string} [rmaId] The RMA ID of the return items you want to list.
538
- * @param {ListReturnsStatusEnum} [status] The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
539
- * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
540
- * @param {string} [createdSince] Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
541
- * @param {string} [createdUntil] Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
542
- * @param {string} [lastUpdatedSince] Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
543
- * @param {string} [lastUpdatedUntil] Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
544
- * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
545
- * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
546
- * @param {number} [maxResults] The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
547
- * @param {string} [nextToken] 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.
548
- * @param {*} [options] Override http request option.
549
- * @throws {RequiredError}
550
- */
551
- listReturns: (returnLocationId?: string, rmaId?: string, status?: ListReturnsStatusEnum, reverseTrackingId?: string, createdSince?: string, createdUntil?: string, lastUpdatedSince?: string, lastUpdatedUntil?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
456
+ /**
457
+ * Retrieve the return item with the specified ID.
458
+ * @param {string} returnId The ID of the return item you want.
459
+ * @param {*} [options] Override http request option.
460
+ * @throws {RequiredError}
461
+ */
462
+ getReturn: (returnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
463
+ /**
464
+ * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
465
+ * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
466
+ * @param {string} [rmaId] The RMA ID of the return items you want to list.
467
+ * @param {ListReturnsStatusEnum} [status] The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
468
+ * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
469
+ * @param {string} [createdSince] Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
470
+ * @param {string} [createdUntil] Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
471
+ * @param {string} [lastUpdatedSince] Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
472
+ * @param {string} [lastUpdatedUntil] Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
473
+ * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
474
+ * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
475
+ * @param {number} [maxResults] The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
476
+ * @param {string} [nextToken] 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.
477
+ * @param {*} [options] Override http request option.
478
+ * @throws {RequiredError}
479
+ */
480
+ listReturns: (returnLocationId?: string, rmaId?: string, status?: ListReturnsStatusEnum, reverseTrackingId?: string, createdSince?: string, createdUntil?: string, lastUpdatedSince?: string, lastUpdatedUntil?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
552
481
  };
553
482
  /**
554
483
  * ExternalFulfillmentReturnsApi - functional programming interface
555
484
  */
556
485
  declare const ExternalFulfillmentReturnsApiFp: (configuration?: Configuration) => {
557
- /**
558
- * Retrieve the return item with the specified ID.
559
- * @param {string} returnId The ID of the return item you want.
560
- * @param {*} [options] Override http request option.
561
- * @throws {RequiredError}
562
- */
563
- getReturn(returnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Return>>;
564
- /**
565
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
566
- * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
567
- * @param {string} [rmaId] The RMA ID of the return items you want to list.
568
- * @param {ListReturnsStatusEnum} [status] The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
569
- * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
570
- * @param {string} [createdSince] Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
571
- * @param {string} [createdUntil] Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
572
- * @param {string} [lastUpdatedSince] Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
573
- * @param {string} [lastUpdatedUntil] Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
574
- * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
575
- * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
576
- * @param {number} [maxResults] The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
577
- * @param {string} [nextToken] 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.
578
- * @param {*} [options] Override http request option.
579
- * @throws {RequiredError}
580
- */
581
- listReturns(returnLocationId?: string, rmaId?: string, status?: ListReturnsStatusEnum, reverseTrackingId?: string, createdSince?: string, createdUntil?: string, lastUpdatedSince?: string, lastUpdatedUntil?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnsResponse>>;
486
+ /**
487
+ * Retrieve the return item with the specified ID.
488
+ * @param {string} returnId The ID of the return item you want.
489
+ * @param {*} [options] Override http request option.
490
+ * @throws {RequiredError}
491
+ */
492
+ getReturn(returnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Return>>;
493
+ /**
494
+ * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
495
+ * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
496
+ * @param {string} [rmaId] The RMA ID of the return items you want to list.
497
+ * @param {ListReturnsStatusEnum} [status] The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
498
+ * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
499
+ * @param {string} [createdSince] Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
500
+ * @param {string} [createdUntil] Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
501
+ * @param {string} [lastUpdatedSince] Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
502
+ * @param {string} [lastUpdatedUntil] Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
503
+ * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
504
+ * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
505
+ * @param {number} [maxResults] The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
506
+ * @param {string} [nextToken] 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.
507
+ * @param {*} [options] Override http request option.
508
+ * @throws {RequiredError}
509
+ */
510
+ listReturns(returnLocationId?: string, rmaId?: string, status?: ListReturnsStatusEnum, reverseTrackingId?: string, createdSince?: string, createdUntil?: string, lastUpdatedSince?: string, lastUpdatedUntil?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReturnsResponse>>;
582
511
  };
583
512
  /**
584
513
  * ExternalFulfillmentReturnsApi - factory interface
585
514
  */
586
515
  declare const ExternalFulfillmentReturnsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
587
- /**
588
- * Retrieve the return item with the specified ID.
589
- * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
590
- * @param {*} [options] Override http request option.
591
- * @throws {RequiredError}
592
- */
593
- getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<Return>;
594
- /**
595
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
596
- * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
597
- * @param {*} [options] Override http request option.
598
- * @throws {RequiredError}
599
- */
600
- listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnsResponse>;
516
+ /**
517
+ * Retrieve the return item with the specified ID.
518
+ * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
519
+ * @param {*} [options] Override http request option.
520
+ * @throws {RequiredError}
521
+ */
522
+ getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<Return>;
523
+ /**
524
+ * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
525
+ * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
526
+ * @param {*} [options] Override http request option.
527
+ * @throws {RequiredError}
528
+ */
529
+ listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnsResponse>;
601
530
  };
602
531
  /**
603
532
  * Request parameters for getReturn operation in ExternalFulfillmentReturnsApi.
604
533
  */
605
534
  interface ExternalFulfillmentReturnsApiGetReturnRequest {
606
- /**
607
- * The ID of the return item you want.
608
- */
609
- readonly returnId: string;
535
+ /**
536
+ * The ID of the return item you want.
537
+ */
538
+ readonly returnId: string;
610
539
  }
611
540
  /**
612
541
  * Request parameters for listReturns operation in ExternalFulfillmentReturnsApi.
613
542
  */
614
543
  interface ExternalFulfillmentReturnsApiListReturnsRequest {
615
- /**
616
- * The SmartConnect location ID of the location from which you want to retrieve return items.
617
- */
618
- readonly returnLocationId?: string;
619
- /**
620
- * The RMA ID of the return items you want to list.
621
- */
622
- readonly rmaId?: string;
623
- /**
624
- * The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
625
- */
626
- readonly status?: ListReturnsStatusEnum;
627
- /**
628
- * The reverse tracking ID of the return items you want to list.
629
- */
630
- readonly reverseTrackingId?: string;
631
- /**
632
- * Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
633
- */
634
- readonly createdSince?: string;
635
- /**
636
- * Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
637
- */
638
- readonly createdUntil?: string;
639
- /**
640
- * Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
641
- */
642
- readonly lastUpdatedSince?: string;
643
- /**
644
- * Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
645
- */
646
- readonly lastUpdatedUntil?: string;
647
- /**
648
- * DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
649
- */
650
- readonly lastUpdatedAfter?: string;
651
- /**
652
- * DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
653
- */
654
- readonly lastUpdatedBefore?: string;
655
- /**
656
- * The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
657
- */
658
- readonly maxResults?: number;
659
- /**
660
- * 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.
661
- */
662
- readonly nextToken?: string;
544
+ /**
545
+ * The SmartConnect location ID of the location from which you want to retrieve return items.
546
+ */
547
+ readonly returnLocationId?: string;
548
+ /**
549
+ * The RMA ID of the return items you want to list.
550
+ */
551
+ readonly rmaId?: string;
552
+ /**
553
+ * The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
554
+ */
555
+ readonly status?: ListReturnsStatusEnum;
556
+ /**
557
+ * The reverse tracking ID of the return items you want to list.
558
+ */
559
+ readonly reverseTrackingId?: string;
560
+ /**
561
+ * Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
562
+ */
563
+ readonly createdSince?: string;
564
+ /**
565
+ * Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
566
+ */
567
+ readonly createdUntil?: string;
568
+ /**
569
+ * Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
570
+ */
571
+ readonly lastUpdatedSince?: string;
572
+ /**
573
+ * Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply &#x60;returnLocationId&#x60; and &#x60;status&#x60;.
574
+ */
575
+ readonly lastUpdatedUntil?: string;
576
+ /**
577
+ * DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
578
+ */
579
+ readonly lastUpdatedAfter?: string;
580
+ /**
581
+ * DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
582
+ */
583
+ readonly lastUpdatedBefore?: string;
584
+ /**
585
+ * The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
586
+ */
587
+ readonly maxResults?: number;
588
+ /**
589
+ * 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.
590
+ */
591
+ readonly nextToken?: string;
663
592
  }
664
593
  /**
665
594
  * ExternalFulfillmentReturnsApi - object-oriented interface
666
595
  */
667
596
  declare class ExternalFulfillmentReturnsApi extends BaseAPI {
668
- /**
669
- * Retrieve the return item with the specified ID.
670
- * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
671
- * @param {*} [options] Override http request option.
672
- * @throws {RequiredError}
673
- */
674
- getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Return, any, {}>>;
675
- /**
676
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
677
- * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
678
- * @param {*} [options] Override http request option.
679
- * @throws {RequiredError}
680
- */
681
- listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ReturnsResponse, any, {}>>;
597
+ /**
598
+ * Retrieve the return item with the specified ID.
599
+ * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
600
+ * @param {*} [options] Override http request option.
601
+ * @throws {RequiredError}
602
+ */
603
+ getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Return, any, {}>>;
604
+ /**
605
+ * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
606
+ * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
607
+ * @param {*} [options] Override http request option.
608
+ * @throws {RequiredError}
609
+ */
610
+ listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReturnsResponse, any, {}>>;
682
611
  }
683
612
  declare const ListReturnsStatusEnum: {
684
- readonly Created: "CREATED";
685
- readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
686
- readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
687
- readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
688
- readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
689
- readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
690
- readonly InTransit: "IN_TRANSIT";
691
- readonly OutForDelivery: "OUT_FOR_DELIVERY";
692
- readonly Delivered: "DELIVERED";
693
- readonly Replanned: "REPLANNED";
694
- readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
695
- readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
696
- readonly Processed: "PROCESSED";
697
- readonly Rejected: "REJECTED";
698
- readonly Cancelled: "CANCELLED";
613
+ readonly Created: "CREATED";
614
+ readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
615
+ readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
616
+ readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
617
+ readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
618
+ readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
619
+ readonly InTransit: "IN_TRANSIT";
620
+ readonly OutForDelivery: "OUT_FOR_DELIVERY";
621
+ readonly Delivered: "DELIVERED";
622
+ readonly Replanned: "REPLANNED";
623
+ readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
624
+ readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
625
+ readonly Processed: "PROCESSED";
626
+ readonly Rejected: "REJECTED";
627
+ readonly Cancelled: "CANCELLED";
699
628
  };
700
629
  type ListReturnsStatusEnum = typeof ListReturnsStatusEnum[keyof typeof ListReturnsStatusEnum];
701
-
630
+ //#endregion
631
+ //#region src/client.d.ts
702
632
  declare const clientRateLimits: RateLimit[];
703
633
  declare class ExternalFulfillmentReturnsApiClient extends ExternalFulfillmentReturnsApi {
704
- constructor(configuration: ClientConfiguration);
634
+ constructor(configuration: ClientConfiguration);
705
635
  }
706
-
707
- export { type ErrorList, ExternalFulfillmentReturnsApi, ExternalFulfillmentReturnsApiAxiosParamCreator, ExternalFulfillmentReturnsApiClient, ExternalFulfillmentReturnsApiFactory, ExternalFulfillmentReturnsApiFp, type ExternalFulfillmentReturnsApiGetReturnRequest, type ExternalFulfillmentReturnsApiListReturnsRequest, type InvoiceInformation, ListReturnsStatusEnum, type MarketplaceChannel, type MarketplaceChannelDetails, type ModelError, type OtpDetails, type ReplanningDetails, type Return, type ReturnMetadata, ReturnPackageDeliveryModeEnum, ReturnReturnSubTypeEnum, ReturnReturnTypeEnum, type ReturnShippingInfo, ReturnStatusEnum, type ReturnsResponse, type TrackingInfo, clientRateLimits };
636
+ //#endregion
637
+ export { ErrorList, ExternalFulfillmentReturnsApi, ExternalFulfillmentReturnsApiAxiosParamCreator, ExternalFulfillmentReturnsApiClient, ExternalFulfillmentReturnsApiFactory, ExternalFulfillmentReturnsApiFp, ExternalFulfillmentReturnsApiGetReturnRequest, ExternalFulfillmentReturnsApiListReturnsRequest, InvoiceInformation, ListReturnsStatusEnum, MarketplaceChannel, MarketplaceChannelDetails, ModelError, OtpDetails, ReplanningDetails, Return, ReturnMetadata, ReturnPackageDeliveryModeEnum, ReturnReturnSubTypeEnum, ReturnReturnTypeEnum, ReturnShippingInfo, ReturnStatusEnum, ReturnsResponse, TrackingInfo, clientRateLimits };
638
+ //# sourceMappingURL=index.d.ts.map