Function FbaInboundApiFp

FbaInboundApi - functional programming interface

Export

  • FbaInboundApiFp(
        configuration?: Configuration,
    ): {
        confirmPreorder(
            shipmentId: string,
            needByDate: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ConfirmPreorderResponse>,
        >;
        confirmTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ConfirmTransportResponse>,
        >;
        createInboundShipment(
            shipmentId: string,
            body: InboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InboundShipmentResponse>,
        >;
        createInboundShipmentPlan(
            body: CreateInboundShipmentPlanRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateInboundShipmentPlanResponse>,
        >;
        estimateTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EstimateTransportResponse>,
        >;
        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>,
        >;
        getPreorderInfo(
            shipmentId: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPreorderInfoResponse>,
        >;
        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>,
        >;
        getTransportDetails(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetTransportDetailsResponse>,
        >;
        putTransportDetails(
            shipmentId: string,
            body: PutTransportDetailsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PutTransportDetailsResponse>,
        >;
        updateInboundShipment(
            shipmentId: string,
            body: InboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InboundShipmentResponse>,
        >;
        voidTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<VoidTransportResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        confirmPreorder(
            shipmentId: string,
            needByDate: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ConfirmPreorderResponse>,
        >;
        confirmTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ConfirmTransportResponse>,
        >;
        createInboundShipment(
            shipmentId: string,
            body: InboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InboundShipmentResponse>,
        >;
        createInboundShipmentPlan(
            body: CreateInboundShipmentPlanRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateInboundShipmentPlanResponse>,
        >;
        estimateTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EstimateTransportResponse>,
        >;
        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>,
        >;
        getPreorderInfo(
            shipmentId: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPreorderInfoResponse>,
        >;
        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>,
        >;
        getTransportDetails(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetTransportDetailsResponse>,
        >;
        putTransportDetails(
            shipmentId: string,
            body: PutTransportDetailsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PutTransportDetailsResponse>,
        >;
        updateInboundShipment(
            shipmentId: string,
            body: InboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InboundShipmentResponse>,
        >;
        voidTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<VoidTransportResponse>,
        >;
    }

    • confirmPreorder:function
      • confirmPreorder(
            shipmentId: string,
            needByDate: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • needByDate: string

          Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace the shipment is tied to.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • confirmTransport:function
      • confirmTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • createInboundShipment:function
      • createInboundShipment(
            shipmentId: string,
            body: InboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • body: InboundShipmentRequest

          The request schema for the InboundShipmentRequest operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • createInboundShipmentPlan:function
      • createInboundShipmentPlan(
            body: CreateInboundShipmentPlanRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • body: CreateInboundShipmentPlanRequest

          The request schema for the CreateInboundShipmentPlanRequest operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • estimateTransport:function
      • estimateTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • getBillOfLading:function
      • getBillOfLading(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • 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>,
        >

        Throws

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

      • 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>,
        >

        Throws

    • getPreorderInfo:function
      • getPreorderInfo(
            shipmentId: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • marketplaceId: string

          A marketplace identifier. Specifies the marketplace the shipment is tied to.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • getPrepInstructions:function
      • getPrepInstructions(
            shipToCountryCode: string,
            sellerSKUList?: string[],
            aSINList?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • 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>,
        >

        Throws

    • getShipmentItems:function
      • getShipmentItems(
            queryType: GetShipmentItemsQueryTypeEnum,
            marketplaceId: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • 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>,
        >

        Throws

    • getShipmentItemsByShipmentId:function
      • getShipmentItemsByShipmentId(
            shipmentId: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

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

        • marketplaceId: string

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

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getShipments:function
      • getShipments(
            queryType: GetShipmentsQueryTypeEnum,
            marketplaceId: string,
            shipmentStatusList?: GetShipmentsShipmentStatusListEnum[],
            shipmentIdList?: string[],
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • 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>,
        >

        Throws

    • getTransportDetails:function
      • getTransportDetails(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • putTransportDetails:function
      • putTransportDetails(
            shipmentId: string,
            body: PutTransportDetailsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • body: PutTransportDetailsRequest

          The request schema for the PutTransportDetailsRequest operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • updateInboundShipment:function
      • updateInboundShipment(
            shipmentId: string,
            body: InboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • body: InboundShipmentRequest

          The request schema for the InboundShipmentRequest operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • voidTransport:function
      • voidTransport(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • shipmentId: string

          A shipment identifier originally returned by the createInboundShipmentPlan operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

Settings

Member Visibility