Function VendorShipmentsApiFp

VendorShipmentsApi - functional programming interface

Export

  • VendorShipmentsApiFp(
        configuration?: Configuration,
    ): {
        getShipmentDetails(
            limit?: number,
            sortOrder?: GetShipmentDetailsSortOrderEnum,
            nextToken?: string,
            createdAfter?: string,
            createdBefore?: string,
            shipmentConfirmedBefore?: string,
            shipmentConfirmedAfter?: string,
            packageLabelCreatedBefore?: string,
            packageLabelCreatedAfter?: string,
            shippedBefore?: string,
            shippedAfter?: string,
            estimatedDeliveryBefore?: string,
            estimatedDeliveryAfter?: string,
            shipmentDeliveryBefore?: string,
            shipmentDeliveryAfter?: string,
            requestedPickUpBefore?: string,
            requestedPickUpAfter?: string,
            scheduledPickUpBefore?: string,
            scheduledPickUpAfter?: string,
            currentShipmentStatus?: string,
            vendorShipmentIdentifier?: string,
            buyerReferenceNumber?: string,
            buyerWarehouseCode?: string,
            sellerWarehouseCode?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >;
        submitShipmentConfirmations(
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >;
        submitShipments(
            body: SubmitShipments,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getShipmentDetails(
            limit?: number,
            sortOrder?: GetShipmentDetailsSortOrderEnum,
            nextToken?: string,
            createdAfter?: string,
            createdBefore?: string,
            shipmentConfirmedBefore?: string,
            shipmentConfirmedAfter?: string,
            packageLabelCreatedBefore?: string,
            packageLabelCreatedAfter?: string,
            shippedBefore?: string,
            shippedAfter?: string,
            estimatedDeliveryBefore?: string,
            estimatedDeliveryAfter?: string,
            shipmentDeliveryBefore?: string,
            shipmentDeliveryAfter?: string,
            requestedPickUpBefore?: string,
            requestedPickUpAfter?: string,
            scheduledPickUpBefore?: string,
            scheduledPickUpAfter?: string,
            currentShipmentStatus?: string,
            vendorShipmentIdentifier?: string,
            buyerReferenceNumber?: string,
            buyerWarehouseCode?: string,
            sellerWarehouseCode?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >;
        submitShipmentConfirmations(
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >;
        submitShipments(
            body: SubmitShipments,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >;
    }

    • getShipmentDetails:function
      • getShipmentDetails(
            limit?: number,
            sortOrder?: GetShipmentDetailsSortOrderEnum,
            nextToken?: string,
            createdAfter?: string,
            createdBefore?: string,
            shipmentConfirmedBefore?: string,
            shipmentConfirmedAfter?: string,
            packageLabelCreatedBefore?: string,
            packageLabelCreatedAfter?: string,
            shippedBefore?: string,
            shippedAfter?: string,
            estimatedDeliveryBefore?: string,
            estimatedDeliveryAfter?: string,
            shipmentDeliveryBefore?: string,
            shipmentDeliveryAfter?: string,
            requestedPickUpBefore?: string,
            requestedPickUpAfter?: string,
            scheduledPickUpBefore?: string,
            scheduledPickUpAfter?: string,
            currentShipmentStatus?: string,
            vendorShipmentIdentifier?: string,
            buyerReferenceNumber?: string,
            buyerWarehouseCode?: string,
            sellerWarehouseCode?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >

      • Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >

        Throws

    • submitShipmentConfirmations:function
      • submitShipmentConfirmations(
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >

      • Submits one or more shipment confirmations for vendor orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >

        Throws

    • submitShipments:function
      • submitShipments(
            body: SubmitShipments,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
        >

      • Submits one or more shipment request for vendor Orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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: SubmitShipments

          A request to submit shipment request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility