@sp-api-sdk/fulfillment-outbound-api-2020-07-01
Version:
The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfill
746 lines • 81.3 kB
TypeScript
/**
* Selling Partner APIs for Fulfillment Outbound
* The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon\'s fulfillment network. You can get information on both potential and existing fulfillment orders.
*
* The version of the OpenAPI document: 2020-07-01
*
*
* 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 { CancelFulfillmentOrderResponse } from '../models';
import type { CreateFulfillmentOrderRequest } from '../models';
import type { CreateFulfillmentOrderResponse } from '../models';
import type { CreateFulfillmentReturnRequest } from '../models';
import type { CreateFulfillmentReturnResponse } from '../models';
import type { GetDeliveryOffersRequest } from '../models';
import type { GetDeliveryOffersResponse } from '../models';
import type { GetFeatureInventoryResponse } from '../models';
import type { GetFeatureSkuResponse } from '../models';
import type { GetFeaturesResponse } from '../models';
import type { GetFulfillmentOrderResponse } from '../models';
import type { GetFulfillmentPreviewRequest } from '../models';
import type { GetFulfillmentPreviewResponse } from '../models';
import type { GetPackageTrackingDetailsResponse } from '../models';
import type { ListAllFulfillmentOrdersResponse } from '../models';
import type { ListReturnReasonCodesResponse } from '../models';
import type { SubmitFulfillmentOrderStatusUpdateRequest } from '../models';
import type { SubmitFulfillmentOrderStatusUpdateResponse } from '../models';
import type { UpdateFulfillmentOrderRequest } from '../models';
import type { UpdateFulfillmentOrderResponse } from '../models';
/**
* FulfillmentOutboundApi - axios parameter creator
* @export
*/
export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelFulfillmentOrder: (sellerFulfillmentOrderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFulfillmentOrder: (body: CreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items.
* @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFulfillmentReturn: (sellerFulfillmentOrderId: string, body: CreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deliveryOffers: (body: GetDeliveryOffersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
* @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature.
* @param {string} featureName The name of the feature for which to return a list of eligible inventory.
* @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
* @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatureInventory: (marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} marketplaceId The marketplace for which to return the count.
* @param {string} featureName The name of the feature.
* @param {string} sellerSku Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatureSKU: (marketplaceId: string, featureName: string, sellerSku: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} marketplaceId The marketplace for which to return the list of features.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatures: (marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFulfillmentOrder: (sellerFulfillmentOrderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFulfillmentPreview: (body: GetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {number} packageNumber The unencrypted package identifier returned by the `getFulfillmentOrder` operation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackageTrackingDetails: (packageNumber: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
* @param {string} [nextToken] A string token returned in the response to your previous request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listAllFulfillmentOrders: (queryStartDate?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerSku The seller SKU for which return reason codes are required.
* @param {string} [marketplaceId] The marketplace for which the seller wants return reason codes.
* @param {string} [sellerFulfillmentOrderId] The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.
* @param {string} [language] The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listReturnReasonCodes: (sellerSku: string, marketplaceId?: string, sellerFulfillmentOrderId?: string, language?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {SubmitFulfillmentOrderStatusUpdateRequest} body The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
submitFulfillmentOrderStatusUpdate: (sellerFulfillmentOrderId: string, body: SubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFulfillmentOrder: (sellerFulfillmentOrderId: string, body: UpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* FulfillmentOutboundApi - functional programming interface
* @export
*/
export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) => {
/**
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelFulfillmentOrder(sellerFulfillmentOrderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelFulfillmentOrderResponse>>;
/**
* Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {CreateFulfillmentOrderRequest} body CreateFulfillmentOrderRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFulfillmentOrder(body: CreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFulfillmentOrderResponse>>;
/**
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items.
* @param {CreateFulfillmentReturnRequest} body CreateFulfillmentReturnRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFulfillmentReturn(sellerFulfillmentOrderId: string, body: CreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFulfillmentReturnResponse>>;
/**
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deliveryOffers(body: GetDeliveryOffersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeliveryOffersResponse>>;
/**
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
* @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature.
* @param {string} featureName The name of the feature for which to return a list of eligible inventory.
* @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
* @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatureInventory(marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeatureInventoryResponse>>;
/**
* Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} marketplaceId The marketplace for which to return the count.
* @param {string} featureName The name of the feature.
* @param {string} sellerSku Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatureSKU(marketplaceId: string, featureName: string, sellerSku: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeatureSkuResponse>>;
/**
* Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} marketplaceId The marketplace for which to return the list of features.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatures(marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeaturesResponse>>;
/**
* Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFulfillmentOrder(sellerFulfillmentOrderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFulfillmentOrderResponse>>;
/**
* Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {GetFulfillmentPreviewRequest} body GetFulfillmentPreviewRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFulfillmentPreview(body: GetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFulfillmentPreviewResponse>>;
/**
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {number} packageNumber The unencrypted package identifier returned by the `getFulfillmentOrder` operation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackageTrackingDetails(packageNumber: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackageTrackingDetailsResponse>>;
/**
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
* @param {string} [nextToken] A string token returned in the response to your previous request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listAllFulfillmentOrders(queryStartDate?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAllFulfillmentOrdersResponse>>;
/**
* Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerSku The seller SKU for which return reason codes are required.
* @param {string} [marketplaceId] The marketplace for which the seller wants return reason codes.
* @param {string} [sellerFulfillmentOrderId] The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.
* @param {string} [language] The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listReturnReasonCodes(sellerSku: string, marketplaceId?: string, sellerFulfillmentOrderId?: string, language?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListReturnReasonCodesResponse>>;
/**
* Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {SubmitFulfillmentOrderStatusUpdateRequest} body The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
submitFulfillmentOrderStatusUpdate(sellerFulfillmentOrderId: string, body: SubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>>;
/**
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
* @param {UpdateFulfillmentOrderRequest} body UpdateFulfillmentOrderRequest parameter
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFulfillmentOrder(sellerFulfillmentOrderId: string, body: UpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFulfillmentOrderResponse>>;
};
/**
* FulfillmentOutboundApi - factory interface
* @export
*/
export declare const FulfillmentOutboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelFulfillmentOrder(requestParameters: FulfillmentOutboundApiCancelFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelFulfillmentOrderResponse>;
/**
* Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {FulfillmentOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFulfillmentOrder(requestParameters: FulfillmentOutboundApiCreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFulfillmentOrderResponse>;
/**
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFulfillmentReturn(requestParameters: FulfillmentOutboundApiCreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFulfillmentReturnResponse>;
/**
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deliveryOffers(requestParameters: FulfillmentOutboundApiDeliveryOffersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryOffersResponse>;
/**
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
* @param {FulfillmentOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatureInventory(requestParameters: FulfillmentOutboundApiGetFeatureInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeatureInventoryResponse>;
/**
* Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatureSKU(requestParameters: FulfillmentOutboundApiGetFeatureSKURequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeatureSkuResponse>;
/**
* Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFeaturesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeatures(requestParameters: FulfillmentOutboundApiGetFeaturesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeaturesResponse>;
/**
* Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFulfillmentOrder(requestParameters: FulfillmentOutboundApiGetFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFulfillmentOrderResponse>;
/**
* Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFulfillmentPreview(requestParameters: FulfillmentOutboundApiGetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFulfillmentPreviewResponse>;
/**
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPackageTrackingDetails(requestParameters: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackageTrackingDetailsResponse>;
/**
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listAllFulfillmentOrders(requestParameters?: FulfillmentOutboundApiListAllFulfillmentOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListAllFulfillmentOrdersResponse>;
/**
* Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listReturnReasonCodes(requestParameters: FulfillmentOutboundApiListReturnReasonCodesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListReturnReasonCodesResponse>;
/**
* Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
* @param {FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
submitFulfillmentOrderStatusUpdate(requestParameters: FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>;
/**
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFulfillmentOrder(requestParameters: FulfillmentOutboundApiUpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateFulfillmentOrderResponse>;
};
/**
* Request parameters for cancelFulfillmentOrder operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiCancelFulfillmentOrderRequest
*/
export interface FulfillmentOutboundApiCancelFulfillmentOrderRequest {
/**
* The identifier assigned to the item by the seller when the fulfillment order was created.
* @type {string}
* @memberof FulfillmentOutboundApiCancelFulfillmentOrder
*/
readonly sellerFulfillmentOrderId: string;
}
/**
* Request parameters for createFulfillmentOrder operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiCreateFulfillmentOrderRequest
*/
export interface FulfillmentOutboundApiCreateFulfillmentOrderRequest {
/**
* CreateFulfillmentOrderRequest parameter
* @type {CreateFulfillmentOrderRequest}
* @memberof FulfillmentOutboundApiCreateFulfillmentOrder
*/
readonly body: CreateFulfillmentOrderRequest;
}
/**
* Request parameters for createFulfillmentReturn operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiCreateFulfillmentReturnRequest
*/
export interface FulfillmentOutboundApiCreateFulfillmentReturnRequest {
/**
* An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct `SellerFulfillmentOrderId` value based on the buyer\'s request to return items.
* @type {string}
* @memberof FulfillmentOutboundApiCreateFulfillmentReturn
*/
readonly sellerFulfillmentOrderId: string;
/**
* CreateFulfillmentReturnRequest parameter
* @type {CreateFulfillmentReturnRequest}
* @memberof FulfillmentOutboundApiCreateFulfillmentReturn
*/
readonly body: CreateFulfillmentReturnRequest;
}
/**
* Request parameters for deliveryOffers operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiDeliveryOffersRequest
*/
export interface FulfillmentOutboundApiDeliveryOffersRequest {
/**
* GetDeliveryOffersRequest parameter
* @type {GetDeliveryOffersRequest}
* @memberof FulfillmentOutboundApiDeliveryOffers
*/
readonly body: GetDeliveryOffersRequest;
}
/**
* Request parameters for getFeatureInventory operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiGetFeatureInventoryRequest
*/
export interface FulfillmentOutboundApiGetFeatureInventoryRequest {
/**
* The marketplace for which to return a list of the inventory that is eligible for the specified feature.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureInventory
*/
readonly marketplaceId: string;
/**
* The name of the feature for which to return a list of eligible inventory.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureInventory
*/
readonly featureName: string;
/**
* A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureInventory
*/
readonly nextToken?: string;
/**
* A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureInventory
*/
readonly queryStartDate?: string;
}
/**
* Request parameters for getFeatureSKU operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiGetFeatureSKURequest
*/
export interface FulfillmentOutboundApiGetFeatureSKURequest {
/**
* The marketplace for which to return the count.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureSKU
*/
readonly marketplaceId: string;
/**
* The name of the feature.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureSKU
*/
readonly featureName: string;
/**
* Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller\'s `SellerId`, which is included with every operation that you submit.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatureSKU
*/
readonly sellerSku: string;
}
/**
* Request parameters for getFeatures operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiGetFeaturesRequest
*/
export interface FulfillmentOutboundApiGetFeaturesRequest {
/**
* The marketplace for which to return the list of features.
* @type {string}
* @memberof FulfillmentOutboundApiGetFeatures
*/
readonly marketplaceId: string;
}
/**
* Request parameters for getFulfillmentOrder operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiGetFulfillmentOrderRequest
*/
export interface FulfillmentOutboundApiGetFulfillmentOrderRequest {
/**
* The identifier assigned to the item by the seller when the fulfillment order was created.
* @type {string}
* @memberof FulfillmentOutboundApiGetFulfillmentOrder
*/
readonly sellerFulfillmentOrderId: string;
}
/**
* Request parameters for getFulfillmentPreview operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiGetFulfillmentPreviewRequest
*/
export interface FulfillmentOutboundApiGetFulfillmentPreviewRequest {
/**
* GetFulfillmentPreviewRequest parameter
* @type {GetFulfillmentPreviewRequest}
* @memberof FulfillmentOutboundApiGetFulfillmentPreview
*/
readonly body: GetFulfillmentPreviewRequest;
}
/**
* Request parameters for getPackageTrackingDetails operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest
*/
export interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest {
/**
* The unencrypted package identifier returned by the `getFulfillmentOrder` operation.
* @type {number}
* @memberof FulfillmentOutboundApiGetPackageTrackingDetails
*/
readonly packageNumber: number;
}
/**
* Request parameters for listAllFulfillmentOrders operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiListAllFulfillmentOrdersRequest
*/
export interface FulfillmentOutboundApiListAllFulfillmentOrdersRequest {
/**
* A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
* @type {string}
* @memberof FulfillmentOutboundApiListAllFulfillmentOrders
*/
readonly queryStartDate?: string;
/**
* A string token returned in the response to your previous request.
* @type {string}
* @memberof FulfillmentOutboundApiListAllFulfillmentOrders
*/
readonly nextToken?: string;
}
/**
* Request parameters for listReturnReasonCodes operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiListReturnReasonCodesRequest
*/
export interface FulfillmentOutboundApiListReturnReasonCodesRequest {
/**
* The seller SKU for which return reason codes are required.
* @type {string}
* @memberof FulfillmentOutboundApiListReturnReasonCodes
*/
readonly sellerSku: string;
/**
* The marketplace for which the seller wants return reason codes.
* @type {string}
* @memberof FulfillmentOutboundApiListReturnReasonCodes
*/
readonly marketplaceId?: string;
/**
* The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.
* @type {string}
* @memberof FulfillmentOutboundApiListReturnReasonCodes
*/
readonly sellerFulfillmentOrderId?: string;
/**
* The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.
* @type {string}
* @memberof FulfillmentOutboundApiListReturnReasonCodes
*/
readonly language?: string;
}
/**
* Request parameters for submitFulfillmentOrderStatusUpdate operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest
*/
export interface FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest {
/**
* The identifier assigned to the item by the seller when the fulfillment order was created.
* @type {string}
* @memberof FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdate
*/
readonly sellerFulfillmentOrderId: string;
/**
* The identifier assigned to the item by the seller when the fulfillment order was created.
* @type {SubmitFulfillmentOrderStatusUpdateRequest}
* @memberof FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdate
*/
readonly body: SubmitFulfillmentOrderStatusUpdateRequest;
}
/**
* Request parameters for updateFulfillmentOrder operation in FulfillmentOutboundApi.
* @export
* @interface FulfillmentOutboundApiUpdateFulfillmentOrderRequest
*/
export interface FulfillmentOutboundApiUpdateFulfillmentOrderRequest {
/**
* The identifier assigned to the item by the seller when the fulfillment order was created.
* @type {string}
* @memberof FulfillmentOutboundApiUpdateFulfillmentOrder
*/
readonly sellerFulfillmentOrderId: string;
/**
* UpdateFulfillmentOrderRequest parameter
* @type {UpdateFulfillmentOrderRequest}
* @memberof FulfillmentOutboundApiUpdateFulfillmentOrder
*/
readonly body: UpdateFulfillmentOrderRequest;
}
/**
* FulfillmentOutboundApi - object-oriented interface
* @export
* @class FulfillmentOutboundApi
* @extends {BaseAPI}
*/
export declare class FulfillmentOutboundApi extends BaseAPI {
/**
* Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
cancelFulfillmentOrder(requestParameters: FulfillmentOutboundApiCancelFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelFulfillmentOrderResponse, any>>;
/**
* Requests that Amazon ship items from the seller\'s inventory in Amazon\'s fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {FulfillmentOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
createFulfillmentOrder(requestParameters: FulfillmentOutboundApiCreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFulfillmentOrderResponse, any>>;
/**
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
createFulfillmentReturn(requestParameters: FulfillmentOutboundApiCreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFulfillmentReturnResponse, any>>;
/**
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
deliveryOffers(requestParameters: FulfillmentOutboundApiDeliveryOffersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDeliveryOffersResponse, any>>;
/**
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
* @param {FulfillmentOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
getFeatureInventory(requestParameters: FulfillmentOutboundApiGetFeatureInventoryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeatureInventoryResponse, any>>;
/**
* Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn\'t eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
getFeatureSKU(requestParameters: FulfillmentOutboundApiGetFeatureSKURequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeatureSkuResponse, any>>;
/**
* Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFeaturesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
getFeatures(requestParameters: FulfillmentOutboundApiGetFeaturesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeaturesResponse, any>>;
/**
* Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
getFulfillmentOrder(requestParameters: FulfillmentOutboundApiGetFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFulfillmentOrderResponse, any>>;
/**
* Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
getFulfillmentPreview(requestParameters: FulfillmentOutboundApiGetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFulfillmentPreviewResponse, any>>;
/**
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
getPackageTrackingDetails(requestParameters: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackageTrackingDetailsResponse, any>>;
/**
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
listAllFulfillmentOrders(requestParameters?: FulfillmentOutboundApiListAllFulfillmentOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListAllFulfillmentOrdersResponse, any>>;
/**
* Returns a list of return reason codes for a seller SKU in a given marketplace. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
listReturnReasonCodes(requestParameters: FulfillmentOutboundApiListReturnReasonCodesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListReturnReasonCodesResponse, any>>;
/**
* Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.
* @param {FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
submitFulfillmentOrderStatusUpdate(requestParameters: FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitFulfillmentOrderStatusUpdateResponse, any>>;
/**
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
* @param {FulfillmentOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FulfillmentOutboundApi
*/
updateFulfillmentOrder(requestParameters: FulfillmentOutboundApiUpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateFulfillmentOrderResponse, any>>;
}