Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    FulfillmentOutboundApi - object-oriented interface

    Hierarchy (View Summary)

    Index
    • Parameters

      • Optionalconfiguration: Configuration
      • basePath: string = BASE_PATH
      • axios: AxiosInstance = globalAxios

      Returns FulfillmentOutboundApi

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: Configuration | undefined
    • 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

      Returns Promise<AxiosResponse<object, any, {}, any>>

    • 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

      Returns Promise<AxiosResponse<CreateOrderResponse, any, {}, any>>

    • 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

      Returns Promise<AxiosResponse<GetOffersResponse, any, {}, any>>

    • 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

      Returns Promise<AxiosResponse<object, any, {}, any>>