Function FbaInboundApiFactory

Returns {
    confirmPreorder(
        requestParameters: FbaInboundApiConfirmPreorderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPreorderResponse>;
    confirmTransport(
        requestParameters: FbaInboundApiConfirmTransportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmTransportResponse>;
    createInboundShipment(
        requestParameters: FbaInboundApiCreateInboundShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundShipmentResponse>;
    createInboundShipmentPlan(
        requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateInboundShipmentPlanResponse>;
    estimateTransport(
        requestParameters: FbaInboundApiEstimateTransportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EstimateTransportResponse>;
    getBillOfLading(
        requestParameters: FbaInboundApiGetBillOfLadingRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetBillOfLadingResponse>;
    getLabels(
        requestParameters: FbaInboundApiGetLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetLabelsResponse>;
    getPreorderInfo(
        requestParameters: FbaInboundApiGetPreorderInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPreorderInfoResponse>;
    getPrepInstructions(
        requestParameters: FbaInboundApiGetPrepInstructionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPrepInstructionsResponse>;
    getShipmentItems(
        requestParameters: FbaInboundApiGetShipmentItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentItemsResponse>;
    getShipmentItemsByShipmentId(
        requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentItemsResponse>;
    getShipments(
        requestParameters: FbaInboundApiGetShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentsResponse>;
    getTransportDetails(
        requestParameters: FbaInboundApiGetTransportDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetTransportDetailsResponse>;
    putTransportDetails(
        requestParameters: FbaInboundApiPutTransportDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PutTransportDetailsResponse>;
    updateInboundShipment(
        requestParameters: FbaInboundApiUpdateInboundShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundShipmentResponse>;
    voidTransport(
        requestParameters: FbaInboundApiVoidTransportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VoidTransportResponse>;
}

• confirmPreorder:function

  • confirmPreorder(
        requestParameters: FbaInboundApiConfirmPreorderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmPreorderResponse>

  • Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. 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 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

    • requestParameters: FbaInboundApiConfirmPreorderRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ConfirmPreorderResponse>

    Deprecated

    Throws

• confirmTransport:function

  • confirmTransport(
        requestParameters: FbaInboundApiConfirmTransportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfirmTransportResponse>

  • Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost. 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 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

    • requestParameters: FbaInboundApiConfirmTransportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ConfirmTransportResponse>

    Deprecated

    Throws

• createInboundShipment:function

  • createInboundShipment(
        requestParameters: FbaInboundApiCreateInboundShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundShipmentResponse>

  • Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. 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 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

    • requestParameters: FbaInboundApiCreateInboundShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<InboundShipmentResponse>

    Deprecated

    Throws

• createInboundShipmentPlan:function

  • createInboundShipmentPlan(
        requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateInboundShipmentPlanResponse>

  • Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. 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 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

    • requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateInboundShipmentPlanResponse>

    Deprecated

    Throws

• estimateTransport:function

  • estimateTransport(
        requestParameters: FbaInboundApiEstimateTransportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EstimateTransportResponse>

  • Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. 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 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

    • requestParameters: FbaInboundApiEstimateTransportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EstimateTransportResponse>

    Deprecated

    Throws

• getBillOfLading:function

  • getBillOfLading(
        requestParameters: FbaInboundApiGetBillOfLadingRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetBillOfLadingResponse>

  • Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. 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 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

    • requestParameters: FbaInboundApiGetBillOfLadingRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetBillOfLadingResponse>

    Throws

• getLabels:function

  • getLabels(
        requestParameters: FbaInboundApiGetLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetLabelsResponse>

  • Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. 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 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

    • requestParameters: FbaInboundApiGetLabelsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetLabelsResponse>

    Throws

• getPreorderInfo:function

  • getPreorderInfo(
        requestParameters: FbaInboundApiGetPreorderInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPreorderInfoResponse>

  • Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-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 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

    • requestParameters: FbaInboundApiGetPreorderInfoRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetPreorderInfoResponse>

    Deprecated

    Throws

• getPrepInstructions:function

  • getPrepInstructions(
        requestParameters: FbaInboundApiGetPrepInstructionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPrepInstructionsResponse>

  • Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. 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 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

    • requestParameters: FbaInboundApiGetPrepInstructionsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetPrepInstructionsResponse>

    Throws

• getShipmentItems:function

  • getShipmentItems(
        requestParameters: FbaInboundApiGetShipmentItemsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentItemsResponse>

  • Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. 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 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

    • requestParameters: FbaInboundApiGetShipmentItemsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentItemsResponse>

    Throws

• getShipmentItemsByShipmentId:function

  • getShipmentItemsByShipmentId(
        requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentItemsResponse>

  • Returns a list of items in a specified inbound shipment. 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 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

    • requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentItemsResponse>

    Throws

• getShipments:function

  • getShipments(
        requestParameters: FbaInboundApiGetShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentsResponse>

  • Returns a list of inbound shipments based on 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 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

    • requestParameters: FbaInboundApiGetShipmentsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentsResponse>

    Throws

• getTransportDetails:function

  • getTransportDetails(
        requestParameters: FbaInboundApiGetTransportDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetTransportDetailsResponse>

  • Returns current transportation information about an inbound shipment. 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 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

    • requestParameters: FbaInboundApiGetTransportDetailsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetTransportDetailsResponse>

    Deprecated

    Throws

• putTransportDetails:function

  • putTransportDetails(
        requestParameters: FbaInboundApiPutTransportDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PutTransportDetailsResponse>

  • Sends transportation information to Amazon about an inbound shipment. 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 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

    • requestParameters: FbaInboundApiPutTransportDetailsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PutTransportDetailsResponse>

    Deprecated

    Throws

• updateInboundShipment:function

  • updateInboundShipment(
        requestParameters: FbaInboundApiUpdateInboundShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InboundShipmentResponse>

  • Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. 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 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

    • requestParameters: FbaInboundApiUpdateInboundShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<InboundShipmentResponse>

    Deprecated

    Throws

• voidTransport:function

  • voidTransport(
        requestParameters: FbaInboundApiVoidTransportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VoidTransportResponse>

  • Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. 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 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

    • requestParameters: FbaInboundApiVoidTransportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<VoidTransportResponse>

    Deprecated

    Throws