FbaInboundApi - functional programming interface

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getBillOfLading(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetBillOfLadingResponse>,
        >;
        getLabels(
            shipmentId: string,
            pageType: GetLabelsPageTypeEnum,
            labelType: GetLabelsLabelTypeEnum,
            numberOfPackages?: number,
            packageLabelsToPrint?: string[],
            numberOfPallets?: number,
            pageSize?: number,
            pageStartIndex?: number,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetLabelsResponse>,
        >;
        getPrepInstructions(
            shipToCountryCode: string,
            sellerSKUList?: string[],
            aSINList?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPrepInstructionsResponse>,
        >;
        getShipmentItems(
            queryType: GetShipmentItemsQueryTypeEnum,
            marketplaceId: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentItemsResponse>,
        >;
        getShipmentItemsByShipmentId(
            shipmentId: string,
            marketplaceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentItemsResponse>,
        >;
        getShipments(
            queryType: GetShipmentsQueryTypeEnum,
            marketplaceId: string,
            shipmentStatusList?: GetShipmentsShipmentStatusListEnum[],
            shipmentIdList?: string[],
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentsResponse>,
        >;
    }

    • getBillOfLading:function
      • 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

    • getLabels:function
      • 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • pageType: GetLabelsPageTypeEnum

          The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

        • labelType: GetLabelsLabelTypeEnum

          The type of labels requested.

        • OptionalnumberOfPackages: number

          The number of packages in the shipment.

        • OptionalpackageLabelsToPrint: string[]

          A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the FBA Inbound Shipment Carton Information Feed, then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the `listShipmentBoxes` response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code.

        • OptionalnumberOfPallets: number

          The number of pallets in the shipment. This returns four identical labels for each pallet.

        • OptionalpageSize: number

          The page size for paginating through the total packages&#39; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

        • OptionalpageStartIndex: number

          The page start index for paginating through the total packages&#39; labels. This is a required parameter for Non-Partnered LTL Shipments.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

    • getPrepInstructions:function
      • 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

        • shipToCountryCode: string

          The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.

        • OptionalsellerSKUList: string[]

          A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon&#39;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon&#39;s retail website. If you include a seller SKU that you have never used to list an item on Amazon&#39;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.

        • OptionalaSINList: string[]

          A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

    • getShipmentItems:function
      • 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

        • queryType: GetShipmentItemsQueryTypeEnum

          Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace where the product would be stored.

        • OptionallastUpdatedAfter: string

          A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

        • OptionallastUpdatedBefore: string

          A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

        • OptionalnextToken: string

          A string token returned in the response to your previous request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

    • getShipmentItemsByShipmentId:function
      • 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

        • shipmentId: string

          A shipment identifier used for selecting items in a specific inbound shipment.

        • OptionalmarketplaceId: string

          Deprecated. Do not use.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

    • getShipments:function
      • 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

        • queryType: GetShipmentsQueryTypeEnum

          Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace where the product would be stored.

        • OptionalshipmentStatusList: GetShipmentsShipmentStatusListEnum[]

          A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.

        • OptionalshipmentIdList: string[]

          A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

        • OptionallastUpdatedAfter: string

          A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

        • OptionallastUpdatedBefore: string

          A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

        • OptionalnextToken: string

          A string token returned in the response to your previous request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

MMNEPVFCICPMFPCPTTAAATR