Class WarehousesAPI

Warehouses API module - /v1/warehouses

Hierarchy

WarehousesAPI

Index

Constructors

Properties

Methods

create delete list update

Constructors

constructor

new WarehousesAPI(client: AxiosInstance): WarehousesAPI
Parameters
- client: AxiosInstance
Returns WarehousesAPI
- Defined in javascript/src/warehouses/api.ts:11

Properties

`Private` client

client: AxiosInstance

Methods

create

create(warehouse: Partial<SE.Warehouse>): Promise<AxiosResponse<SE.Warehouse, any>>
The create method allows for creation of warehouses (Ship From Locations) on a users ShipEngine account.
Parameters
- warehouse: Partial<SE.Warehouse>
Returns Promise<AxiosResponse<SE.Warehouse, any>>
- Defined in javascript/src/warehouses/api.ts:29

delete

delete(warehouseId: string): Promise<AxiosResponse<void, any>>
The delete method deletes a specific warehouse (Ship From Location) by warehouseId from a users ShipEngine account.
Parameters
- warehouseId: string
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/warehouses/api.ts:45

list

list(props?: {
isSandbox?: boolean;
}): Promise<AxiosResponse<{
warehouses: SE.Warehouse[];
}, any>>
The list method retrieves a list of warehouses (Ship From Locations) for a given user.
Parameters
- Optional props: {
  isSandbox?: boolean;
  }
  - Optional isSandbox?: boolean
Returns Promise<AxiosResponse<{
warehouses: SE.Warehouse[];
}, any>>
- Defined in javascript/src/warehouses/api.ts:19

update

update(warehouseId: string, warehouse: Partial<SE.Warehouse>): Promise<AxiosResponse<void, any>>
The update method updates a specific warehouse (Ship From Location) for a given user by warehouseId.
Parameters
- warehouseId: string
- warehouse: Partial<SE.Warehouse>
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/warehouses/api.ts:37

Generated using TypeDoc