Class ProductHandler

Index

Constructors

Methods

bulkCreate bulkUpdate create delete getAttributes getByBarcode getByCategory getByCode getById getInventoryLevels list search update

Constructors

constructor

new ProductHandler(client: KiotVietClient): ProductHandler
Parameters
- client: KiotVietClient
Returns ProductHandler
- Defined in src/resources/products.ts:5

Methods

bulkCreate

bulkCreate(products: ProductCreateParams[]): Promise<void>
Add multiple products at once
Parameters
- products: ProductCreateParams[]
  Array of product data to create
Returns Promise<void>
- Defined in src/resources/products.ts:107

bulkUpdate

bulkUpdate(products: ProductUpdateParams[]): Promise<void>
Update multiple products at once
Parameters
- products: ProductUpdateParams[]
  Array of product data to update
Returns Promise<void>
- Defined in src/resources/products.ts:117

create

create(productData: ProductCreateParams): Promise<Product>
Create a new product
Parameters
- productData: ProductCreateParams
  The product data to create
Returns Promise<Product>
- Defined in src/resources/products.ts:29

delete

delete(productId: number): Promise<void>
Delete a product
Parameters
- productId: number
  The ID of the product to delete
Returns Promise<void>
- Defined in src/resources/products.ts:48

getAttributes

getAttributes(): Promise<any>
Get all product attributes with their distinct values

Returns Promise<any>
- Defined in src/resources/products.ts:98

getByBarcode

getByBarcode(barcode: string): Promise<Product>
Parameters
- barcode: string
Returns Promise<Product>
- Defined in src/resources/products.ts:132

getByCategory

getByCategory(
categoryId: number,
params?: Record<string, any>,
): Promise<KiotVietListResponse<Product>>
Get products by category ID
Parameters
- categoryId: number
  The ID of the category
- params: Record<string, any> = {}
  Additional filter parameters
Returns Promise<KiotVietListResponse<Product>>
- Defined in src/resources/products.ts:57

getByCode

getByCode(code: string): Promise<Product>
Get a product by its code
Parameters
- code: string
  The product code
Returns Promise<Product>
- Defined in src/resources/products.ts:90

getById

getById(productId: number): Promise<Product>
Get a product by its ID
Parameters
- productId: number
  The ID of the product to retrieve
Returns Promise<Product>
- Defined in src/resources/products.ts:20

getInventoryLevels

getInventoryLevels(params?: Record<string, any>): Promise<any>
Get product inventory levels across branches
Parameters
- params: Record<string, any> = {}
  Query parameters (branchIds, lastModifiedFrom, etc)
Returns Promise<any>
- Defined in src/resources/products.ts:127

list

list(params?: Record<string, any>): Promise<KiotVietListResponse<Product>>
List products with optional filtering
Parameters
- params: Record<string, any> = {}
  Filter parameters (pageSize, currentItem, code, name, categoryId, etc.)
Returns Promise<KiotVietListResponse<Product>>
- Defined in src/resources/products.ts:11

search

search(
query: string,
params?: Record<string, any>,
): Promise<KiotVietListResponse<Product>>
Search products by name or code
Parameters
- query: string
  Search query (name or code)
- params: Record<string, any> = {}
  Additional filter parameters
Returns Promise<KiotVietListResponse<Product>>
- Defined in src/resources/products.ts:72

update

update(
productId: number,
productData: Partial<ProductUpdateParams>,
): Promise<Product>
Update an existing product
Parameters
- productId: number
  The ID of the product to update
- productData: Partial<ProductUpdateParams>
  The product data to update
Returns Promise<Product>
- Defined in src/resources/products.ts:39