Class Inventory

Inventory resource handler

Index

Constructors

Methods

adjustQuantity cancelTransfer count get getLocation getTransfer list listLocations setLevel transfer

Constructors

constructor

new Inventory(client): Inventory
Parameters
- client: SapoClient
Returns Inventory
- Defined in resources/inventory.ts:18

Methods

adjustQuantity

adjustQuantity(itemId, adjustment): Promise<InventoryItem>
Adjust inventory level
Parameters
- itemId: number
  Inventory item ID
- adjustment: InventoryAdjustment
  Inventory adjustment data
Returns Promise<InventoryItem>
Updated inventory item
- Defined in resources/inventory.ts:47

cancelTransfer

cancelTransfer(itemId, transferId): Promise<InventoryTransfer>
Cancel inventory transfer
Parameters
- itemId: number
  Inventory item ID
- transferId: number
  Transfer ID
Returns Promise<InventoryTransfer>
Cancelled inventory transfer
- Defined in resources/inventory.ts:110

count

count(params?): Promise<number>
Get total inventory item count
Parameters
- Optional params: Partial<InventoryListParams>
  Filter parameters
Returns Promise<number>
Total number of inventory items matching filters
- Defined in resources/inventory.ts:141

get

get(id): Promise<InventoryItem>
Get a single inventory item by ID
Parameters
- id: number
  Inventory item ID
Returns Promise<InventoryItem>
Inventory item details
- Defined in resources/inventory.ts:34

getLocation

getLocation(id): Promise<Location>
Get location by ID
Parameters
- id: number
  Location ID
Returns Promise<Location>
Location details
- Defined in resources/inventory.ts:131

getTransfer

getTransfer(itemId, transferId): Promise<InventoryTransfer>
Get inventory transfer by ID
Parameters
- itemId: number
  Inventory item ID
- transferId: number
  Transfer ID
Returns Promise<InventoryTransfer>
Inventory transfer details
- Defined in resources/inventory.ts:97

list

list(params?): Promise<PaginatedResponse<InventoryItem>>
Get a list of inventory items
Parameters
- Optional params: InventoryListParams
  Query parameters for filtering and pagination
Returns Promise<PaginatedResponse<InventoryItem>>
Paginated list of inventory items
- Defined in resources/inventory.ts:25

listLocations

listLocations(): Promise<Location[]>
Get list of locations

Returns Promise<Location[]>
List of locations
- Defined in resources/inventory.ts:121

setLevel

setLevel(itemId, locationId, data): Promise<InventoryItem>
Set inventory level at location
Parameters
- itemId: number
  Inventory item ID
- locationId: number
  Location ID
- data: UpdateInventoryLevelData
  Inventory level data
Returns Promise<InventoryItem>
Updated inventory item
- Defined in resources/inventory.ts:65

transfer

transfer(itemId, data): Promise<InventoryTransfer>
Transfer inventory between locations
Parameters
- itemId: number
  Inventory item ID
- data: InventoryTransferData
  Transfer data
Returns Promise<InventoryTransfer>
Created inventory transfer
- Defined in resources/inventory.ts:83