Hierarchy

  • CarriersAPI

Constructors

Properties

client: AxiosInstance

Methods

  • The addFunds method allows a user to add funds to their carrier account balance. Not all carrier providers allow you to maintain a balance.

    • For example, FedEx does not require you to maintain a balance that will be used when purchasing labels.

    Parameters

    Returns Promise<AxiosResponse<{
        balance: SE.Money;
    }, any>>

  • The getCountries method retrieves a list of countries that a given carrier supports shipping to.

    Parameters

    • carrierId: string

    Returns Promise<AxiosResponse<{
        countries: string[];
    }, any>>

  • The getCurrencies method retrieves a list of currencies that a given carrier supports the usage of.

    Parameters

    • carrierId: string

    Returns Promise<AxiosResponse<{
        currencies: SE.Currency[];
    }, any>>

  • The getPackageRatingGroup method retrieves a list of package rating groups. This is primarily used for carriers that support negotiated rates, and a user has a rate card with multiple package rating groups.

    Parameters

    • carrierId: string

    Returns Promise<AxiosResponse<{
        packageRatingGroup: SE.PackageRatingType[];
    }, any>>

  • The getServices method retrieves a list of shipping services that a given carrier offers.

    Parameters

    • carrierId: string

    Returns Promise<AxiosResponse<{
        services: SE.CarrierService[];
    }, any>>

  • The getZones method retrieves a list of zones for which the attached carrier provides support to.

    Parameters

    • carrierId: string

    Returns Promise<AxiosResponse<{
        zones: SE.CarrierZone[];
    }, any>>

  • The list method retrieves a list of connected carriers for a given user.

    Parameters

    • Optional props: {
          isSandbox?: boolean;
      }
      • Optional isSandbox?: boolean

    Returns Promise<AxiosResponse<{
        carriers: SE.Carrier[];
    }, any>>

Generated using TypeDoc