Class RatesAPI

Rates API module - /v1/rates

Hierarchy

RatesAPI

Index

Constructors

constructor

new RatesAPI(client: AxiosInstance): RatesAPI
Parameters
- client: AxiosInstance
Returns RatesAPI
- Defined in javascript/src/rates/api.ts:16

Properties

`Private` client

client: AxiosInstance

Methods

calculateByShipmentId

calculateByShipmentId(shipmentId: string, options: SE.CalculateRatesOptions): Promise<AxiosResponse<Omit<SE.Shipment, "items"> & {
    items: SE.SalesOrderShipmentItem[];
    salesOrderIds: string[];
} & {
    rateResponse: SE.RateResponse;
}, any>>
The calculate method calculates rates for a shipment by shipment ID based on the shipment's options.
Parameters
- shipmentId: string
- options: SE.CalculateRatesOptions
Returns Promise<AxiosResponse<Omit<SE.Shipment, "items"> & {
    items: SE.SalesOrderShipmentItem[];
    salesOrderIds: string[];
} & {
    rateResponse: SE.RateResponse;
}, any>>
- Defined in javascript/src/rates/api.ts:24

estimate

estimate(params: SE.RatesEstimateParams): Promise<AxiosResponse<SE.RatesEstimateResponse, any>>
The estimate endpoint allows us to obtain estimated rates based on the payload that is attached to the POST method.
Parameters
- params: SE.RatesEstimateParams
Returns Promise<AxiosResponse<SE.RatesEstimateResponse, any>>
- Defined in javascript/src/rates/api.ts:35

Class RatesAPI

Rates API module - /v1/rates

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: AxiosInstance

Returns RatesAPI

Properties

`Private` client

Methods

calculateByShipmentId

Parameters

shipmentId: string

options: SE.CalculateRatesOptions

Returns Promise<AxiosResponse<Omit<SE.Shipment, "items"> & {
    items: SE.SalesOrderShipmentItem[];
    salesOrderIds: string[];
} & {
    rateResponse: SE.RateResponse;
}, any>>

estimate

Parameters

params: SE.RatesEstimateParams

Returns Promise<AxiosResponse<SE.RatesEstimateResponse, any>>

Settings

Member Visibility

Theme

Class RatesAPI

Rates API module - /v1/rates

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: AxiosInstance

Returns RatesAPI

Properties

Private client

Methods

calculateByShipmentId

Parameters

shipmentId: string

options: SE.CalculateRatesOptions

Returns Promise<AxiosResponse<Omit<SE.Shipment, "items"> & { items: SE.SalesOrderShipmentItem[]; salesOrderIds: string[]; } & { rateResponse: SE.RateResponse; }, any>>

estimate

Parameters

params: SE.RatesEstimateParams

Returns Promise<AxiosResponse<SE.RatesEstimateResponse, any>>

Settings

Member Visibility

Theme

`Private` client

Returns Promise<AxiosResponse<Omit<SE.Shipment, "items"> & {
items: SE.SalesOrderShipmentItem[];
salesOrderIds: string[];
} & {
rateResponse: SE.RateResponse;
}, any>>