Function FbaOutboundApiFactory

Returns {
    cancelFulfillmentOrder(
        requestParameters: FbaOutboundApiCancelFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelFulfillmentOrderResponse>;
    createFulfillmentOrder(
        requestParameters: FbaOutboundApiCreateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateFulfillmentOrderResponse>;
    createFulfillmentReturn(
        requestParameters: FbaOutboundApiCreateFulfillmentReturnRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateFulfillmentReturnResponse>;
    deliveryOffers(
        requestParameters: FbaOutboundApiDeliveryOffersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetDeliveryOffersResponse>;
    getFeatureInventory(
        requestParameters: FbaOutboundApiGetFeatureInventoryRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetFeatureInventoryResponse>;
    getFeatures(
        requestParameters: FbaOutboundApiGetFeaturesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetFeaturesResponse>;
    getFeatureSKU(
        requestParameters: FbaOutboundApiGetFeatureSKURequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetFeatureSkuResponse>;
    getFulfillmentOrder(
        requestParameters: FbaOutboundApiGetFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetFulfillmentOrderResponse>;
    getFulfillmentPreview(
        requestParameters: FbaOutboundApiGetFulfillmentPreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetFulfillmentPreviewResponse>;
    getPackageTrackingDetails(
        requestParameters: FbaOutboundApiGetPackageTrackingDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPackageTrackingDetailsResponse>;
    listAllFulfillmentOrders(
        requestParameters?: FbaOutboundApiListAllFulfillmentOrdersRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListAllFulfillmentOrdersResponse>;
    listReturnReasonCodes(
        requestParameters: FbaOutboundApiListReturnReasonCodesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListReturnReasonCodesResponse>;
    submitFulfillmentOrderStatusUpdate(
        requestParameters: FbaOutboundApiSubmitFulfillmentOrderStatusUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>;
    updateFulfillmentOrder(
        requestParameters: FbaOutboundApiUpdateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateFulfillmentOrderResponse>;
}

• cancelFulfillmentOrder:function

  • cancelFulfillmentOrder(
        requestParameters: FbaOutboundApiCancelFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiCancelFulfillmentOrderRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CancelFulfillmentOrderResponse>

    Throws

• createFulfillmentOrder:function

  • createFulfillmentOrder(
        requestParameters: FbaOutboundApiCreateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiCreateFulfillmentOrderRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateFulfillmentOrderResponse>

    Throws

• createFulfillmentReturn:function

  • createFulfillmentReturn(
        requestParameters: FbaOutboundApiCreateFulfillmentReturnRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiCreateFulfillmentReturnRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateFulfillmentReturnResponse>

    Throws

• deliveryOffers:function

  • deliveryOffers(
        requestParameters: FbaOutboundApiDeliveryOffersRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiDeliveryOffersRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetDeliveryOffersResponse>

    Throws

• getFeatureInventory:function

  • getFeatureInventory(
        requestParameters: FbaOutboundApiGetFeatureInventoryRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiGetFeatureInventoryRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetFeatureInventoryResponse>

    Throws

• getFeatures:function

  • getFeatures(
        requestParameters: FbaOutboundApiGetFeaturesRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiGetFeaturesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetFeaturesResponse>

    Throws

• getFeatureSKU:function

  • getFeatureSKU(
        requestParameters: FbaOutboundApiGetFeatureSKURequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiGetFeatureSKURequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetFeatureSkuResponse>

    Throws

• getFulfillmentOrder:function

  • getFulfillmentOrder(
        requestParameters: FbaOutboundApiGetFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiGetFulfillmentOrderRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetFulfillmentOrderResponse>

    Throws

• getFulfillmentPreview:function

  • getFulfillmentPreview(
        requestParameters: FbaOutboundApiGetFulfillmentPreviewRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiGetFulfillmentPreviewRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetFulfillmentPreviewResponse>

    Throws

• getPackageTrackingDetails:function

  • getPackageTrackingDetails(
        requestParameters: FbaOutboundApiGetPackageTrackingDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiGetPackageTrackingDetailsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetPackageTrackingDetailsResponse>

    Throws

• listAllFulfillmentOrders:function

  • listAllFulfillmentOrders(
        requestParameters?: FbaOutboundApiListAllFulfillmentOrdersRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiListAllFulfillmentOrdersRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ListAllFulfillmentOrdersResponse>

    Throws

• listReturnReasonCodes:function

  • listReturnReasonCodes(
        requestParameters: FbaOutboundApiListReturnReasonCodesRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiListReturnReasonCodesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ListReturnReasonCodesResponse>

    Throws

• submitFulfillmentOrderStatusUpdate:function

  • submitFulfillmentOrderStatusUpdate(
        requestParameters: FbaOutboundApiSubmitFulfillmentOrderStatusUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiSubmitFulfillmentOrderStatusUpdateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SubmitFulfillmentOrderStatusUpdateResponse>

    Throws

• updateFulfillmentOrder:function

  • updateFulfillmentOrder(
        requestParameters: FbaOutboundApiUpdateFulfillmentOrderRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: FbaOutboundApiUpdateFulfillmentOrderRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UpdateFulfillmentOrderResponse>

    Throws