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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +461 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +707 -0
  5. package/dist/index.d.ts +707 -0
  6. package/dist/index.js +414 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/external-fulfillment-returns-api.js +0 -259
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/error-list.js +0 -15
  16. package/dist/cjs/api-model/models/index.js +0 -28
  17. package/dist/cjs/api-model/models/invoice-information.js +0 -15
  18. package/dist/cjs/api-model/models/marketplace-channel-details.js +0 -15
  19. package/dist/cjs/api-model/models/marketplace-channel.js +0 -15
  20. package/dist/cjs/api-model/models/model-error.js +0 -15
  21. package/dist/cjs/api-model/models/otp-details.js +0 -15
  22. package/dist/cjs/api-model/models/replanning-details.js +0 -15
  23. package/dist/cjs/api-model/models/return-metadata.js +0 -15
  24. package/dist/cjs/api-model/models/return-shipping-info.js +0 -15
  25. package/dist/cjs/api-model/models/return.js +0 -46
  26. package/dist/cjs/api-model/models/returns-response.js +0 -15
  27. package/dist/cjs/api-model/models/tracking-info.js +0 -15
  28. package/dist/cjs/client.js +0 -13
  29. package/dist/cjs/index.js +0 -19
  30. package/dist/es/api-model/api/external-fulfillment-returns-api.js +0 -249
  31. package/dist/es/api-model/api.js +0 -14
  32. package/dist/es/api-model/base.js +0 -44
  33. package/dist/es/api-model/common.js +0 -110
  34. package/dist/es/api-model/configuration.js +0 -94
  35. package/dist/es/api-model/index.js +0 -16
  36. package/dist/es/api-model/models/error-list.js +0 -14
  37. package/dist/es/api-model/models/index.js +0 -12
  38. package/dist/es/api-model/models/invoice-information.js +0 -14
  39. package/dist/es/api-model/models/marketplace-channel-details.js +0 -14
  40. package/dist/es/api-model/models/marketplace-channel.js +0 -14
  41. package/dist/es/api-model/models/model-error.js +0 -14
  42. package/dist/es/api-model/models/otp-details.js +0 -14
  43. package/dist/es/api-model/models/replanning-details.js +0 -14
  44. package/dist/es/api-model/models/return-metadata.js +0 -14
  45. package/dist/es/api-model/models/return-shipping-info.js +0 -14
  46. package/dist/es/api-model/models/return.js +0 -43
  47. package/dist/es/api-model/models/returns-response.js +0 -14
  48. package/dist/es/api-model/models/tracking-info.js +0 -14
  49. package/dist/es/client.js +0 -9
  50. package/dist/es/index.js +0 -3
  51. package/dist/types/api-model/api/external-fulfillment-returns-api.d.ts +0 -195
  52. package/dist/types/api-model/api.d.ts +0 -12
  53. package/dist/types/api-model/base.d.ts +0 -42
  54. package/dist/types/api-model/common.d.ts +0 -34
  55. package/dist/types/api-model/configuration.d.ts +0 -98
  56. package/dist/types/api-model/index.d.ts +0 -14
  57. package/dist/types/api-model/models/error-list.d.ts +0 -20
  58. package/dist/types/api-model/models/index.d.ts +0 -12
  59. package/dist/types/api-model/models/invoice-information.d.ts +0 -20
  60. package/dist/types/api-model/models/marketplace-channel-details.d.ts +0 -42
  61. package/dist/types/api-model/models/marketplace-channel.d.ts +0 -24
  62. package/dist/types/api-model/models/model-error.d.ts +0 -28
  63. package/dist/types/api-model/models/otp-details.d.ts +0 -24
  64. package/dist/types/api-model/models/replanning-details.d.ts +0 -21
  65. package/dist/types/api-model/models/return-metadata.d.ts +0 -30
  66. package/dist/types/api-model/models/return-shipping-info.d.ts +0 -27
  67. package/dist/types/api-model/models/return.d.ts +0 -104
  68. package/dist/types/api-model/models/returns-response.d.ts +0 -25
  69. package/dist/types/api-model/models/tracking-info.d.ts +0 -24
  70. package/dist/types/client.d.ts +0 -6
  71. package/dist/types/index.d.ts +0 -3
