Function FbaOutboundApiFp

Returns {
    cancelFulfillmentOrder(
        sellerFulfillmentOrderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelFulfillmentOrderResponse>,
    >;
    createFulfillmentOrder(
        body: CreateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFulfillmentOrderResponse>,
    >;
    createFulfillmentReturn(
        sellerFulfillmentOrderId: string,
        body: CreateFulfillmentReturnRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFulfillmentReturnResponse>,
    >;
    deliveryOffers(
        body: GetDeliveryOffersRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetDeliveryOffersResponse>,
    >;
    getFeatureInventory(
        marketplaceId: string,
        featureName: string,
        nextToken?: string,
        queryStartDate?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeatureInventoryResponse>,
    >;
    getFeatures(
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeaturesResponse>,
    >;
    getFeatureSKU(
        marketplaceId: string,
        featureName: string,
        sellerSku: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeatureSkuResponse>,
    >;
    getFulfillmentOrder(
        sellerFulfillmentOrderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFulfillmentOrderResponse>,
    >;
    getFulfillmentPreview(
        body: GetFulfillmentPreviewRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFulfillmentPreviewResponse>,
    >;
    getPackageTrackingDetails(
        packageNumber: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPackageTrackingDetailsResponse>,
    >;
    listAllFulfillmentOrders(
        queryStartDate?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListAllFulfillmentOrdersResponse>,
    >;
    listReturnReasonCodes(
        sellerSku: string,
        marketplaceId?: string,
        sellerFulfillmentOrderId?: string,
        language?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListReturnReasonCodesResponse>,
    >;
    submitFulfillmentOrderStatusUpdate(
        sellerFulfillmentOrderId: string,
        body: SubmitFulfillmentOrderStatusUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>,
    >;
    updateFulfillmentOrder(
        sellerFulfillmentOrderId: string,
        body: UpdateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateFulfillmentOrderResponse>,
    >;
}

• cancelFulfillmentOrder:function

  • cancelFulfillmentOrder(
        sellerFulfillmentOrderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelFulfillmentOrderResponse>,
    >

  • 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.

    Parameters

    • sellerFulfillmentOrderId: string

      The identifier assigned to the item by the seller when the fulfillment order was created.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CancelFulfillmentOrderResponse>,
    >

    Throws

• createFulfillmentOrder:function

  • createFulfillmentOrder(
        body: CreateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFulfillmentOrderResponse>,
    >

  • 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

    Parameters

    • body: CreateFulfillmentOrderRequest

      CreateFulfillmentOrderRequest parameter
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFulfillmentOrderResponse>,
    >

    Throws

• createFulfillmentReturn:function

  • createFulfillmentReturn(
        sellerFulfillmentOrderId: string,
        body: CreateFulfillmentReturnRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFulfillmentReturnResponse>,
    >

  • 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.

    Parameters

    • sellerFulfillmentOrderId: string

      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&#39;s request to return items.
    • body: CreateFulfillmentReturnRequest

      CreateFulfillmentReturnRequest parameter
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateFulfillmentReturnResponse>,
    >

    Throws

• deliveryOffers:function

  • deliveryOffers(
        body: GetDeliveryOffersRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetDeliveryOffersResponse>,
    >

  • 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.

    Parameters

    • body: GetDeliveryOffersRequest

      GetDeliveryOffersRequest parameter
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetDeliveryOffersResponse>,
    >

    Throws

• getFeatureInventory:function

  • getFeatureInventory(
        marketplaceId: string,
        featureName: string,
        nextToken?: string,
        queryStartDate?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeatureInventoryResponse>,
    >

  • 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..

    Parameters

    • marketplaceId: string

      The marketplace for which to return a list of the inventory that is eligible for the specified feature.
    • featureName: string

      The name of the feature for which to return a list of eligible inventory.
    • OptionalnextToken: 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.
    • OptionalqueryStartDate: 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
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeatureInventoryResponse>,
    >

    Throws

• getFeatures:function

  • getFeatures(
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeaturesResponse>,
    >

  • 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.

    Parameters

    • marketplaceId: string

      The marketplace for which to return the list of features.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeaturesResponse>,
    >

    Throws

• getFeatureSKU:function

  • getFeatureSKU(
        marketplaceId: string,
        featureName: string,
        sellerSku: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeatureSkuResponse>,
    >

  • 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. 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.

    Parameters

    • marketplaceId: string

      The marketplace for which to return the count.
    • featureName: string

      The name of the feature.
    • sellerSku: string

      Used to identify an item in the given marketplace. `SellerSKU` is qualified by the seller&#39;s `SellerId`, which is included with every operation that you submit.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFeatureSkuResponse>,
    >

    Throws

• getFulfillmentOrder:function

  • getFulfillmentOrder(
        sellerFulfillmentOrderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFulfillmentOrderResponse>,
    >

  • 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.

    Parameters

    • sellerFulfillmentOrderId: string

      The identifier assigned to the item by the seller when the fulfillment order was created.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFulfillmentOrderResponse>,
    >

    Throws

• getFulfillmentPreview:function

  • getFulfillmentPreview(
        body: GetFulfillmentPreviewRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFulfillmentPreviewResponse>,
    >

  • 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.

    Parameters

    • body: GetFulfillmentPreviewRequest

      GetFulfillmentPreviewRequest parameter
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetFulfillmentPreviewResponse>,
    >

    Throws

• getPackageTrackingDetails:function

  • getPackageTrackingDetails(
        packageNumber: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPackageTrackingDetailsResponse>,
    >

  • 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.

    Parameters

    • packageNumber: number

      The unencrypted package identifier returned by the `getFulfillmentOrder` operation.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetPackageTrackingDetailsResponse>,
    >

    Throws

• listAllFulfillmentOrders:function

  • listAllFulfillmentOrders(
        queryStartDate?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListAllFulfillmentOrdersResponse>,
    >

  • 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

    Parameters

    • OptionalqueryStartDate: string

      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.
    • OptionalnextToken: string

      A string token returned in the response to your previous request.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListAllFulfillmentOrdersResponse>,
    >

    Throws

• listReturnReasonCodes:function

  • listReturnReasonCodes(
        sellerSku: string,
        marketplaceId?: string,
        sellerFulfillmentOrderId?: string,
        language?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListReturnReasonCodesResponse>,
    >

  • 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. 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.

    Parameters

    • sellerSku: string

      The seller SKU for which return reason codes are required.
    • OptionalmarketplaceId: string

      The marketplace for which the seller wants return reason codes.
    • OptionalsellerFulfillmentOrderId: 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.
    • Optionallanguage: string

      The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListReturnReasonCodesResponse>,
    >

    Throws

• submitFulfillmentOrderStatusUpdate:function

  • submitFulfillmentOrderStatusUpdate(
        sellerFulfillmentOrderId: string,
        body: SubmitFulfillmentOrderStatusUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>,
    >

  • 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 and Selling Partner API sandbox for more information.

    Parameters

    • sellerFulfillmentOrderId: string

      The identifier assigned to the item by the seller when the fulfillment order was created.
    • body: SubmitFulfillmentOrderStatusUpdateRequest

      The identifier assigned to the item by the seller when the fulfillment order was created.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>,
    >

    Throws

• updateFulfillmentOrder:function

  • updateFulfillmentOrder(
        sellerFulfillmentOrderId: string,
        body: UpdateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateFulfillmentOrderResponse>,
    >

  • 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.

    Parameters

    • sellerFulfillmentOrderId: string

      The identifier assigned to the item by the seller when the fulfillment order was created.
    • body: UpdateFulfillmentOrderRequest

      UpdateFulfillmentOrderRequest parameter
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateFulfillmentOrderResponse>,
    >

    Throws