Class FreightAPI

Freight API module - /v1/freight

Hierarchy

FreightAPI

Index

Constructors

Properties

Methods

Constructors

constructor

new FreightAPI(client: AxiosInstance): FreightAPI
Parameters
- client: AxiosInstance
Returns FreightAPI
- Defined in javascript/src/freight/api.ts:9

Properties

`Private` client

client: AxiosInstance

Methods

list

list(): Promise<AxiosResponse<{
freightProviderAccounts: FreightProviderAccount[];
}, any>>
The list method retrieves the freight provider accounts connected to a given user's account.

See
https://docs.shipstation.com/apis/openapi/freight/list_freight_provider_accounts

Returns Promise<AxiosResponse<{
freightProviderAccounts: FreightProviderAccount[];
}, any>>
- Defined in javascript/src/freight/api.ts:19

provision

provision(request: ProvisionFreightProviderAccountRequest): Promise<AxiosResponse<FreightProviderAccount, any>>
The provision method opens a new account with a freight provider on behalf of the user and connects it to their account. Responds 409 when the user already has an account connected for that provider.
Parameters
- request: ProvisionFreightProviderAccountRequest
Returns Promise<AxiosResponse<FreightProviderAccount, any>>
- Defined in javascript/src/freight/api.ts:30

Generated using TypeDoc