Function MerchantFulfillmentApiFp

MerchantFulfillmentApi - functional programming interface

Export

  • MerchantFulfillmentApiFp(
        configuration?: Configuration,
    ): {
        cancelShipment(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelShipmentResponse>,
        >;
        createShipment(
            body: CreateShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateShipmentResponse>,
        >;
        getAdditionalSellerInputs(
            body: GetAdditionalSellerInputsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAdditionalSellerInputsResponse>,
        >;
        getEligibleShipmentServices(
            body: GetEligibleShipmentServicesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetEligibleShipmentServicesResponse>,
        >;
        getShipment(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelShipment(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelShipmentResponse>,
        >;
        createShipment(
            body: CreateShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateShipmentResponse>,
        >;
        getAdditionalSellerInputs(
            body: GetAdditionalSellerInputsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAdditionalSellerInputsResponse>,
        >;
        getEligibleShipmentServices(
            body: GetEligibleShipmentServicesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetEligibleShipmentServicesResponse>,
        >;
        getShipment(
            shipmentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetShipmentResponse>,
        >;
    }

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

      • Cancel the shipment indicated by the specified shipment identifier. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

        Parameters

        • shipmentId: string

          The Amazon-defined shipment identifier for the shipment to cancel.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • createShipment:function
      • createShipment(
            body: CreateShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateShipmentResponse>,
        >

      • Create a shipment with the information provided. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

        Parameters

        • body: CreateShipmentRequest

          The request schema for the `CreateShipment` operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getAdditionalSellerInputs:function
      • getAdditionalSellerInputs(
            body: GetAdditionalSellerInputsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetAdditionalSellerInputsResponse>,
        >

      • Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

        Parameters

        • body: GetAdditionalSellerInputsRequest

          The request schema for the `GetAdditionalSellerInputs` operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getEligibleShipmentServices:function
      • getEligibleShipmentServices(
            body: GetEligibleShipmentServicesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetEligibleShipmentServicesResponse>,
        >

      • Returns a list of shipping service offers that satisfy the specified shipment request details. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

        Parameters

        • body: GetEligibleShipmentServicesRequest

          The request schema for the `GetEligibleShipmentServices` operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Returns the shipment information for an existing shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

        Parameters

        • shipmentId: string

          The Amazon-defined shipment identifier for the shipment.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility