Class OrderHandler

Index

Constructors

Methods

cancel create delete getByCode getByCustomer getByDateRange getById list update

Constructors

constructor

new OrderHandler(client: KiotVietClient): OrderHandler
Parameters
- client: KiotVietClient
Returns OrderHandler
- Defined in src/resources/orders.ts:12

Methods

cancel

cancel(orderId: number, reason?: string): Promise<Order>
Cancel an order
Parameters
- orderId: number
  The ID of the order to cancel
- Optionalreason: string
  Optional cancellation reason
Returns Promise<Order>
- Defined in src/resources/orders.ts:59

create

create(orderData: OrderCreateParams): Promise<Order>
Create a new order
Parameters
- orderData: OrderCreateParams
  The order data to create
Returns Promise<Order>
- Defined in src/resources/orders.ts:36

delete

delete(orderId: number, isVoidPayment?: boolean): Promise<void>
Delete an order
Parameters
- orderId: number
  The ID of the order to delete
- isVoidPayment: boolean = false
  Whether to void the associated payment
Returns Promise<void>
- Defined in src/resources/orders.ts:82

getByCode

getByCode(code: string): Promise<Order>
Get an order by its code
Parameters
- code: string
  The code of the order to retrieve
Returns Promise<Order>
- Defined in src/resources/orders.ts:72

getByCustomer

getByCustomer(
customerIdentifier: string,
params?: Omit<OrderListParams, "customerCode" | "customerPhone">,
): Promise<OrderListResponse>
Get orders by customer
Parameters
- customerIdentifier: string
  Customer's phone number or code
- params: Omit<OrderListParams, "customerCode" | "customerPhone"> = {}
  Additional filter parameters
Returns Promise<OrderListResponse>
- Defined in src/resources/orders.ts:116

getByDateRange

getByDateRange(
    fromDate: string,
    toDate: string,
    params?: Omit<OrderListParams, "fromPurchaseDate" | "toPurchaseDate">,
): Promise<OrderListResponse>
Get orders by date range
Parameters
- fromDate: string
  Start date (YYYY-MM-DD)
- toDate: string
  End date (YYYY-MM-DD)
- params: Omit<OrderListParams, "fromPurchaseDate" | "toPurchaseDate"> = {}
  Additional filter parameters
Returns Promise<OrderListResponse>
- Defined in src/resources/orders.ts:96

getById

getById(orderId: number): Promise<Order>
Get an order by its ID
Parameters
- orderId: number
  The ID of the order to retrieve
Returns Promise<Order>
- Defined in src/resources/orders.ts:27

list

list(params?: OrderListParams): Promise<OrderListResponse>
List orders with optional filtering
Parameters
- params: OrderListParams = {}
  Filter parameters
Returns Promise<OrderListResponse>
- Defined in src/resources/orders.ts:18

update

update(orderId: number, orderData: Partial<OrderUpdateParams>): Promise<Order>
Update an existing order
Parameters
- orderId: number
  The ID of the order to update
- orderData: Partial<OrderUpdateParams>
  The order data to update
Returns Promise<Order>
- Defined in src/resources/orders.ts:46