Function ShippingApiFp

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>,
    >;
    getAccount(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAccountResponse>,
    >;
    getRates(
        body: GetRatesRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRatesResponse>,
    >;
    getShipment(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetShipmentResponse>,
    >;
    getTrackingInformation(
        trackingId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetTrackingInformationResponse>,
    >;
    purchaseLabels(
        shipmentId: string,
        body: PurchaseLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PurchaseLabelsResponse>,
    >;
    purchaseShipment(
        body: PurchaseShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PurchaseShipmentResponse>,
    >;
    retrieveShippingLabel(
        shipmentId: string,
        trackingId: string,
        body: RetrieveShippingLabelRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RetrieveShippingLabelResponse>,
    >;
}

• cancelShipment: function

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

    Cancel a shipment by the given shipmentId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • shipmentId: string

      Shipment Id to cancel a shipment

    • 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 new shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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: CreateShipmentRequest

      CreateShipmentRequest Body

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getAccount: function

  • getAccount(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAccountResponse>,
    >

    Verify if the current account is valid. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getRates: function

  • getRates(
        body: GetRatesRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRatesResponse>,
    >

    Get service rates. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • body: GetRatesRequest

      GetRatesRequest body

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getShipment: function

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

    Return the entire shipment object for the shipmentId. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • shipmentId: string

      Shipment id to return the entire shipment object

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getTrackingInformation: function

  • getTrackingInformation(
        trackingId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetTrackingInformationResponse>,
    >

    Return the tracking information of a shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • trackingId: string

      Tracking Id

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• purchaseLabels: function

  • purchaseLabels(
        shipmentId: string,
        body: PurchaseLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PurchaseLabelsResponse>,
    >

    Purchase shipping labels based on a given rate. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • shipmentId: string

      Shipment id for purchase shipping label

    • body: PurchaseLabelsRequest

      PurchaseShippingLabelRequest body

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• purchaseShipment: function

  • purchaseShipment(
        body: PurchaseShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PurchaseShipmentResponse>,
    >

    Purchase shipping labels. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • body: PurchaseShipmentRequest

      PurchaseShipmentRequest body

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• retrieveShippingLabel: function

  • retrieveShippingLabel(
        shipmentId: string,
        trackingId: string,
        body: RetrieveShippingLabelRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RetrieveShippingLabelResponse>,
    >

    Retrieve shipping label based on the shipment id and tracking id. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • shipmentId: string

      Shipment Id to retreive label

    • trackingId: string

      Tracking Id

    • body: RetrieveShippingLabelRequest

      RetrieveShippingLabelRequest body

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws