Usage

1. Get Order List

API Method: getOrderList(params?: PageOptions & Object): Promise<PageContent<OrderData>>

Parameter Description:

• params: Acquisition parameters, type PageOptions & Object, optional, default {}

Return Value Description: Type Promise<PageContent<OrderData>>

Example:

const data = await orderTarget.getOrderList({ pageNumber: 1, pageSize: 10 });
console.log('订单列表', data.contents);

2. Get Order Details

API Method: getOrderDetail(params: GetOrderDetailParams): Promise<OrderData>

Parameter Description:

• params: Acquisition parameters, type GetOrderDetailParams, required. Detailed type description is as follows:

Return Value Description: Type Promise<OrderData>

Example:

const data = await orderTarget.getOrderDetail({ orderNo: '1234567890' });
console.log('订单详情', data);

3. Create Order

API Method: createOrder(params: CreateOrderParams): Promise<CommonResult<CreateOrderFailReason, CreateOrderResponse>>

Parameter Description:

• params: Order creation parameters, type CreateOrderParams, required. Detailed type description is as follows:

Return Value Description: Type Promise<CommonResult<CreateOrderFailReason, CreateOrderResponse>>

Example:

const res = await orderTarget.createOrder({ address: { name: '张三', mobile: '13800138000', area: '广东省 广州市 天河区', address: '天河路1号' }, products: [{ productId: 1, quantity: 1 }], payProvider: PaymentProvider.Wechat });
if (res.success) { 
  console.log('创建订单成功', res.orderNo);
} else {
  console.log('创建订单失败', res.failReason, res.failMessage);
}

4. Confirm Receipt

API Method: confirmOrder(orderNo: string): Promise<void>

Parameter Description:

• orderNo: Order number, type string, required

Example:

await orderTarget.confirmOrder('1234567890');

5. Apply for Refund

API Method: applyOrderRefund(orderNo: string): Promise<CommonResult<OrderRefundFailReason, ApplyOrderRefundResponse>>

Parameter Description:

• orderNo: Order number, type string, required

Return Value Description: Type Promise<CommonResult<OrderRefundFailReason, ApplyOrderRefundResponse>>

Example:

const res = await orderTarget.applyOrderRefund('1234567890');
if (res.success) {
  console.log('退款成功', res);
} else {
  console.log('退款失败', res.failReason, res.failMessage);
}