Class LabelsAPI

Labels API module - /v1/labels

Hierarchy

LabelsAPI

Index

Constructors

Properties

Methods

createByRateId get list void

Constructors

constructor

new LabelsAPI(client: AxiosInstance): LabelsAPI
Parameters
- client: AxiosInstance
Returns LabelsAPI
- Defined in javascript/src/labels/api.ts:15

Properties

`Private` client

client: AxiosInstance

Methods

createByRateId

createByRateId(rateId: string, options: SE.CreateLabelOptions): Promise<AxiosResponse<SE.Label, any>>
The createByRateId allows you to create a shipping label by using a rateId which is a unique identifier tied to a specific rate.

This helps ensure that when a user is rate shopping, they can purchase a label for the price they were initially rated.
Parameters
- rateId: string
- options: SE.CreateLabelOptions
Returns Promise<AxiosResponse<SE.Label, any>>
- Defined in javascript/src/labels/api.ts:40

get

get(labelId: string): Promise<AxiosResponse<SE.Label, any>>
The get method retrieves a specific label by labelId.
Parameters
- labelId: string
Returns Promise<AxiosResponse<SE.Label, any>>
- Defined in javascript/src/labels/api.ts:22

list

list(params?: SE.ListLabelsParams): Promise<AxiosResponse<SE.ListLabelsResult, any>>
The list method retrieves a list of labels created by a given user.
Parameters
- params: SE.ListLabelsParams = {}
Returns Promise<AxiosResponse<SE.ListLabelsResult, any>>
- Defined in javascript/src/labels/api.ts:29

void

void(labelId: string): Promise<AxiosResponse<SE.VoidRequest, any>>
The void method allows a user to void a label by labelId.
Parameters
- labelId: string
Returns Promise<AxiosResponse<SE.VoidRequest, any>>
- Defined in javascript/src/labels/api.ts:47

Generated using TypeDoc