Class FbaInboundApi

FbaInboundApi - object-oriented interface

Export

FbaInboundApi

Hierarchy (View Summary, Expand)

Constructors

constructor

Methods

getBillOfLading getLabels getPrepInstructions getShipmentItems getShipmentItemsByShipmentId getShipments

Constructors

constructor

  • new FbaInboundApi(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): FbaInboundApi

    Parameters

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

    Returns FbaInboundApi

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

getBillOfLading

  • getBillOfLading(
        requestParameters: FbaInboundApiGetBillOfLadingRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetBillOfLadingResponse, any>>

    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

    Returns Promise<AxiosResponse<GetBillOfLadingResponse, any>>

    Throws

    Memberof

    FbaInboundApi

getLabels

  • getLabels(
        requestParameters: FbaInboundApiGetLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetLabelsResponse, any>>

    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

    Returns Promise<AxiosResponse<GetLabelsResponse, any>>

    Throws

    Memberof

    FbaInboundApi

getPrepInstructions

  • getPrepInstructions(
        requestParameters: FbaInboundApiGetPrepInstructionsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetPrepInstructionsResponse, any>>

    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

    Returns Promise<AxiosResponse<GetPrepInstructionsResponse, any>>

    Throws

    Memberof

    FbaInboundApi

getShipmentItems

  • getShipmentItems(
        requestParameters: FbaInboundApiGetShipmentItemsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetShipmentItemsResponse, any>>

    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

    Returns Promise<AxiosResponse<GetShipmentItemsResponse, any>>

    Throws

    Memberof

    FbaInboundApi

getShipmentItemsByShipmentId

getShipments

  • getShipments(
        requestParameters: FbaInboundApiGetShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetShipmentsResponse, any>>

    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

    Returns Promise<AxiosResponse<GetShipmentsResponse, any>>

    Throws

    Memberof

    FbaInboundApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR