Function ShipmentInvoiceApiFp

ShipmentInvoiceApi - functional programming interface

Export

  • ShipmentInvoiceApiFp(
        configuration?: Configuration,
    ): {
        getInvoiceStatus(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetInvoiceStatusResponse>,
        >;
        getShipmentDetails(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >;
        submitInvoice(
            shipmentId: string,
            body: SubmitInvoiceRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitInvoiceResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getInvoiceStatus(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetInvoiceStatusResponse>,
        >;
        getShipmentDetails(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >;
        submitInvoice(
            shipmentId: string,
            body: SubmitInvoiceRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitInvoiceResponse>,
        >;
    }

    • getInvoiceStatus:function
      • getInvoiceStatus(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetInvoiceStatusResponse>,
        >

      • Returns the invoice status for the shipment you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 | 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

          The shipment identifier for the shipment.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getShipmentDetails:function
      • getShipmentDetails(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentDetailsResponse>,
        >

      • Returns the shipment details required to issue an invoice for the specified shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 | 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

          The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the Notifications API Use Case Guide.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • submitInvoice:function
      • submitInvoice(
            shipmentId: string,
            body: SubmitInvoiceRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SubmitInvoiceResponse>,
        >

      • Submits a shipment invoice document for a given shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1.133 | 25 | 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

          The identifier for the shipment.

        • body: SubmitInvoiceRequest
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility