Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...
    • FulfillmentOutboundApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          cancelOrder: (
              orderId: string,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          createOrder: (
              body: CreateOrderRequest,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getOffers: (
              body: GetOffersRequest,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getOrder: (
              orderId: string,
              xAmznFulfillmentServiceId?: string,
              shipments?: GetOrderShipmentsEnum,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getOrderPreview: (
              body: GetOrderPreviewRequest,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listOrders: (
              xAmznFulfillmentServiceId?: string,
              updatedAfter?: string,
              pageToken?: string,
              shipments?: ListOrdersShipmentsEnum,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          updateOrder: (
              orderId: string,
              body: UpdateOrderRequest,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          updateOrderStatus: (
              orderId: string,
              body: UpdateOrderStatusRequest,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          updatePackage: (
              orderId: string,
              packageId: string,
              body: UpdatePackageRequest,
              xAmznFulfillmentServiceId?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • cancelOrder: (
            orderId: string,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • createOrder: (
            body: CreateOrderRequest,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • getOffers: (
            body: GetOffersRequest,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • getOrder: (
            orderId: string,
            xAmznFulfillmentServiceId?: string,
            shipments?: GetOrderShipmentsEnum,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • getOrderPreview: (
            body: GetOrderPreviewRequest,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • listOrders: (
            xAmznFulfillmentServiceId?: string,
            updatedAfter?: string,
            pageToken?: string,
            shipments?: ListOrdersShipmentsEnum,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • updateOrder: (
            orderId: string,
            body: UpdateOrderRequest,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • updateOrderStatus: (
            orderId: string,
            body: UpdateOrderStatusRequest,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • updatePackage: (
            orderId: string,
            packageId: string,
            body: UpdatePackageRequest,
            xAmznFulfillmentServiceId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.