Class UsersApi

Users API module - /v1/users

Link

https://docs.shipstation.com/openapi/users

Hierarchy

UsersApi

Index

Constructors

Properties

Methods

Constructors

constructor

new UsersApi(client: AxiosInstance): UsersApi
Parameters
- client: AxiosInstance
Returns UsersApi
- Defined in javascript/src/users/api.ts:10

Properties

`Private` client

client: AxiosInstance

Methods

list

list(options?: SE.UserListOptions): Promise<AxiosResponse<SE.UserListResponse, any>>
The list gets all the users of the current Seller.
Parameters
- Optional options: SE.UserListOptions
Returns Promise<AxiosResponse<SE.UserListResponse, any>>
- Defined in javascript/src/users/api.ts:17

Generated using TypeDoc