@sp-api-sdk/external-fulfillment-returns-api-2024-09-11 1.1.0

package/dist/es/api-model/common.js

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { RequiredError } from "./base";
+export const DUMMY_BASE_URL = 'https://example.com';
+/**
+ *
+ * @throws {RequiredError}
+ */
+export const assertParamExists = function (functionName, paramName, paramValue) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+};
+export const setApiKeyToObject = async function (object, keyParamName, configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+};
+export const setBasicAuthToObject = function (object, configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+};
+export const setBearerAuthToObject = async function (object, configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+};
+export const setOAuthToObject = async function (object, name, scopes, configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+};
+function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+export const setSearchParams = function (url, ...objects) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+};
+export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+};
+export const toPathString = function (url) {
+    return url.pathname + url.search + url.hash;
+};
+export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
+    return (axios = globalAxios, basePath = BASE_PATH) => {
+        const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
+        return axios.request(axiosRequestArgs);
+    };
+};

package/dist/es/api-model/configuration.js

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey;
+    /**
+     * parameter for basic security
+     */
+    username;
+    /**
+     * parameter for basic security
+     */
+    password;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken;
+    /**
+     * override base path
+     */
+    basePath;
+    /**
+     * override server index
+     */
+    serverIndex;
+    /**
+     * base options for axios calls
+     */
+    baseOptions;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor;
+    constructor(param = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
+        this.formDataCtor = param.formDataCtor;
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/dist/es/api-model/index.js

@@ -0,0 +1,16 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/es/api-model/models/error-list.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/index.js

@@ -0,0 +1,12 @@
+export * from './error-list';
+export * from './invoice-information';
+export * from './marketplace-channel';
+export * from './marketplace-channel-details';
+export * from './model-error';
+export * from './otp-details';
+export * from './replanning-details';
+export * from './return';
+export * from './return-metadata';
+export * from './return-shipping-info';
+export * from './returns-response';
+export * from './tracking-info';

package/dist/es/api-model/models/invoice-information.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/marketplace-channel-details.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/marketplace-channel.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/model-error.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/otp-details.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/replanning-details.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/return-metadata.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/return-shipping-info.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/return.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const ReturnReturnTypeEnum = {
+    Customer: 'CUSTOMER',
+    Reject: 'REJECT'
+};
+export const ReturnReturnSubTypeEnum = {
+    Normal: 'NORMAL',
+    Replacement: 'REPLACEMENT',
+    Exchange: 'EXCHANGE'
+};
+export const ReturnStatusEnum = {
+    Created: 'CREATED',
+    CarrierNotifiedToPickUpFromCustomer: 'CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER',
+    CarrierOutForPickUpFromCustomer: 'CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER',
+    CustomerCancelledPickUp: 'CUSTOMER_CANCELLED_PICK_UP',
+    CustomerRescheduledPickUp: 'CUSTOMER_RESCHEDULED_PICK_UP',
+    PickedFromCustomer: 'PICKED_FROM_CUSTOMER',
+    InTransit: 'IN_TRANSIT',
+    OutForDelivery: 'OUT_FOR_DELIVERY',
+    Delivered: 'DELIVERED',
+    Replanned: 'REPLANNED',
+    CustomerDroppedOff: 'CUSTOMER_DROPPED_OFF',
+    PartiallyProcessed: 'PARTIALLY_PROCESSED',
+    Processed: 'PROCESSED',
+    Rejected: 'REJECTED',
+    Cancelled: 'CANCELLED'
+};
+export const ReturnPackageDeliveryModeEnum = {
+    WithOtp: 'WITH_OTP',
+    WithoutOtp: 'WITHOUT_OTP'
+};

package/dist/es/api-model/models/returns-response.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/api-model/models/tracking-info.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/es/client.js

@@ -0,0 +1,9 @@
+import { createAxiosInstance } from '@sp-api-sdk/common';
+import { Configuration, ExternalFulfillmentReturnsApi } from './api-model';
+export const clientRateLimits = [];
+export class ExternalFulfillmentReturnsApiClient extends ExternalFulfillmentReturnsApi {
+    constructor(configuration) {
+        const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
+        super(new Configuration(), endpoint, axios);
+    }
+}

package/dist/es/index.js

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './api-model/api';
+export * from './api-model/models';

package/dist/types/api-model/api/external-fulfillment-returns-api.d.ts

@@ -0,0 +1,195 @@
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { Return } from '../models';
+import type { ReturnsResponse } from '../models';
+/**
+ * ExternalFulfillmentReturnsApi - axios parameter creator
+ */
+export declare const ExternalFulfillmentReturnsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieve the return item with the specified ID.
+     * @param {string} returnId The ID of the return item you want.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReturn: (returnId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
+     * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
+     * @param {string} [rmaId] The RMA ID of the return items you want to list.
+     * @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.
+     * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
+     * @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.
+     * @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.
+     * @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;.
+     * @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;.
+     * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
+     * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
+     * @param {number} [maxResults] The number of return items you want to include in the response.  **Default:** 10  **Maximum:** 100
+     * @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.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>;
+};
+/**
+ * ExternalFulfillmentReturnsApi - functional programming interface
+ */
+export declare const ExternalFulfillmentReturnsApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieve the return item with the specified ID.
+     * @param {string} returnId The ID of the return item you want.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReturn(returnId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Return>>;
+    /**
+     * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
+     * @param {string} [returnLocationId] The SmartConnect location ID of the location from which you want to retrieve return items.
+     * @param {string} [rmaId] The RMA ID of the return items you want to list.
+     * @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.
+     * @param {string} [reverseTrackingId] The reverse tracking ID of the return items you want to list.
+     * @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.
+     * @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.
+     * @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;.
+     * @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;.
+     * @param {string} [lastUpdatedAfter] DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
+     * @param {string} [lastUpdatedBefore] DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
+     * @param {number} [maxResults] The number of return items you want to include in the response.  **Default:** 10  **Maximum:** 100
+     * @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.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>>;
+};
+/**
+ * ExternalFulfillmentReturnsApi - factory interface
+ */
+export declare const ExternalFulfillmentReturnsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Retrieve the return item with the specified ID.
+     * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<Return>;
+    /**
+     * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
+     * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReturnsResponse>;
+};
+/**
+ * Request parameters for getReturn operation in ExternalFulfillmentReturnsApi.
+ */
+export interface ExternalFulfillmentReturnsApiGetReturnRequest {
+    /**
+     * The ID of the return item you want.
+     */
+    readonly returnId: string;
+}
+/**
+ * Request parameters for listReturns operation in ExternalFulfillmentReturnsApi.
+ */
+export interface ExternalFulfillmentReturnsApiListReturnsRequest {
+    /**
+     * The SmartConnect location ID of the location from which you want to retrieve return items.
+     */
+    readonly returnLocationId?: string;
+    /**
+     * The RMA ID of the return items you want to list.
+     */
+    readonly rmaId?: string;
+    /**
+     * The status of return items you want to list. You can retrieve all new return items with the &#x60;CREATED&#x60; status.
+     */
+    readonly status?: ListReturnsStatusEnum;
+    /**
+     * The reverse tracking ID of the return items you want to list.
+     */
+    readonly reverseTrackingId?: string;
+    /**
+     * 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.
+     */
+    readonly createdSince?: string;
+    /**
+     * 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.
+     */
+    readonly createdUntil?: string;
+    /**
+     * 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;.
+     */
+    readonly lastUpdatedSince?: string;
+    /**
+     * 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;.
+     */
+    readonly lastUpdatedUntil?: string;
+    /**
+     * DEPRECATED. Use the &#x60;createdSince&#x60; parameter.
+     */
+    readonly lastUpdatedAfter?: string;
+    /**
+     * DEPRECATED. Use the &#x60;createdUntil&#x60; parameter.
+     */
+    readonly lastUpdatedBefore?: string;
+    /**
+     * The number of return items you want to include in the response.  **Default:** 10  **Maximum:** 100
+     */
+    readonly maxResults?: number;
+    /**
+     * 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.
+     */
+    readonly nextToken?: string;
+}
+/**
+ * ExternalFulfillmentReturnsApi - object-oriented interface
+ */
+export declare class ExternalFulfillmentReturnsApi extends BaseAPI {
+    /**
+     * Retrieve the return item with the specified ID.
+     * @param {ExternalFulfillmentReturnsApiGetReturnRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReturn(requestParameters: ExternalFulfillmentReturnsApiGetReturnRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Return, any, {}>>;
+    /**
+     * Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.
+     * @param {ExternalFulfillmentReturnsApiListReturnsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listReturns(requestParameters?: ExternalFulfillmentReturnsApiListReturnsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ReturnsResponse, any, {}>>;
+}
+export declare const ListReturnsStatusEnum: {
+    readonly Created: "CREATED";
+    readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
+    readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
+    readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
+    readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
+    readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
+    readonly InTransit: "IN_TRANSIT";
+    readonly OutForDelivery: "OUT_FOR_DELIVERY";
+    readonly Delivered: "DELIVERED";
+    readonly Replanned: "REPLANNED";
+    readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
+    readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
+    readonly Processed: "PROCESSED";
+    readonly Rejected: "REJECTED";
+    readonly Cancelled: "CANCELLED";
+};
+export type ListReturnsStatusEnum = typeof ListReturnsStatusEnum[keyof typeof ListReturnsStatusEnum];

package/dist/types/api-model/api.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The Selling Partner API for Amazon External Fulfillment Return Item Processing
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from './api/external-fulfillment-returns-api';