ShipEngine API Client

  • This class is the ShipEngine API Client that facilitates all requests. e.g. Rate Shopping, Label Creation, etc.

Hierarchy

  • ShipEngineAPI

Constructors

Properties

client: AxiosInstance
getSandboxToken?: (() => string | Promise<string>)

Type declaration

    • (): string | Promise<string>
    • Returns string | Promise<string>

sandboxToken?: string

Accessors

  • get accountBillingPlan(): AccountBillingPlanAPI
  • The accountBillingPlan method provides access to the Account Billing Plan endpoints in ShipEngine API.

    Returns AccountBillingPlanAPI

  • get sellers(): SellersAPI
  • The sellers method provides access to the Sellers endpoints in ShipEngine API.

    These endpoints are old and do not follow the ShipEngine API standards that current endpoints follow. It is very likely that in the future these endpoints will be deprecated by other endpoints.

    See

    The Sellers API module

    Returns SellersAPI

Methods

  • The getTenant method get the current token (based on isSandbox prop) and will get the Tenant ID from that token (also known as Seller ID)

    Parameters

    • Optional isSandbox: boolean

    Returns Promise<null | string>

  • The getTenantFromToken method receives a token and returns the Tenant ID associated with it.

    Parameters

    • token: string

    Returns null | string

Generated using TypeDoc