@@ -1,94 +0,0 @@
1
- /* tslint:disable */
2
- /**
3
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
4
- * 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.
5
- *
6
- * The version of the OpenAPI document: 2024-09-11
7
- * Contact: marketplaceapitest@amazon.com
8
- *
9
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10
- * https://openapi-generator.tech
11
- * Do not edit the class manually.
12
- */
13
- export class Configuration {
14
- /**
15
- * parameter for apiKey security
16
- * @param name security name
17
- */
18
- apiKey;
19
- /**
20
- * parameter for basic security
21
- */
22
- username;
23
- /**
24
- * parameter for basic security
25
- */
26
- password;
27
- /**
28
- * parameter for oauth2 security
29
- * @param name security name
30
- * @param scopes oauth2 scope
31
- */
32
- accessToken;
33
- /**
34
- * parameter for aws4 signature security
35
- * @param {Object} AWS4Signature - AWS4 Signature security
36
- * @param {string} options.region - aws region
37
- * @param {string} options.service - name of the service.
38
- * @param {string} credentials.accessKeyId - aws access key id
39
- * @param {string} credentials.secretAccessKey - aws access key
40
- * @param {string} credentials.sessionToken - aws session token
41
- * @memberof Configuration
42
- */
43
- awsv4;
44
- /**
45
- * override base path
46
- */
47
- basePath;
48
- /**
49
- * override server index
50
- */
51
- serverIndex;
52
- /**
53
- * base options for axios calls
54
- */
55
- baseOptions;
56
- /**
57
- * The FormData constructor that will be used to create multipart form data
58
- * requests. You can inject this here so that execution environments that
59
- * do not support the FormData class can still run the generated client.
60
- *
61
- * @type {new () => FormData}
62
- */
63
- formDataCtor;
64
- constructor(param = {}) {
65
- this.apiKey = param.apiKey;
66
- this.username = param.username;
67
- this.password = param.password;
68
- this.accessToken = param.accessToken;
69
- this.awsv4 = param.awsv4;
70
- this.basePath = param.basePath;
71
- this.serverIndex = param.serverIndex;
72
- this.baseOptions = {
73
- ...param.baseOptions,
74
- headers: {
75
- ...param.baseOptions?.headers,
76
- },
77
- };
78
- this.formDataCtor = param.formDataCtor;
79
- }
80
- /**
81
- * Check if the given MIME is a JSON MIME.
82
- * JSON MIME examples:
83
- * application/json
84
- * application/json; charset=UTF8
85
- * APPLICATION/JSON
86
- * application/vnd.company+json
87
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
88
- * @return True if the given MIME is JSON, false otherwise.
89
- */
90
- isJsonMime(mime) {
91
- const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
92
- return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
93
- }
94
- }
@@ -1,16 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export * from "./api";
15
- export * from "./configuration";
16
- export * from "./models";
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,12 +0,0 @@
1
- export * from './error-list';
2
- export * from './invoice-information';
3
- export * from './marketplace-channel';
4
- export * from './marketplace-channel-details';
5
- export * from './model-error';
6
- export * from './otp-details';
7
- export * from './replanning-details';
8
- export * from './return';
9
- export * from './return-metadata';
10
- export * from './return-shipping-info';
11
- export * from './returns-response';
12
- export * from './tracking-info';
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,43 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const ReturnReturnTypeEnum = {
15
- Customer: 'CUSTOMER',
16
- Reject: 'REJECT'
17
- };
18
- export const ReturnReturnSubTypeEnum = {
19
- Normal: 'NORMAL',
20
- Replacement: 'REPLACEMENT',
21
- Exchange: 'EXCHANGE'
22
- };
23
- export const ReturnStatusEnum = {
24
- Created: 'CREATED',
25
- CarrierNotifiedToPickUpFromCustomer: 'CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER',
26
- CarrierOutForPickUpFromCustomer: 'CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER',
27
- CustomerCancelledPickUp: 'CUSTOMER_CANCELLED_PICK_UP',
28
- CustomerRescheduledPickUp: 'CUSTOMER_RESCHEDULED_PICK_UP',
29
- PickedFromCustomer: 'PICKED_FROM_CUSTOMER',
30
- InTransit: 'IN_TRANSIT',
31
- OutForDelivery: 'OUT_FOR_DELIVERY',
32
- Delivered: 'DELIVERED',
33
- Replanned: 'REPLANNED',
34
- CustomerDroppedOff: 'CUSTOMER_DROPPED_OFF',
35
- PartiallyProcessed: 'PARTIALLY_PROCESSED',
36
- Processed: 'PROCESSED',
37
- Rejected: 'REJECTED',
38
- Cancelled: 'CANCELLED'
39
- };
40
- export const ReturnPackageDeliveryModeEnum = {
41
- WithOtp: 'WITH_OTP',
42
- WithoutOtp: 'WITHOUT_OTP'
43
- };
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 2024-09-11
8
- * Contact: marketplaceapitest@amazon.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
package/dist/es/client.js DELETED
@@ -1,9 +0,0 @@
1
- import { createAxiosInstance } from '@sp-api-sdk/common';
2
- import { Configuration, ExternalFulfillmentReturnsApi } from './api-model';
3
- export const clientRateLimits = [];
4
- export class ExternalFulfillmentReturnsApiClient extends ExternalFulfillmentReturnsApi {
5
- constructor(configuration) {
6
- const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
7
- super(new Configuration(), endpoint, axios);
8
- }
9
- }
package/dist/es/index.js DELETED
@@ -1,3 +0,0 @@
1
- export * from './client';
2
- export * from './api-model/api';
3
- export * from './api-model/models';
@@ -1,195 +0,0 @@
1
- /**
2
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- * Contact: marketplaceapitest@amazon.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { Return } from '../models';
17
- import type { ReturnsResponse } from '../models';
18
- /**
19
- * ExternalFulfillmentReturnsApi - axios parameter creator
20
- */
21
- export declare const ExternalFulfillmentReturnsApiAxiosParamCreator: (configuration?: Configuration) => {
22
- /**
23
- * Retrieve the return item with the specified ID.
24
- * @param {string} returnId The ID of the return item you want.
25
- * @param {*} [options] Override http request option.
26
- * @throws {RequiredError}
27
- */
28
- getReturn: (returnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
29
- /**
30
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
31
- * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
32
- * @param {string} [rmaId] The RMA ID of the return items you want to list.
33
- * @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.
34
- * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
35
- * @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.
36
- * @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.
37
- * @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;.
38
- * @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;.
39
- * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
40
- * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
41
- * @param {number} [maxResults] The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
42
- * @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.
43
- * @param {*} [options] Override http request option.
44
- * @throws {RequiredError}
45
- */
46
- 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>;
47
- };
48
- /**
49
- * ExternalFulfillmentReturnsApi - functional programming interface
50
- */
51
- export declare const ExternalFulfillmentReturnsApiFp: (configuration?: Configuration) => {
52
- /**
53
- * Retrieve the return item with the specified ID.
54
- * @param {string} returnId The ID of the return item you want.
55
- * @param {*} [options] Override http request option.
56
- * @throws {RequiredError}
57
- */
58
- getReturn(returnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Return>>;
59
- /**
60
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
61
- * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
62
- * @param {string} [rmaId] The RMA ID of the return items you want to list.
63
- * @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.
64
- * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
65
- * @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.
66
- * @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.
67
- * @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;.
68
- * @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;.
69
- * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
70
- * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
71
- * @param {number} [maxResults] The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
72
- * @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.
73
- * @param {*} [options] Override http request option.
74
- * @throws {RequiredError}
75
- */
76
- 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>>;
77
- };
78
- /**
79
- * ExternalFulfillmentReturnsApi - factory interface
80
- */
81
- export declare const ExternalFulfillmentReturnsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
82
- /**
83
- * Retrieve the return item with the specified ID.
84
- * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
85
- * @param {*} [options] Override http request option.
86
- * @throws {RequiredError}
87
- */
88
- getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<Return>;
89
- /**
90
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
91
- * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
92
- * @param {*} [options] Override http request option.
93
- * @throws {RequiredError}
94
- */
95
- listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnsResponse>;
96
- };
97
- /**
98
- * Request parameters for getReturn operation in ExternalFulfillmentReturnsApi.
99
- */
100
- export interface ExternalFulfillmentReturnsApiGetReturnRequest {
101
- /**
102
- * The ID of the return item you want.
103
- */
104
- readonly returnId: string;
105
- }
106
- /**
107
- * Request parameters for listReturns operation in ExternalFulfillmentReturnsApi.
108
- */
109
- export interface ExternalFulfillmentReturnsApiListReturnsRequest {
110
- /**
111
- * The SmartConnect location ID of the location from which you want to retrieve return items.
112
- */
113
- readonly returnLocationId?: string;
114
- /**
115
- * The RMA ID of the return items you want to list.
116
- */
117
- readonly rmaId?: string;
118
- /**
119
- * The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
120
- */
121
- readonly status?: ListReturnsStatusEnum;
122
- /**
123
- * The reverse tracking ID of the return items you want to list.
124
- */
125
- readonly reverseTrackingId?: string;
126
- /**
127
- * 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.
128
- */
129
- readonly createdSince?: string;
130
- /**
131
- * 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.
132
- */
133
- readonly createdUntil?: string;
134
- /**
135
- * 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;.
136
- */
137
- readonly lastUpdatedSince?: string;
138
- /**
139
- * 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;.
140
- */
141
- readonly lastUpdatedUntil?: string;
142
- /**
143
- * DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
144
- */
145
- readonly lastUpdatedAfter?: string;
146
- /**
147
- * DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
148
- */
149
- readonly lastUpdatedBefore?: string;
150
- /**
151
- * The number of return items you want to include in the response. **Default:** 10 **Maximum:** 100
152
- */
153
- readonly maxResults?: number;
154
- /**
155
- * 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.
156
- */
157
- readonly nextToken?: string;
158
- }
159
- /**
160
- * ExternalFulfillmentReturnsApi - object-oriented interface
161
- */
162
- export declare class ExternalFulfillmentReturnsApi extends BaseAPI {
163
- /**
164
- * Retrieve the return item with the specified ID.
165
- * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
166
- * @param {*} [options] Override http request option.
167
- * @throws {RequiredError}
168
- */
169
- getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Return, any, {}>>;
170
- /**
171
- * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
172
- * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
173
- * @param {*} [options] Override http request option.
174
- * @throws {RequiredError}
175
- */
176
- listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ReturnsResponse, any, {}>>;
177
- }
178
- export declare const ListReturnsStatusEnum: {
179
- readonly Created: "CREATED";
180
- readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
181
- readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
182
- readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
183
- readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
184
- readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
185
- readonly InTransit: "IN_TRANSIT";
186
- readonly OutForDelivery: "OUT_FOR_DELIVERY";
187
- readonly Delivered: "DELIVERED";
188
- readonly Replanned: "REPLANNED";
189
- readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
190
- readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
191
- readonly Processed: "PROCESSED";
192
- readonly Rejected: "REJECTED";
193
- readonly Cancelled: "CANCELLED";
194
- };
195
- export type ListReturnsStatusEnum = typeof ListReturnsStatusEnum[keyof typeof ListReturnsStatusEnum];
@@ -1,12 +0,0 @@
1
- /**
2
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- * Contact: marketplaceapitest@amazon.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export * from './api/external-fulfillment-returns-api';
@@ -1,42 +0,0 @@
1
- /**
2
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- * Contact: marketplaceapitest@amazon.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- export declare const BASE_PATH: string;
15
- export declare const COLLECTION_FORMATS: {
16
- csv: string;
17
- ssv: string;
18
- tsv: string;
19
- pipes: string;
20
- };
21
- export interface RequestArgs {
22
- url: string;
23
- options: RawAxiosRequestConfig;
24
- }
25
- export declare class BaseAPI {
26
- protected basePath: string;
27
- protected axios: AxiosInstance;
28
- protected configuration: Configuration | undefined;
29
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
- }
31
- export declare class RequiredError extends Error {
32
- field: string;
33
- constructor(field: string, msg?: string);
34
- }
35
- interface ServerMap {
36
- [key: string]: {
37
- url: string;
38
- description: string;
39
- }[];
40
- }
41
- export declare const operationServerMap: ServerMap;
42
- export {};
@@ -1,34 +0,0 @@
1
- /**
2
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 2024-09-11
6
- * Contact: marketplaceapitest@amazon.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from "./configuration";
13
- import type { RequestArgs } from "./base";
14
- import type { AxiosInstance, AxiosResponse } from 'axios';
15
- export declare const DUMMY_BASE_URL = "https://example.com";
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
21
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
22
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
23
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
24
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
25
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
26
- /**
27
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
30
- */
31
- export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
32
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
33
- export declare const toPathString: (url: URL) => string;
34
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;