Function FulfillmentOutboundApiFp

Returns {
    cancelOrder(
        orderId: string,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >;
    createOrder(
        body: CreateOrderRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateOrderResponse>,
    >;
    getOffers(
        body: GetOffersRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOffersResponse>,
    >;
    getOrder(
        orderId: string,
        xAmznFulfillmentServiceId?: string,
        shipments?: GetOrderShipmentsEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderResponse>,
    >;
    getOrderPreview(
        body: GetOrderPreviewRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderPreviewResponse>,
    >;
    listOrders(
        xAmznFulfillmentServiceId?: string,
        updatedAfter?: string,
        pageToken?: string,
        shipments?: ListOrdersShipmentsEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListOrdersResponse>,
    >;
    updateOrder(
        orderId: string,
        body: UpdateOrderRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >;
    updateOrderStatus(
        orderId: string,
        body: UpdateOrderStatusRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updatePackage(
        orderId: string,
        packageId: string,
        body: UpdatePackageRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• cancelOrder: function

  • cancelOrder(
        orderId: string,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >

    Request that Amazon stop attempting to fulfill a 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • orderId: string

      The ID of the order that you want to cancel.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createOrder: function

  • createOrder(
        body: CreateOrderRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateOrderResponse>,
    >

    Request 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • body: CreateOrderRequest

      The request body schema for the `createOrder` operation.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOffers: function

  • getOffers(
        body: GetOffersRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOffersResponse>,
    >

    Retrieve 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • body: GetOffersRequest

      The request body schema for the `getOffers` operation.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrder: function

  • getOrder(
        orderId: string,
        xAmznFulfillmentServiceId?: string,
        shipments?: GetOrderShipmentsEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderResponse>,
    >

    Retrieve a 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • orderId: string

      The ID of the order you want to retrieve.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionalshipments: GetOrderShipmentsEnum

      Whether to include shipment data in the response. Included by default.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getOrderPreview: function

  • getOrderPreview(
        body: GetOrderPreviewRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetOrderPreviewResponse>,
    >

    Retrieve 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • body: GetOrderPreviewRequest

      The request body schema for the `getOrderPreview` operation.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listOrders: function

  • listOrders(
        xAmznFulfillmentServiceId?: string,
        updatedAfter?: string,
        pageToken?: string,
        shipments?: ListOrdersShipmentsEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListOrdersResponse>,
    >

    Retrieve a list of fulfillment orders that match the criteria 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • OptionalupdatedAfter: string

      The response includes orders updated after this time. Must be in ISO 8601 format.

    • OptionalpageToken: string

      A token that you use to retrieve the next page of results. The response includes `pageToken` when the number of results exceeds the page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `pageToken` is `null`.

    • Optionalshipments: ListOrdersShipmentsEnum

      Whether to include shipment data in the response. Included by default.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateOrder: function

  • updateOrder(
        orderId: string,
        body: UpdateOrderRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>,
    >

    Update and/or request 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • orderId: string

      The ID of the order that you want to update and/or request shipment of.

    • body: UpdateOrderRequest

      The request body schema for the `updateOrder` operation.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateOrderStatus: function

  • updateOrderStatus(
        orderId: string,
        body: UpdateOrderStatusRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Request 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

    • orderId: string

      The ID of the order that you want to update.

    • body: UpdateOrderStatusRequest

      The new status of the fulfillment order.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updatePackage: function

  • updatePackage(
        orderId: string,
        packageId: string,
        body: UpdatePackageRequest,
        xAmznFulfillmentServiceId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Update package information for a specific package in a fulfillment order. 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

    • orderId: string

      The ID of the order that contains the package that you want to update.

    • packageId: string

      The ID of the package that you want to update.

    • body: UpdatePackageRequest

      The new package information.

    • OptionalxAmznFulfillmentServiceId: string

      The identifier of the fulfillment service used for this operation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws