Class TrackingApi

TrackingApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- TrackingApi
  - TrackingApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getShipmentTracking

Constructors

constructor

new TrackingApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): TrackingApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns TrackingApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getShipmentTracking

getShipmentTracking(
requestParameters?: TrackingApiGetShipmentTrackingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentTrackingResponse, any, {}, any>>
Returns tracking information for a shipment.
Parameters
- requestParameters: TrackingApiGetShipmentTrackingRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentTrackingResponse, any, {}, any>>

Throws
- Defined in api-model/api/tracking-api.ts:209