@be-link/ecommerce-trade-service-node-sdk 0.1.89 → 0.1.91
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/enums.d.ts +35 -0
- package/enums.js +48 -0
- package/modules/pos/orderCore/types.d.ts +2 -0
- package/modules/pos/orderQuery/types.d.ts +6 -0
- package/modules/ros/orderCore/types.d.ts +21 -0
- package/modules/ros/orderCore/webService.d.ts +1 -0
- package/modules/ros/orderCore/webService.js +8 -0
- package/modules/ros/orderQuery/types.d.ts +60 -0
- package/modules/ros/orderQuery/webService.d.ts +1 -0
- package/modules/ros/orderQuery/webService.js +8 -0
- package/package.json +1 -1
- package/types.d.ts +8 -0
package/enums.d.ts
CHANGED
|
@@ -62,6 +62,15 @@ export declare namespace ENUM {
|
|
|
62
62
|
/** 支付失败 */
|
|
63
63
|
FAILED = "FAILED"
|
|
64
64
|
}
|
|
65
|
+
/** 微信支付方式 */
|
|
66
|
+
enum WePayWay {
|
|
67
|
+
/** H5支付 */
|
|
68
|
+
H5 = "H5",
|
|
69
|
+
/** 小程序JSAPI支付 */
|
|
70
|
+
JSAPI = "JSAPI",
|
|
71
|
+
/** APP支付 */
|
|
72
|
+
APP = "APP"
|
|
73
|
+
}
|
|
65
74
|
/** 退款状态 */
|
|
66
75
|
enum OrderRefundStatus {
|
|
67
76
|
/** 无售后 */
|
|
@@ -167,6 +176,28 @@ export declare namespace ENUM {
|
|
|
167
176
|
/** 商家主动退款 */
|
|
168
177
|
MERCHANT_MANUAL = "MERCHANT_MANUAL"
|
|
169
178
|
}
|
|
179
|
+
/** 批量退款模式 */
|
|
180
|
+
enum BatchRefundMode {
|
|
181
|
+
/** 退货退款(全单退) */
|
|
182
|
+
RETURN_AND_REFUND = "RETURN_AND_REFUND",
|
|
183
|
+
/** 仅退款-按每份固定金额退款 */
|
|
184
|
+
REFUND_ONLY_FIXED = "REFUND_ONLY_FIXED",
|
|
185
|
+
/** 仅退款-按每份可退金额退款(退订单剩余全部金额) */
|
|
186
|
+
REFUND_ONLY_MAX = "REFUND_ONLY_MAX"
|
|
187
|
+
}
|
|
188
|
+
/** 批量退款批次状态 */
|
|
189
|
+
enum BatchRefundStatus {
|
|
190
|
+
/** 待处理 */
|
|
191
|
+
PENDING = "PENDING",
|
|
192
|
+
/** 处理中 */
|
|
193
|
+
PROCESSING = "PROCESSING",
|
|
194
|
+
/** 已完成 */
|
|
195
|
+
COMPLETED = "COMPLETED",
|
|
196
|
+
/** 失败 */
|
|
197
|
+
FAILED = "FAILED",
|
|
198
|
+
/** 部分失败 */
|
|
199
|
+
PARTIAL_FAILED = "PARTIAL_FAILED"
|
|
200
|
+
}
|
|
170
201
|
/** 支付渠道 */
|
|
171
202
|
enum PayChannel {
|
|
172
203
|
/** 微信支付 */
|
|
@@ -394,4 +425,8 @@ export declare namespace ENUM_CN {
|
|
|
394
425
|
const ReverseRefundType: Record<ENUM.ReverseRefundType, string>;
|
|
395
426
|
/** 退款方式中文映射 */
|
|
396
427
|
const ReverseRefundWay: Record<ENUM.ReverseRefundWay, string>;
|
|
428
|
+
/** 批量退款模式中文映射 */
|
|
429
|
+
const BatchRefundMode: Record<ENUM.BatchRefundMode, string>;
|
|
430
|
+
/** 批量退款批次状态中文映射 */
|
|
431
|
+
const BatchRefundStatus: Record<ENUM.BatchRefundStatus, string>;
|
|
397
432
|
}
|
package/enums.js
CHANGED
|
@@ -71,6 +71,16 @@ var ENUM;
|
|
|
71
71
|
/** 支付失败 */
|
|
72
72
|
OrderPayStatus["FAILED"] = "FAILED";
|
|
73
73
|
})(OrderPayStatus = ENUM.OrderPayStatus || (ENUM.OrderPayStatus = {}));
|
|
74
|
+
/** 微信支付方式 */
|
|
75
|
+
let WePayWay;
|
|
76
|
+
(function (WePayWay) {
|
|
77
|
+
/** H5支付 */
|
|
78
|
+
WePayWay["H5"] = "H5";
|
|
79
|
+
/** 小程序JSAPI支付 */
|
|
80
|
+
WePayWay["JSAPI"] = "JSAPI";
|
|
81
|
+
/** APP支付 */
|
|
82
|
+
WePayWay["APP"] = "APP";
|
|
83
|
+
})(WePayWay = ENUM.WePayWay || (ENUM.WePayWay = {}));
|
|
74
84
|
/** 退款状态 */
|
|
75
85
|
let OrderRefundStatus;
|
|
76
86
|
(function (OrderRefundStatus) {
|
|
@@ -185,6 +195,30 @@ var ENUM;
|
|
|
185
195
|
/** 商家主动退款 */
|
|
186
196
|
ReverseRefundWay["MERCHANT_MANUAL"] = "MERCHANT_MANUAL";
|
|
187
197
|
})(ReverseRefundWay = ENUM.ReverseRefundWay || (ENUM.ReverseRefundWay = {}));
|
|
198
|
+
/** 批量退款模式 */
|
|
199
|
+
let BatchRefundMode;
|
|
200
|
+
(function (BatchRefundMode) {
|
|
201
|
+
/** 退货退款(全单退) */
|
|
202
|
+
BatchRefundMode["RETURN_AND_REFUND"] = "RETURN_AND_REFUND";
|
|
203
|
+
/** 仅退款-按每份固定金额退款 */
|
|
204
|
+
BatchRefundMode["REFUND_ONLY_FIXED"] = "REFUND_ONLY_FIXED";
|
|
205
|
+
/** 仅退款-按每份可退金额退款(退订单剩余全部金额) */
|
|
206
|
+
BatchRefundMode["REFUND_ONLY_MAX"] = "REFUND_ONLY_MAX";
|
|
207
|
+
})(BatchRefundMode = ENUM.BatchRefundMode || (ENUM.BatchRefundMode = {}));
|
|
208
|
+
/** 批量退款批次状态 */
|
|
209
|
+
let BatchRefundStatus;
|
|
210
|
+
(function (BatchRefundStatus) {
|
|
211
|
+
/** 待处理 */
|
|
212
|
+
BatchRefundStatus["PENDING"] = "PENDING";
|
|
213
|
+
/** 处理中 */
|
|
214
|
+
BatchRefundStatus["PROCESSING"] = "PROCESSING";
|
|
215
|
+
/** 已完成 */
|
|
216
|
+
BatchRefundStatus["COMPLETED"] = "COMPLETED";
|
|
217
|
+
/** 失败 */
|
|
218
|
+
BatchRefundStatus["FAILED"] = "FAILED";
|
|
219
|
+
/** 部分失败 */
|
|
220
|
+
BatchRefundStatus["PARTIAL_FAILED"] = "PARTIAL_FAILED";
|
|
221
|
+
})(BatchRefundStatus = ENUM.BatchRefundStatus || (ENUM.BatchRefundStatus = {}));
|
|
188
222
|
/** 支付渠道 */
|
|
189
223
|
let PayChannel;
|
|
190
224
|
(function (PayChannel) {
|
|
@@ -523,4 +557,18 @@ var ENUM_CN;
|
|
|
523
557
|
[ENUM.ReverseRefundWay.FAST]: '极速退款',
|
|
524
558
|
[ENUM.ReverseRefundWay.MERCHANT_MANUAL]: '商家主动退款',
|
|
525
559
|
};
|
|
560
|
+
/** 批量退款模式中文映射 */
|
|
561
|
+
ENUM_CN.BatchRefundMode = {
|
|
562
|
+
[ENUM.BatchRefundMode.RETURN_AND_REFUND]: '退货退款(全单退)',
|
|
563
|
+
[ENUM.BatchRefundMode.REFUND_ONLY_FIXED]: '仅退款-按固定金额',
|
|
564
|
+
[ENUM.BatchRefundMode.REFUND_ONLY_MAX]: '仅退款-按可退金额',
|
|
565
|
+
};
|
|
566
|
+
/** 批量退款批次状态中文映射 */
|
|
567
|
+
ENUM_CN.BatchRefundStatus = {
|
|
568
|
+
[ENUM.BatchRefundStatus.PENDING]: '待处理',
|
|
569
|
+
[ENUM.BatchRefundStatus.PROCESSING]: '处理中',
|
|
570
|
+
[ENUM.BatchRefundStatus.COMPLETED]: '已完成',
|
|
571
|
+
[ENUM.BatchRefundStatus.FAILED]: '失败',
|
|
572
|
+
[ENUM.BatchRefundStatus.PARTIAL_FAILED]: '部分失败',
|
|
573
|
+
};
|
|
526
574
|
})(ENUM_CN || (exports.ENUM_CN = ENUM_CN = {}));
|
|
@@ -284,6 +284,10 @@ export declare namespace PosOrderQueryService {
|
|
|
284
284
|
productDispatch: string;
|
|
285
285
|
orderType: ENUM.OrderType;
|
|
286
286
|
liveRoomGroupName?: string;
|
|
287
|
+
/** 直播间ID */
|
|
288
|
+
liveRoomId?: string;
|
|
289
|
+
/** 直播间名称 */
|
|
290
|
+
liveRoomName?: string;
|
|
287
291
|
/** 门店ID */
|
|
288
292
|
storeId?: string;
|
|
289
293
|
/** 门店名称 */
|
|
@@ -476,6 +480,8 @@ export declare namespace PosOrderQueryService {
|
|
|
476
480
|
orderType: ENUM.OrderType;
|
|
477
481
|
dispatchWay: string;
|
|
478
482
|
productPick: string;
|
|
483
|
+
/** 直播间名称 */
|
|
484
|
+
liveRoomName?: string;
|
|
479
485
|
store: {
|
|
480
486
|
storeId: string;
|
|
481
487
|
storeName: string;
|
|
@@ -63,10 +63,29 @@ export declare namespace RosOrderCoreService {
|
|
|
63
63
|
/** 未核销份数 */
|
|
64
64
|
unVerifiedNum?: number;
|
|
65
65
|
}
|
|
66
|
+
interface IBatchRefundByExcel {
|
|
67
|
+
/** Excel文件URL(腾讯COS链接) */
|
|
68
|
+
fileUrl: string;
|
|
69
|
+
/** 退款模式 */
|
|
70
|
+
refundMode: ENUM.BatchRefundMode;
|
|
71
|
+
/** 操作人ID */
|
|
72
|
+
operatorId: string;
|
|
73
|
+
/** 操作人姓名 */
|
|
74
|
+
operatorName: string;
|
|
75
|
+
}
|
|
66
76
|
}
|
|
67
77
|
namespace Response {
|
|
68
78
|
type IOrderApproval = void;
|
|
69
79
|
type IOrderCreate = void;
|
|
80
|
+
interface IBatchRefundByExcel {
|
|
81
|
+
/** 批次ID(仅校验通过时返回) */
|
|
82
|
+
batchId?: string;
|
|
83
|
+
/** 错误详情(如果有校验错误) */
|
|
84
|
+
msgErrors?: Array<{
|
|
85
|
+
row: number;
|
|
86
|
+
error: string;
|
|
87
|
+
}>;
|
|
88
|
+
}
|
|
70
89
|
}
|
|
71
90
|
}
|
|
72
91
|
namespace ByJob {
|
|
@@ -116,6 +135,8 @@ export declare namespace RosOrderCoreService {
|
|
|
116
135
|
orderApproval(request: ByWeb.Request.IOrderApproval, req: any): Promise<ByWeb.Response.IOrderApproval>;
|
|
117
136
|
/** 商家主动发起逆向退款订单 */
|
|
118
137
|
orderCreate(request: ByWeb.Request.IOrderCreate, req: any): Promise<ByWeb.Response.IOrderCreate>;
|
|
138
|
+
/** 批量退款(通过Excel) */
|
|
139
|
+
batchRefundByExcel(request: ByWeb.Request.IBatchRefundByExcel, req: any): Promise<ByWeb.Response.IBatchRefundByExcel>;
|
|
119
140
|
}
|
|
120
141
|
interface CoreByJobController {
|
|
121
142
|
autoApprove(request: ByJob.Request.IAutoApprove, req: any): Promise<void>;
|
|
@@ -4,6 +4,7 @@ declare class RosOrderCoreByWebService extends BaseService implements RosOrderCo
|
|
|
4
4
|
protected prefixUrl: string;
|
|
5
5
|
orderApproval(request: RosOrderCoreService.ByWeb.Request.IOrderApproval): Promise<RosOrderCoreService.ByWeb.Response.IOrderApproval>;
|
|
6
6
|
orderCreate(request: RosOrderCoreService.ByWeb.Request.IOrderCreate): Promise<RosOrderCoreService.ByWeb.Response.IOrderCreate>;
|
|
7
|
+
batchRefundByExcel(request: RosOrderCoreService.ByWeb.Request.IBatchRefundByExcel): Promise<RosOrderCoreService.ByWeb.Response.IBatchRefundByExcel>;
|
|
7
8
|
}
|
|
8
9
|
export declare const orderCoreByWebService: RosOrderCoreByWebService;
|
|
9
10
|
export default orderCoreByWebService;
|
|
@@ -27,6 +27,9 @@ let RosOrderCoreByWebService = class RosOrderCoreByWebService extends BaseServic
|
|
|
27
27
|
orderCreate(request) {
|
|
28
28
|
return (0, http_1.callApi)(this.getApiUrl(this.orderCreate), request);
|
|
29
29
|
}
|
|
30
|
+
batchRefundByExcel(request) {
|
|
31
|
+
return (0, http_1.callApi)(this.getApiUrl(this.batchRefundByExcel), request);
|
|
32
|
+
}
|
|
30
33
|
};
|
|
31
34
|
__decorate([
|
|
32
35
|
(0, tsoa_1.OperationId)('批量审批退款订单'),
|
|
@@ -38,6 +41,11 @@ __decorate([
|
|
|
38
41
|
(0, tsoa_1.Post)('order-create'),
|
|
39
42
|
__param(0, (0, tsoa_1.Body)())
|
|
40
43
|
], RosOrderCoreByWebService.prototype, "orderCreate", null);
|
|
44
|
+
__decorate([
|
|
45
|
+
(0, tsoa_1.OperationId)('批量退款(通过Excel)'),
|
|
46
|
+
(0, tsoa_1.Post)('batch-refund-by-excel'),
|
|
47
|
+
__param(0, (0, tsoa_1.Body)())
|
|
48
|
+
], RosOrderCoreByWebService.prototype, "batchRefundByExcel", null);
|
|
41
49
|
RosOrderCoreByWebService = __decorate([
|
|
42
50
|
(0, tsoa_1.Route)('ros/core/web'),
|
|
43
51
|
(0, tsoa_1.Tags)('RosOrderCore')
|
|
@@ -129,6 +129,17 @@ export declare namespace RosOrderQueryService {
|
|
|
129
129
|
/** 退款份数 */
|
|
130
130
|
quantity: number;
|
|
131
131
|
}
|
|
132
|
+
interface IBatchRefundList {
|
|
133
|
+
/** 操作人ID(可选) */
|
|
134
|
+
operatorId?: string;
|
|
135
|
+
/** 批次状态(可选) */
|
|
136
|
+
status?: ENUM.BatchRefundStatus;
|
|
137
|
+
/** 分页参数 */
|
|
138
|
+
pagination: {
|
|
139
|
+
pageIndex: number;
|
|
140
|
+
pageSize: number;
|
|
141
|
+
};
|
|
142
|
+
}
|
|
132
143
|
}
|
|
133
144
|
namespace Response {
|
|
134
145
|
interface IOrderList {
|
|
@@ -276,6 +287,53 @@ export declare namespace RosOrderQueryService {
|
|
|
276
287
|
/** 待商家审核的订单数量 */
|
|
277
288
|
count: number;
|
|
278
289
|
}
|
|
290
|
+
interface IBatchRefundListItem {
|
|
291
|
+
/** 批次ID */
|
|
292
|
+
id: string;
|
|
293
|
+
/** 操作人ID */
|
|
294
|
+
operatorId: string;
|
|
295
|
+
/** 操作人姓名 */
|
|
296
|
+
operatorName: string;
|
|
297
|
+
/** 退款模式 */
|
|
298
|
+
refundMode: ENUM.BatchRefundMode;
|
|
299
|
+
/** 订单数量 */
|
|
300
|
+
orderCount: number;
|
|
301
|
+
/** 成功数量 */
|
|
302
|
+
successCount: number;
|
|
303
|
+
/** 失败数量 */
|
|
304
|
+
failCount: number;
|
|
305
|
+
/** 批次状态 */
|
|
306
|
+
status: ENUM.BatchRefundStatus;
|
|
307
|
+
/** 预计退款金额(分) */
|
|
308
|
+
expectedRefundAmount: number;
|
|
309
|
+
/** 实际退款金额(分) */
|
|
310
|
+
actualRefundAmount: number;
|
|
311
|
+
/** 预计退还优惠券数量 */
|
|
312
|
+
expectedRefundCouponCount: number;
|
|
313
|
+
/** 实际退还优惠券数量 */
|
|
314
|
+
actualRefundCouponCount: number;
|
|
315
|
+
/** 预计退还积分 */
|
|
316
|
+
expectedRefundPoints: number;
|
|
317
|
+
/** 实际退还积分 */
|
|
318
|
+
actualRefundPoints: number;
|
|
319
|
+
/** Excel文件URL */
|
|
320
|
+
excelFileUrl: string;
|
|
321
|
+
/** 错误详情 */
|
|
322
|
+
msgErrors: Array<{
|
|
323
|
+
row: number;
|
|
324
|
+
error: string;
|
|
325
|
+
}>;
|
|
326
|
+
/** 创建时间 */
|
|
327
|
+
createdAt: number;
|
|
328
|
+
/** 更新时间 */
|
|
329
|
+
updatedAt: number;
|
|
330
|
+
}
|
|
331
|
+
interface IBatchRefundList {
|
|
332
|
+
/** 列表数据 */
|
|
333
|
+
list: IBatchRefundListItem[];
|
|
334
|
+
/** 总记录数 */
|
|
335
|
+
total: number;
|
|
336
|
+
}
|
|
279
337
|
}
|
|
280
338
|
interface QueryByWebController {
|
|
281
339
|
orderList(request: RosOrderQueryService.Request.IOrderList): Promise<DTO.ReverseQueryResult[]>;
|
|
@@ -287,6 +345,8 @@ export declare namespace RosOrderQueryService {
|
|
|
287
345
|
getApplyRefundInfo(request: RosOrderQueryService.Request.IGetApplyRefundInfo): Promise<RosOrderQueryService.Response.IGetApplyRefundInfo>;
|
|
288
346
|
/** 统计待商家审核的订单数量 */
|
|
289
347
|
countPendingOrders(): Promise<RosOrderQueryService.Response.ICountPendingOrders>;
|
|
348
|
+
/** 查询批量退款批次列表 */
|
|
349
|
+
batchRefundList(request: RosOrderQueryService.Request.IBatchRefundList, req: any): Promise<RosOrderQueryService.Response.IBatchRefundList>;
|
|
290
350
|
}
|
|
291
351
|
namespace ByUser {
|
|
292
352
|
namespace Request {
|
|
@@ -9,6 +9,7 @@ declare class OrderQueryByWebService extends BaseService implements RosOrderQuer
|
|
|
9
9
|
orderExportByIds(request: RosOrderQueryService.Request.IExportOrderDataByIds): Promise<RosOrderQueryService.Response.IExportOrderDataByIds>;
|
|
10
10
|
getApplyRefundInfo(request: RosOrderQueryService.Request.IGetApplyRefundInfo): Promise<RosOrderQueryService.Response.IGetApplyRefundInfo>;
|
|
11
11
|
countPendingOrders(): Promise<RosOrderQueryService.Response.ICountPendingOrders>;
|
|
12
|
+
batchRefundList(request: RosOrderQueryService.Request.IBatchRefundList): Promise<RosOrderQueryService.Response.IBatchRefundList>;
|
|
12
13
|
}
|
|
13
14
|
export declare const orderQueryByWebService: OrderQueryByWebService;
|
|
14
15
|
export default orderQueryByWebService;
|
|
@@ -39,6 +39,9 @@ let OrderQueryByWebService = class OrderQueryByWebService extends BaseService_1.
|
|
|
39
39
|
countPendingOrders() {
|
|
40
40
|
return (0, http_1.callApi)(this.getApiUrl(this.countPendingOrders));
|
|
41
41
|
}
|
|
42
|
+
batchRefundList(request) {
|
|
43
|
+
return (0, http_1.callApi)(this.getApiUrl(this.batchRefundList), request);
|
|
44
|
+
}
|
|
42
45
|
};
|
|
43
46
|
__decorate([
|
|
44
47
|
(0, tsoa_1.OperationId)('订单列表查询, 给外部服务使用'),
|
|
@@ -69,6 +72,11 @@ __decorate([
|
|
|
69
72
|
(0, tsoa_1.OperationId)('统计待商家审核的订单数量'),
|
|
70
73
|
(0, tsoa_1.Post)('count-pending-orders')
|
|
71
74
|
], OrderQueryByWebService.prototype, "countPendingOrders", null);
|
|
75
|
+
__decorate([
|
|
76
|
+
(0, tsoa_1.OperationId)('查询批量退款批次列表'),
|
|
77
|
+
(0, tsoa_1.Post)('batch-refund-list'),
|
|
78
|
+
__param(0, (0, tsoa_1.Body)())
|
|
79
|
+
], OrderQueryByWebService.prototype, "batchRefundList", null);
|
|
72
80
|
OrderQueryByWebService = __decorate([
|
|
73
81
|
(0, tsoa_1.Route)('ros/query/web'),
|
|
74
82
|
(0, tsoa_1.Tags)('RosOrderQuery')
|
package/package.json
CHANGED
package/types.d.ts
CHANGED
|
@@ -200,6 +200,8 @@ export interface IBizExtraInfo {
|
|
|
200
200
|
skuId: string;
|
|
201
201
|
/** 退款金额(资金类型时) */
|
|
202
202
|
amount?: number;
|
|
203
|
+
/** 订单总金额(资金类型时) */
|
|
204
|
+
totalAmount?: number;
|
|
203
205
|
/** 退款积分数量(积分类型时) */
|
|
204
206
|
pointNum?: number;
|
|
205
207
|
/** 退款券列表(优惠券类型时) */
|
|
@@ -208,6 +210,10 @@ export interface IBizExtraInfo {
|
|
|
208
210
|
name: string;
|
|
209
211
|
code: string;
|
|
210
212
|
}[];
|
|
213
|
+
/** 小程序 appId(资金类型时,从支付记录获取) */
|
|
214
|
+
appId?: string;
|
|
215
|
+
/** 支付渠道(资金类型时,用于退款) */
|
|
216
|
+
payChannel?: ENUM.PayChannel;
|
|
211
217
|
/** 商户号信息(资金类型时,用于退款) */
|
|
212
218
|
merchantInfo?: IMerchantInfo;
|
|
213
219
|
}
|
|
@@ -274,6 +280,8 @@ export interface PosOrderPayload {
|
|
|
274
280
|
quantity?: number;
|
|
275
281
|
/** 订单实付金额 */
|
|
276
282
|
actualAmount?: number;
|
|
283
|
+
/** 剩余可退金额 */
|
|
284
|
+
remainingAmount?: number;
|
|
277
285
|
/** 直播间ID */
|
|
278
286
|
liveRoomId?: string;
|
|
279
287
|
}
|