使用方式
更新時間:2025-09-05 09:41:51
一、取得訂單列表
Api 方法: getOrderList(params?: PageOptions & Object): Promise<PageContent<OrderData>>
參數說明:
- params:取得參數,
PageOptions & Object類型,選填,預設{}
回傳值說明: Promise<PageContent<OrderData>> 類型
範例:
const data = await orderTarget.getOrderList({ pageNumber: 1, pageSize: 10 });
console.log('订单列表', data.contents);
二、取得訂單詳情
Api 方法: getOrderDetail(params: GetOrderDetailParams): Promise<OrderData>
參數說明:
- params:取得參數,
GetOrderDetailParams類型,必填,詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
orderNo |
訂單號 | string |
是 | - |
syncPayStatus |
是否同步訂單最新狀態 | boolean |
是 | - |
回傳值說明: Promise<OrderData> 類型
範例:
const data = await orderTarget.getOrderDetail({ orderNo: '1234567890' });
console.log('订单详情', data);
三、建立訂單
Api 方法: createOrder(params: CreateOrderParams): Promise<CommonResult<CreateOrderFailReason, CreateOrderResponse>>
參數說明:
- params:建立訂單參數,
CreateOrderParams類型,必填,詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
address |
物流資訊 | AddressBasicData |
是 | - |
products |
購買商品 | CreateOrderProductItem[] |
是 | - |
payProvider |
支付方式 | PaymentProvider |
是 | - |
回傳值說明: Promise<CommonResult<CreateOrderFailReason, CreateOrderResponse>> 類型
範例:
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);
}
四、確認收貨
Api 方法: confirmOrder(orderNo: string): Promise<void>
參數說明:
- orderNo:訂單號,
string類型,必填
範例:
await orderTarget.confirmOrder('1234567890');
五、申請退款
Api 方法: applyOrderRefund(orderNo: string): Promise<CommonResult<OrderRefundFailReason, ApplyOrderRefundResponse>>
參數說明:
- orderNo:訂單號,
string類型,必填
回傳值說明: Promise<CommonResult<OrderRefundFailReason, ApplyOrderRefundResponse>> 類型
範例:
const res = await orderTarget.applyOrderRefund('1234567890');
if (res.success) {
console.log('退款成功', res);
} else {
console.log('退款失败', res.failReason, res.failMessage);
}
