tmc.js 0.3.33 → 0.3.35

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.
Files changed (49) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +4 -4
  3. package/package.json +1 -1
  4. package/types/ae.d.ts +12 -0
  5. package/types/ali.d.ts +61 -0
  6. package/types/alibaba.d.ts +2592 -145
  7. package/types/alicom.d.ts +127 -1
  8. package/types/aliexpress.d.ts +153 -11
  9. package/types/alihealth.d.ts +189 -3
  10. package/types/alihouse.d.ts +169 -0
  11. package/types/alios.d.ts +45 -0
  12. package/types/alipay.d.ts +479 -0
  13. package/types/alisports.d.ts +18 -0
  14. package/types/alitrip.d.ts +264 -16
  15. package/types/aliyun.d.ts +94 -1
  16. package/types/alsc.d.ts +329 -0
  17. package/types/ascp.d.ts +26 -1
  18. package/types/banma.d.ts +1 -1
  19. package/types/cainiao.d.ts +979 -2
  20. package/types/damai.d.ts +107 -7
  21. package/types/ele.d.ts +10 -0
  22. package/types/eleme.d.ts +71 -0
  23. package/types/fliggy.d.ts +95 -5
  24. package/types/fuwu.d.ts +2 -2
  25. package/types/gaode.d.ts +16 -0
  26. package/types/genie.d.ts +22 -0
  27. package/types/global.d.ts +22 -0
  28. package/types/gov.d.ts +160 -2
  29. package/types/icbu.d.ts +124 -0
  30. package/types/idle.d.ts +74 -16
  31. package/types/index.d.ts +3422 -14
  32. package/types/intime.d.ts +37 -0
  33. package/types/jae.d.ts +1 -1
  34. package/types/jym.d.ts +12 -0
  35. package/types/lst.d.ts +2 -2
  36. package/types/message.in.d.ts +3465 -76
  37. package/types/message.out.d.ts +1107 -26
  38. package/types/niaochao.d.ts +3 -3
  39. package/types/taobao.d.ts +3755 -278
  40. package/types/taotao.d.ts +44 -0
  41. package/types/tmall.d.ts +893 -36
  42. package/types/tobao.d.ts +26 -0
  43. package/types/trip.d.ts +6 -6
  44. package/types/umeng.d.ts +10 -0
  45. package/types/wdk.d.ts +30 -4
  46. package/types/xhotel.d.ts +16 -0
  47. package/types/xianyu.d.ts +33 -9
  48. package/types/youku.d.ts +18 -1
  49. package/types/yunos.d.ts +27 -2
@@ -1,6 +1,6 @@
1
1
  /** 菜鸟发货工作台 */
2
2
  declare namespace Cainiao.Consignplatform {
3
- /** 发货工作台下发物流详情消息 */
3
+ /** {@link https://open.taobao.com/tmc.htm?docId=1658&docType=9 发货工作台下发物流详情消息} */
4
4
  interface LogisiticsDetail {
5
5
  /** 快递公司code */
6
6
  cp_code: string;
@@ -27,7 +27,7 @@ declare namespace Cainiao.Consignplatform {
27
27
 
28
28
  /** IoT售后解决方案 */
29
29
  declare namespace Cainiao.Iot {
30
- /** IoT售后工单信息消息 */
30
+ /** {@link https://open.taobao.com/tmc.htm?docId=1771&docType=9 IoT售后工单信息消息} */
31
31
  interface AftersalesTicket {
32
32
  /** 设备条码 */
33
33
  device_bar_code: string;
@@ -37,3 +37,980 @@ declare namespace Cainiao.Iot {
37
37
  ticket_id: number;
38
38
  }
39
39
  }
40
+
41
+ /** 菜鸟 */
42
+ declare namespace Cainiao.Logistics {
43
+ /** {@link https://open.taobao.com/tmc.htm?docId=2352&docType=9 菜鸟物流异常件创建} */
44
+ interface AbnormalOrderCreate {
45
+ /** 异常件ID */
46
+ abnormal_piece_id: string;
47
+ /** 异常件类型 */
48
+ abnormal_type: string;
49
+ /** 疑似订单号 */
50
+ order_id: string;
51
+ /** 照片详情 */
52
+ pic_detail: string;
53
+ /** 商家ID */
54
+ seller_id: string;
55
+ /** 疑似运单号 */
56
+ sid: string;
57
+ /** 状态 */
58
+ status: string;
59
+ }
60
+
61
+ /** {@link https://open.taobao.com/tmc.htm?docId=2353&docType=9 异常件变更消息} */
62
+ interface AbnormalOrderUpdate {
63
+ /** 异常件ID */
64
+ abnormal_piece_id: string;
65
+ /** 异常件类型 */
66
+ abnormal_type: string;
67
+ /** 疑似订单号 */
68
+ order_id: string;
69
+ /** 状态:3快递同意/4快递驳回/5失效 */
70
+ status: string;
71
+ /** 疑似运单号 */
72
+ waybill_no: string;
73
+ }
74
+ }
75
+
76
+ /** 菜鸟 */
77
+ declare namespace Cainiao.Moduan {
78
+ /** {@link https://open.taobao.com/tmc.htm?docId=1037&docType=9 异常订单预警通知} */
79
+ interface AlertOrder {
80
+ /** 预警级别,目前1为黄,2为红 */
81
+ alert_level: number;
82
+ /** 预警原因 */
83
+ alert_reason_cn: string;
84
+ /** 小件员注册手机 */
85
+ deilver_mobile: string;
86
+ /** 小件员id */
87
+ delivery_user_id: string;
88
+ /** 小件员nick */
89
+ deliver_nick: string;
90
+ /** 小件员真实姓名 */
91
+ deliver_real_name: string;
92
+ /** 接单时间 */
93
+ grasp_date: string;
94
+ /** Lp订单号,唯一键 */
95
+ lp_code: string;
96
+ /** 运单号 */
97
+ mail_no?: string;
98
+ /** 收件人姓名 */
99
+ receiver_name?: string;
100
+ /** 寄件人姓名 */
101
+ sender_name?: string;
102
+ /** 任务Id,唯一键 */
103
+ task_id: string;
104
+ }
105
+
106
+ /** {@link https://open.taobao.com/tmc.htm?docId=948&docType=9 任务取消消息推送} */
107
+ interface CancelTask {
108
+ /** 取消补贴,接单3分钟后取消有补贴 */
109
+ cancel_allownce_amount?: string;
110
+ /** 取消原因 */
111
+ cancel_reason?: string;
112
+ /** 取消原因id */
113
+ cancel_reason_id?: number;
114
+ /** 取消时间 */
115
+ end_time: Date | number | string;
116
+ /** 消息类型 */
117
+ message_type: number;
118
+ /** 任务id */
119
+ task_id: number;
120
+ }
121
+
122
+ /** {@link https://open.taobao.com/tmc.htm?docId=1087&docType=9 运单号更新} */
123
+ interface CommonMailnoUpdated {
124
+ /** 更新运单号 */
125
+ new_mailno: string;
126
+ /** 外部订单列表 */
127
+ out_order_ids: string[];
128
+ /** 外部用户ID */
129
+ out_user_id: string;
130
+ /** 菜鸟末端订单ID */
131
+ td_order_id: number;
132
+ /** 更新订单时间 */
133
+ update_time: Date | number | string;
134
+ }
135
+
136
+ /** {@link https://open.taobao.com/tmc.htm?docId=1071&docType=9 订单取消} */
137
+ interface CommonOrderCanceled {
138
+ /** 取消代码 */
139
+ cancel_reason_code?: string;
140
+ /** 取消消息 */
141
+ cancel_reason_msg?: string;
142
+ /** 取消角色 */
143
+ cancel_role?: string;
144
+ /** 取消时间 */
145
+ cancel_time: Date | number | string;
146
+ /** 外部订单ID */
147
+ out_order_ids?: string[];
148
+ /** 外部用户ID */
149
+ out_user_id: string;
150
+ /** 内部订单ID */
151
+ td_order_id: number;
152
+ }
153
+
154
+ /** {@link https://open.taobao.com/tmc.htm?docId=1082&docType=9 普通寄件接单消息} */
155
+ interface CommonOrderGrasped {
156
+ /** 小件员名称 */
157
+ delivery_name: string;
158
+ /** 小件员电话 */
159
+ delivery_phone: string;
160
+ /** 预计上门揽件时间 */
161
+ expect_got_time: Date | number | string;
162
+ /** 接单CPCODE(内部CP) */
163
+ grasp_cp_code?: string;
164
+ /** 接单CP名称(内部CP) */
165
+ grasp_cp_name?: string;
166
+ /** 初始接单时间 */
167
+ grasp_time: Date | number | string;
168
+ /** 外部订单ID列表 */
169
+ out_order_ids: string[];
170
+ /** 外部用户ID */
171
+ out_user_id: string;
172
+ /** 末端订单ID */
173
+ td_order_id: number;
174
+ /** 更新时间(改派的时间以此为准) */
175
+ update_time: Date | number | string;
176
+ }
177
+
178
+ /** {@link https://open.taobao.com/tmc.htm?docId=1084&docType=9 回单消息} */
179
+ interface CommonOrderMailnoReturned {
180
+ /** 运单号 */
181
+ mailno: string;
182
+ /** 外部订单ID列表 */
183
+ out_order_ids?: string[];
184
+ /** 外部用户ID */
185
+ out_user_id: string;
186
+ /** 回单CP */
187
+ return_mailno_cp_code: string;
188
+ /** 回单CP名称 */
189
+ return_mailno_cp_name: string;
190
+ /** 回单时间 */
191
+ return_mailno_time: Date | number | string;
192
+ /** 末端订单ID */
193
+ td_order_id: number;
194
+ }
195
+
196
+ /** {@link https://open.taobao.com/tmc.htm?docId=1083&docType=9 揽件消息} */
197
+ interface CommonOrderPickup {
198
+ /** 订单价格 */
199
+ order_price?: string;
200
+ /** 外部订单ID */
201
+ out_order_ids?: string[];
202
+ /** 外部用户ID */
203
+ out_user_id: string;
204
+ /** 揽件时间 */
205
+ pickup_time: Date | number | string;
206
+ /** 末端内部订单ID */
207
+ td_order_id: number;
208
+ /** 订单重量 */
209
+ weight?: number;
210
+ }
211
+
212
+ /** {@link https://open.taobao.com/tmc.htm?docId=1086&docType=9 支付订单超时} */
213
+ interface CommonWaitWithholdTimeOut {
214
+ /** 超时时间 */
215
+ expire_time: Date | number | string;
216
+ /** 外部订单ID列表 */
217
+ out_order_ids: string[];
218
+ /** 外部用户ID */
219
+ out_user_id: string;
220
+ /** 菜鸟末端订单ID */
221
+ td_order_id: number;
222
+ }
223
+
224
+ /** {@link https://open.taobao.com/tmc.htm?docId=1085&docType=9 代扣结果通知} */
225
+ interface CommonWithholdResult {
226
+ /** 订单金额 */
227
+ order_price?: string;
228
+ /** 外部订单ID列表 */
229
+ out_order_ids?: string[];
230
+ /** 外部用户ID */
231
+ out_user_id: string;
232
+ /** 代扣结果 */
233
+ result: boolean;
234
+ /** 末端订单ID */
235
+ td_order_id: number;
236
+ /** 重量 */
237
+ weight?: number;
238
+ /** 最后代扣时间 */
239
+ withhold_time: Date | number | string;
240
+ }
241
+
242
+ /** {@link https://open.taobao.com/tmc.htm?docId=981&docType=9 小件员账号同步} */
243
+ interface CourierAccountSync {
244
+ /** 小件员菜鸟账号ID */
245
+ account_id: string;
246
+ /** 小件员手机号 */
247
+ courier_mobile?: string;
248
+ /** 小件员姓名 */
249
+ courier_name?: string;
250
+ /** 菜鸟账单 */
251
+ delivery_cp_user_id: string;
252
+ /** 小件员所属CP员工号 */
253
+ employee_no?: string;
254
+ /** 认证是否成功 */
255
+ is_success?: boolean;
256
+ /** 认证失败原因 */
257
+ status_message?: string;
258
+ }
259
+
260
+ /** {@link https://open.taobao.com/tmc.htm?docId=1030&docType=9 创建预约订单通知} */
261
+ interface CreateAppointOrder {
262
+ /** 预约日期 */
263
+ appoint_day?: string;
264
+ /** 预约时间终点 */
265
+ appoint_time_end: string;
266
+ /** 预约时间起点 */
267
+ appoint_time_start: string;
268
+ /** 业务类型,1-预约派送订单 */
269
+ biz_type: number;
270
+ /** 创建时间 */
271
+ gmt_create: Date | number | string;
272
+ /** 修改时间 */
273
+ gmt_modified: Date | number | string;
274
+ /** Lp订单号,唯一键 */
275
+ lp_code: string;
276
+ /** 运单号 */
277
+ mail_no: string;
278
+ /** CP分账金额,单位:元 */
279
+ money_cp?: string;
280
+ /** 小件员分账金额,单位:元 */
281
+ money_deliver?: string;
282
+ /** 预约订单号,唯一键 */
283
+ order_id: string;
284
+ /** 订单状态,10:有效订单 */
285
+ order_status: number;
286
+ /** 收件人详细地址 */
287
+ receiver_address: string;
288
+ /** 寄件人所在市 */
289
+ receiver_city: string;
290
+ /** 寄件人所在区/县 */
291
+ receiver_district?: string;
292
+ /** 收件人姓名 */
293
+ receiver_name: string;
294
+ /** 寄件人所在省 */
295
+ receiver_province: string;
296
+ /** 末端网点code */
297
+ receive_branch_code?: string;
298
+ /** 末端网点信息 */
299
+ receive_branch_name?: string;
300
+ /** 服务订单价格 */
301
+ service_price?: string;
302
+ /** 二段码+三段码 */
303
+ three_segment_code?: string;
304
+ }
305
+
306
+ /** {@link https://open.taobao.com/tmc.htm?docId=944&docType=9 直送任务广播} */
307
+ interface DispatchTask {
308
+ /** 消息类型 */
309
+ message_type: number;
310
+ /** 奖励金额 */
311
+ reward?: string;
312
+ /** {} */
313
+ tasks: string;
314
+ /** 任务组id */
315
+ task_group_id: string;
316
+ /** 任务数量 */
317
+ task_nums: number;
318
+ }
319
+
320
+ /** {@link https://open.taobao.com/tmc.htm?docId=1092&docType=9 公益数据对接下发} */
321
+ interface GongyiData {
322
+ /** 捐赠日期 */
323
+ donation_date?: Date | number | string;
324
+ /** 捐赠人ID */
325
+ donation_guoguo_id?: string;
326
+ /** 捐赠人手机号 */
327
+ donator_mobile?: string;
328
+ /** 捐赠人姓名 */
329
+ donator_name?: string;
330
+ /** 快递公司名称 */
331
+ express_name?: string;
332
+ /** 寄件人所在地址 */
333
+ from_address?: string;
334
+ /** 寄件人城市 */
335
+ from_city?: string;
336
+ /** 寄件人所在县 */
337
+ from_county?: string;
338
+ /** 寄件人所在区 */
339
+ from_district?: string;
340
+ /** 寄件人省 */
341
+ from_province?: string;
342
+ /** 捐赠数量 */
343
+ garment_amount?: number;
344
+ /** 裹裹订单iD */
345
+ guoguo_id?: string;
346
+ /** 善淘网 */
347
+ org_name?: string;
348
+ /** 123456789012345 */
349
+ ship_number?: string;
350
+ /** 包裹状态 */
351
+ status?: string;
352
+ }
353
+
354
+ /** {@link https://open.taobao.com/tmc.htm?docId=947&docType=9 直送抢单成功后消息推送} */
355
+ interface GraspedTask {
356
+ /** 消息类型 */
357
+ message_type: number;
358
+ /** 任务组id */
359
+ task_group_id: string;
360
+ /** taskId */
361
+ task_id_list: number[];
362
+ }
363
+
364
+ /** {@link https://open.taobao.com/tmc.htm?docId=1031&docType=9 修改预约订单通知} */
365
+ interface ModifyAppointOrder {
366
+ /** 预约日期 */
367
+ appoint_day?: string;
368
+ /** 预约时间终点 */
369
+ appoint_time_end: string;
370
+ /** 预约时间起点 */
371
+ appoint_time_start: string;
372
+ /** 业务类型,1-预约派送订单 */
373
+ biz_type: number;
374
+ /** 创建时间 */
375
+ gmt_create: Date | number | string;
376
+ /** 修改时间 */
377
+ gmt_modified: Date | number | string;
378
+ /** Lp订单号,唯一键 */
379
+ lp_code: string;
380
+ /** 运单号 */
381
+ mail_no: string;
382
+ /** 1:用户;2:小件员;3:小二;100:系统 */
383
+ modify_operator_type?: string;
384
+ /** CP分账金额,单位:元 */
385
+ money_cp?: string;
386
+ /** 小件员分账金额,单位:元 */
387
+ money_deliver?: string;
388
+ /** 预约订单号,唯一键 */
389
+ order_id: string;
390
+ /** 订单状态,10:有效订单,20:取消订单 */
391
+ order_status: number;
392
+ /** 收件人详细地址 */
393
+ receiver_address: string;
394
+ /** 寄件人所在市 */
395
+ receiver_city: string;
396
+ /** 寄件人所在区/县 */
397
+ receiver_district?: string;
398
+ /** 收件人姓名 */
399
+ receiver_name: string;
400
+ /** 寄件人所在省 */
401
+ receiver_province: string;
402
+ /** 末端网点code */
403
+ receive_branch_code?: string;
404
+ /** 末端网点信息 */
405
+ receive_branch_name?: string;
406
+ /** 二段码+三段码 */
407
+ three_segment_code?: string;
408
+ }
409
+
410
+ /** {@link https://open.taobao.com/tmc.htm?docId=854&docType=9 末端订单转账结果通知} */
411
+ interface OrderFeeTrans {
412
+ /** cp_code */
413
+ cp_code?: string;
414
+ /** 扩展字段 */
415
+ extension: string;
416
+ /** 费用 */
417
+ fee: string;
418
+ /** 1运费 2补贴 */
419
+ fee_type: string;
420
+ /** lpcode */
421
+ lp_code?: string;
422
+ /** 运单号 */
423
+ mail_no?: string;
424
+ /** 订单号 */
425
+ order_id: string;
426
+ /** 1在线支付 */
427
+ pay_status: number;
428
+ }
429
+
430
+ /** {@link https://open.taobao.com/tmc.htm?docId=989&docType=9 小件员已接单推送信息} */
431
+ interface OrderGrasp {
432
+ /** 小件员姓名 */
433
+ delivery_name: string;
434
+ /** 小件员电话 */
435
+ delivery_phone: string;
436
+ /** 接单时间 */
437
+ grasp_time: string;
438
+ /** 订单ID */
439
+ out_order_id: string;
440
+ /** 用户ID */
441
+ out_user_id: string;
442
+ }
443
+
444
+ /** {@link https://open.taobao.com/tmc.htm?docId=878&docType=9 菜鸟末端订单信息} */
445
+ interface OrderInfo {
446
+ /** 代收金额 */
447
+ collection_amount?: string;
448
+ /** 代收类型 */
449
+ collection_type?: string;
450
+ /** 快递公司code */
451
+ cp_code?: string;
452
+ /** 客户声明价值 */
453
+ customer_declaration_value?: string;
454
+ /** 送货方式 */
455
+ delivery_type?: string;
456
+ /** json扩展字段 */
457
+ extend_fields?: string;
458
+ /** 创建时间 */
459
+ gmt_create: Date | number | string;
460
+ /** 总件数 */
461
+ goods_count?: string;
462
+ /** 物品类型 */
463
+ goods_type?: string;
464
+ /** 总体积 */
465
+ goods_volume?: string;
466
+ /** 重量 */
467
+ goods_weight?: string;
468
+ /** 取件时间 */
469
+ got_date?: Date | number | string;
470
+ /** 接单时间 */
471
+ grasp_date?: Date | number | string;
472
+ /** 保价费 */
473
+ insurance_fee?: string;
474
+ /** 上门接货 */
475
+ is_pickup_door?: boolean;
476
+ /** 快递单号 */
477
+ mail_no?: string;
478
+ /** 订单号 */
479
+ order_code: string;
480
+ /** 订单来源,固定值 */
481
+ order_from?: string;
482
+ /** 订单金额 */
483
+ order_price?: string;
484
+ /** 订单来源0裹裹1支付宝2天猫 */
485
+ order_source?: string;
486
+ /** 0创建20接单30取件40回传运单 */
487
+ order_status?: string;
488
+ /** 订单类型10抢单11兜底 */
489
+ order_type?: string;
490
+ /** 订单中心外部订单号 */
491
+ out_biz_id?: string;
492
+ /** 支付时间 */
493
+ pay_date?: Date | number | string;
494
+ /** 0未支付1线上支付2线下现金支付 */
495
+ pay_status?: string;
496
+ /** 取件人所属公司名称 */
497
+ pickup_company?: string;
498
+ /** 取件人id */
499
+ pickup_man_id?: string;
500
+ /** 取件人姓名 */
501
+ pickup_man_name?: string;
502
+ /** 取件人手机 */
503
+ pickup_man_phone?: string;
504
+ /** 取件员所属网点 */
505
+ pickup_site?: string;
506
+ /** 首重重量,首重价格,续重价格 */
507
+ price_scheme?: string;
508
+ /** 是否存在价格方案 */
509
+ price_scheme_exist?: boolean;
510
+ /** 服务商ID */
511
+ provider_id?: string;
512
+ /** 收件人地址 */
513
+ receiver_address?: string;
514
+ /** 收件人地址-市 */
515
+ receiver_city?: string;
516
+ /** 收件人公司 */
517
+ receiver_company?: string;
518
+ /** 收件人地址-区 */
519
+ receiver_district?: string;
520
+ /** 收件人姓名 */
521
+ receiver_name?: string;
522
+ /** 收件人电话 */
523
+ receiver_phone?: string;
524
+ /** 收件人地址-省 */
525
+ receiver_province?: string;
526
+ /** 收件人电话 */
527
+ receiver_telephone?: string;
528
+ /** 备注 */
529
+ remark?: string;
530
+ /** 寄件人地址 */
531
+ sender_address?: string;
532
+ /** 寄件地址-市 */
533
+ sender_city?: string;
534
+ /** 寄件人公司 */
535
+ sender_company?: string;
536
+ /** 寄件地址-区 */
537
+ sender_district?: string;
538
+ /** 寄件人姓名 */
539
+ sender_name?: string;
540
+ /** 寄件电话 */
541
+ sender_phone?: string;
542
+ /** 寄件地址-省 */
543
+ sender_province?: string;
544
+ /** 寄件人电话 */
545
+ sender_telephone?: string;
546
+ /** 1001半小时上门 1002两小时上门 */
547
+ service_type?: string;
548
+ /** 特殊商品性质 */
549
+ special_commodity_nature?: string;
550
+ /** 运输方式,默认为快递 */
551
+ transport_type?: string;
552
+ /** 用户ID */
553
+ user_id: number;
554
+ /** 1:轻货,2:重货,3:超重货 */
555
+ weight_type?: string;
556
+ }
557
+
558
+ /** {@link https://open.taobao.com/tmc.htm?docId=990&docType=9 小件员已揽件推送信息} */
559
+ interface OrderPickup {
560
+ /** 订单ID */
561
+ out_order_id: string;
562
+ /** 用户ID */
563
+ out_user_id: string;
564
+ /** 揽收时间 */
565
+ pickup_time: string;
566
+ }
567
+
568
+ /** {@link https://open.taobao.com/tmc.htm?docId=991&docType=9 回传运单号通知} */
569
+ interface OrderReturnMailNO {
570
+ /** 快递单号 */
571
+ mail_no: string;
572
+ /** 订单ID */
573
+ out_order_id: string;
574
+ /** 菜鸟用户ID */
575
+ out_user_id: string;
576
+ /** 回单时间 */
577
+ return_mailno_time: string;
578
+ }
579
+
580
+ /** {@link https://open.taobao.com/tmc.htm?docId=1039&docType=9 申请改派消息} */
581
+ interface RedispatchApplied {
582
+ /** 申请改派时间 */
583
+ apply_time: Date | number | string;
584
+ /** 小件员公司编码 */
585
+ delivery_cp_code: string;
586
+ /** 小件员工号 */
587
+ delivery_cp_user_id: string;
588
+ /** 小件员电话 */
589
+ delivery_mobile_phone?: string;
590
+ /** 菜鸟小件员id */
591
+ delivery_user_id: string;
592
+ /** lp号 */
593
+ lp_code?: string;
594
+ /** 改派原因 */
595
+ redispatch_reason: string;
596
+ /** 任务id */
597
+ task_id: number;
598
+ }
599
+
600
+ /** {@link https://open.taobao.com/tmc.htm?docId=1185&docType=9 签收信息回传} */
601
+ interface SignInfo {
602
+ /** cp编号 */
603
+ delivery_cp_code?: string;
604
+ /** 小件员账号 */
605
+ delivery_cp_user_id?: string;
606
+ /** LP订单号 */
607
+ lp_code: string;
608
+ /** 订单ID */
609
+ order_id: number;
610
+ /** 能力产品 */
611
+ product_code?: string;
612
+ /** 拒收原因(当签收类型是1时此字段为必填项 */
613
+ refuse_reason?: string;
614
+ /** 签收人员 */
615
+ signer?: string;
616
+ /** 签收时间 */
617
+ sign_date?: Date | number | string;
618
+ /** 签收类型(0:签收、1:拒收) */
619
+ sign_type: number;
620
+ /** 任务ID */
621
+ task_id?: number;
622
+ }
623
+
624
+ /** {@link https://open.taobao.com/tmc.htm?docId=940&docType=9 抢单通知} */
625
+ interface TaskAskGrasp {
626
+ /** 通知小件员列表 */
627
+ couriers?: string;
628
+ /** 菜鸟小件员id */
629
+ delivery_user_id?: string;
630
+ /** 补贴,单位:元 */
631
+ reward?: string;
632
+ /** 抢单任务列表 */
633
+ tasks: string;
634
+ /** 抢单的任务组编码 菜鸟支持合单抢单,即一个任务组包含几个订单Task,也可以只有一个订单Task。小件员抢单按任务组进行抢单。 */
635
+ task_group_id: string;
636
+ /** 任务组内任务数 */
637
+ task_nums: number;
638
+ }
639
+
640
+ /** {@link https://open.taobao.com/tmc.htm?docId=933&docType=9 任务被取消} */
641
+ interface TaskCancel {
642
+ /** 取消时间 */
643
+ cancel_date: Date | number | string;
644
+ /** 取消原因 */
645
+ cancel_reason?: string;
646
+ /** 小件员所属公司代码 */
647
+ delivery_cp_code?: string;
648
+ /** 小件员所属公司员工编号 */
649
+ delivery_cp_user_id?: string;
650
+ /** 小件员的手机号 */
651
+ delivery_mobile_phone?: string;
652
+ /** 取消类型(20:寄件人取消 24:小二取消 25:小件员取消 26:系统取消) */
653
+ end_type?: number;
654
+ /** lpCode */
655
+ lp_code?: string;
656
+ /** 能力产品信息 */
657
+ product_code?: string;
658
+ /** taskId */
659
+ task_id: number;
660
+ }
661
+
662
+ /** {@link https://open.taobao.com/tmc.htm?docId=937&docType=9 结算通知} */
663
+ interface TaskFeeTrans {
664
+ /** 小件员所在公司编号 */
665
+ delivery_cp_code?: string;
666
+ /** 小件员员工编号 */
667
+ delivery_cp_user_id?: string;
668
+ /** 费用 */
669
+ fee: string;
670
+ /** 结算时间 */
671
+ fee_date: Date | number | string;
672
+ /** 1运费 2补贴 */
673
+ fee_type: number;
674
+ /** LP订单号 */
675
+ lp_code?: string;
676
+ /** 运单号 */
677
+ mail_no?: string;
678
+ /** 支付状态 0未支付 1线上支付 2线下现金支付 */
679
+ pay_status?: number;
680
+ /** 预计任务补贴 */
681
+ reward?: string;
682
+ /** 任务ID */
683
+ task_id?: number;
684
+ }
685
+
686
+ /** {@link https://open.taobao.com/tmc.htm?docId=932&docType=9 订单被[抢/兜/追/派]后同步给CP} */
687
+ interface TaskGrasp {
688
+ /** 小件员所属公司代码 */
689
+ delivery_cp_code?: string;
690
+ /** 小件员所属公司员工编号 */
691
+ delivery_cp_user_id?: string;
692
+ /** 小件员手机号 */
693
+ delivery_mobile_phone?: string;
694
+ /** 小件员ID */
695
+ delivery_user_id?: string;
696
+ /** 小件员账号类型( NORMAL:普通小件员, BRANCH_GRSAP_MANAGER:网点接单负责人, BRANCH_COMPANY_GRASP_MANAGER:分公司接单负责人, HEAD_COMPANY_GRASP_MANEGER: 总部接单负责人, COMPANY_ACCOUNT:公司帐号 */
697
+ delivery_user_type: string;
698
+ /** 0 抢单 1 追单 2 派单 3 兜底 4 承包 */
699
+ message_type: number;
700
+ /** 能力产品 */
701
+ product_code?: string;
702
+ /** 任务列表 */
703
+ tasks: string;
704
+ /** 任务组编号 */
705
+ task_group: string;
706
+ /** 包含几个订单 */
707
+ task_num: number;
708
+ }
709
+
710
+ /** {@link https://open.taobao.com/tmc.htm?docId=939&docType=9 抢单任务组被抢通知} */
711
+ interface TaskGroupDone {
712
+ /** 抢单的任务组编码 菜鸟支持合单抢单,即一个任务组包含几个订单Task,也可以只有一个订单Task。小件员抢单按任务组进行抢单。 */
713
+ task_group_id: string;
714
+ /** 被抢单任务列表 */
715
+ task_id_list: number[];
716
+ }
717
+
718
+ /** {@link https://open.taobao.com/tmc.htm?docId=938&docType=9 抢单任务组超时通知} */
719
+ interface TaskGroupTimeOut {
720
+ /** 抢单的任务组编码 菜鸟支持合单抢单,即一个任务组包含几个订单Task,也可以只有一个订单Task。小件员抢单按任务组进行抢单。 */
721
+ task_group_id: string;
722
+ /** 任务ID列表 */
723
+ task_id_list: number[];
724
+ }
725
+
726
+ /** {@link https://open.taobao.com/tmc.htm?docId=959&docType=9 兜底任务CP违约通知} */
727
+ interface TaskGroupViolate {
728
+ /** 任务组编号 */
729
+ task_group_id: string;
730
+ /** 任务组包含的任务编号 */
731
+ task_id_list?: number[];
732
+ }
733
+
734
+ /** {@link https://open.taobao.com/tmc.htm?docId=1035&docType=9 修改上门取件时间} */
735
+ interface TaskModifyGotDate {
736
+ /** 小件员所属公司代码 */
737
+ delivery_cp_code?: string;
738
+ /** 小件员所属公司员工编号 */
739
+ delivery_cp_user_id?: string;
740
+ /** 小件员的手机号 */
741
+ delivery_mobile_phone?: string;
742
+ /** 修改后的上门结束时间 */
743
+ got_date_end: string;
744
+ /** 修改后的上门开始时间 */
745
+ got_date_start: string;
746
+ /** LP Code */
747
+ lp_code?: string;
748
+ /** 修改操作时间戳 */
749
+ modify_date?: string;
750
+ /** 操作人角色 1:消费者 4:小件员 */
751
+ modify_role?: number;
752
+ /** taskId */
753
+ task_id: number;
754
+ }
755
+
756
+ /** {@link https://open.taobao.com/tmc.htm?docId=934&docType=9 用户付款通知} */
757
+ interface TaskPaid {
758
+ /** 小件员所在公司编号 */
759
+ delivery_cp_code: string;
760
+ /** 小件员员工编号 */
761
+ delivery_cp_user_id?: string;
762
+ /** 运费金额 */
763
+ delivery_price?: string;
764
+ /** 加价金额 */
765
+ delivery_service_price?: string;
766
+ /** 菜鸟小件员id */
767
+ delivery_user_id: string;
768
+ /** LP订单号 */
769
+ lp_code?: string;
770
+ /** 订单声明价 */
771
+ order_insured_value?: string;
772
+ /** 订单保费 */
773
+ order_insure_price?: string;
774
+ /** 用户应付金额 */
775
+ order_total_price?: string;
776
+ /** 支付时间 */
777
+ pay_date: Date | number | string;
778
+ /** 支付状态 0未支付 1线上支付 2线下现金支付 */
779
+ pay_status: number;
780
+ /** 能力产品编码 */
781
+ product_code?: string;
782
+ /** 任务ID */
783
+ task_id: number;
784
+ }
785
+
786
+ /** {@link https://open.taobao.com/tmc.htm?docId=980&docType=9 仓配派单订单价格通知} */
787
+ interface TaskPriceInfo {
788
+ /** CP编号 */
789
+ delivery_cp_code?: string;
790
+ /** 订单价格信息 */
791
+ delivery_price_infos?: string;
792
+ /** 任务组编号 */
793
+ task_group_id: string;
794
+ }
795
+
796
+ /** {@link https://open.taobao.com/tmc.htm?docId=1177&docType=9 订单改派} */
797
+ interface TaskRedispatch {
798
+ /** CpCode */
799
+ cp_code: string;
800
+ /** 被改派的小件员CP内部账号 */
801
+ from_cp_user_id?: string;
802
+ /** 被改派的小件员包裹侠ID */
803
+ from_delivery_user_id: number;
804
+ /** 改派前小件员账号类型( NORMAL:普通小件员, BRANCH_GRSAP_MANAGER:网点接单负责人, BRANCH_COMPANY_GRASP_MANAGER:分公司接单负责人, HEAD_COMPANY_GRASP_MANEGER: 总部接单负责人, COMPANY_ACCOUNT:公司帐号) */
805
+ from_delivery_user_type?: string;
806
+ /** 被改派的电话号码 */
807
+ from_mobile?: string;
808
+ /** LP号 */
809
+ lp_code: string;
810
+ /** 改派来源:(BIAOJU:裹裹镖局,CP:菜鸟合作伙伴) */
811
+ redispatch_source?: string;
812
+ /** 改派时间 */
813
+ redispatch_time: Date | number | string;
814
+ /** taskId */
815
+ task_id: number;
816
+ /** 接受改派的小件员CP内部账号 */
817
+ to_cp_user_id?: string;
818
+ /** 接受改派的小件员包裹侠ID */
819
+ to_delivery_user_id: number;
820
+ /** 改派后小件员账号类型( NORMAL:普通小件员, BRANCH_GRSAP_MANAGER:网点接单负责人, BRANCH_COMPANY_GRASP_MANAGER:分公司接单负责人, HEAD_COMPANY_GRASP_MANEGER: 总部接单负责人, COMPANY_ACCOUNT:公司帐号) */
821
+ to_delivery_user_type?: string;
822
+ /** 接受改派的电话号码 */
823
+ to_mobile?: string;
824
+ }
825
+
826
+ /** {@link https://open.taobao.com/tmc.htm?docId=936&docType=9 小件员回传运单号通知} */
827
+ interface TaskReturnMailNo {
828
+ /** 快递员调价 */
829
+ ajust_fee?: string;
830
+ /** 物品计价方式:1重量 2体积 */
831
+ calculate_price_type?: number;
832
+ /** 小件员所在公司编号 */
833
+ delivery_cp_code: string;
834
+ /** 小件员员工编号 */
835
+ delivery_cp_user_id?: string;
836
+ /** 运费金额。首重+续重金额-快递员调价 */
837
+ delivery_price?: string;
838
+ /** 加价金额 */
839
+ delivery_service_price?: string;
840
+ /** 菜鸟小件员id */
841
+ delivery_user_id: string;
842
+ /** 物品毛重 单位:千克 */
843
+ gross_weight?: string;
844
+ /** 物品个数 */
845
+ item_count?: number;
846
+ /** 物品标题 */
847
+ item_title?: string;
848
+ /** LP订单号 */
849
+ lp_code?: string;
850
+ /** 运单号 */
851
+ mail_no: string;
852
+ /** 电子面单类型 */
853
+ mail_no_type?: string;
854
+ /** 订单声明价 */
855
+ order_insured_value?: string;
856
+ /** 订单保费 */
857
+ order_insure_price?: string;
858
+ /** 用户实付金额 */
859
+ order_total_price?: string;
860
+ /** 订单支付状态。若订单已支付则显示具体的“现金支付”或者“在线支付”,若未支付则为空 */
861
+ pay_type?: string;
862
+ /** 收件人详细地址 */
863
+ receiver_address?: string;
864
+ /** 收件人所处区 */
865
+ receiver_area?: string;
866
+ /** 收件人所处城市 */
867
+ receiver_city?: string;
868
+ /** 收件人姓名 */
869
+ receiver_name?: string;
870
+ /** 收件人联系方式 */
871
+ receiver_phone?: string;
872
+ /** 收件人所处省份 */
873
+ receiver_province?: string;
874
+ /** 回传运单号时间 */
875
+ return_mailno_date?: Date | number | string;
876
+ /** 寄件人详细地址 */
877
+ sender_address?: string;
878
+ /** 寄件人所处区 */
879
+ sender_area?: string;
880
+ /** 寄件人所处城市 */
881
+ sender_city?: string;
882
+ /** 寄件人姓名 */
883
+ sender_name?: string;
884
+ /** 寄件人联系方式 */
885
+ sender_phone?: string;
886
+ /** 寄件人所处省份 */
887
+ sender_province?: string;
888
+ /** 任务ID */
889
+ task_id: number;
890
+ /** 电子面单编码 */
891
+ way_bill_code?: string;
892
+ /** 电子面单地址 */
893
+ way_bill_short_address?: string;
894
+ }
895
+
896
+ /** {@link https://open.taobao.com/tmc.htm?docId=935&docType=9 小件员已上门取件} */
897
+ interface TaskTaken {
898
+ /** 小件员所属公司代码 */
899
+ delivery_cp_code?: string;
900
+ /** 小件员所属公司员工编号 */
901
+ delivery_cp_user_id?: string;
902
+ /** 小件员手机号 */
903
+ delivery_mobile_phone?: string;
904
+ /** 取件码 */
905
+ got_code: string;
906
+ /** 上门取件时间 */
907
+ got_date: Date | number | string;
908
+ /** LP订单号 */
909
+ lp_code?: string;
910
+ /** 能力产品信息 */
911
+ product_code?: string;
912
+ /** taskId */
913
+ task_id: number;
914
+ }
915
+
916
+ /** {@link https://open.taobao.com/tmc.htm?docId=966&docType=9 用户留言通知} */
917
+ interface UserWord {
918
+ /** 运单号 */
919
+ mail_no: string;
920
+ /** 时间戳 */
921
+ time_stamp: Date | number | string;
922
+ /** 用户留言 */
923
+ user_word: string;
924
+ }
925
+ }
926
+
927
+ /** 菜鸟 */
928
+ declare namespace Cainiao.Scf {
929
+ /** {@link https://open.taobao.com/tmc.htm?docId=1100&docType=9 菜鸟金融贷款通知databus} */
930
+ interface LoanCreate {
931
+ /** 支用金额 */
932
+ 2: string;
933
+ /** 业务的操作场景 */
934
+ "30": string;
935
+ /** 业务创建的来源 */
936
+ "134": string;
937
+ /** 产品接入渠道,请输入申请表格中对应的接入渠道 */
938
+ access_channel: string;
939
+ /** clientIp */
940
+ client_ip?: string;
941
+ /** clientMac */
942
+ client_mac?: string;
943
+ /** umid环境参数 */
944
+ client_pcid_guid: string;
945
+ /** 可贷额度 */
946
+ credit_available_limits: string;
947
+ /** creditLimits,贷款额度 */
948
+ credit_limits: string;
949
+ /** 信贷产品code */
950
+ credit_prod_code: string;
951
+ /** 事件编码 */
952
+ event_code: string;
953
+ /** 放款渠道 */
954
+ loan_channel_type: string;
955
+ /** 产品名称,请输入申请表格中对应的产品名称 */
956
+ product_name: string;
957
+ /** 产品节点(业务场景),请输入申请表格中对应的产品节点 */
958
+ product_node: string;
959
+ /** referer */
960
+ referer: string;
961
+ /** server_ip */
962
+ server_ip: string;
963
+ /** server_name */
964
+ server_name: string;
965
+ /** 会话ID */
966
+ session_id: string;
967
+ /** 应用场景所在系统,请输入申请表格中对应的系统名称 */
968
+ system_name: string;
969
+ /** 消息主题 */
970
+ topic: string;
971
+ /** user_agent */
972
+ user_agent: string;
973
+ /** userId,支付宝用户id */
974
+ user_id: string;
975
+ }
976
+ }
977
+
978
+ /** 菜鸟 */
979
+ declare namespace Cainiao.Waybill {
980
+ /** {@link https://open.taobao.com/tmc.htm?docId=2376&docType=9 单据状态跟踪} */
981
+ interface TrackTicketStatus {
982
+ /** 操作时间 */
983
+ opTime: number;
984
+ /** 外部单号 */
985
+ orderId: string;
986
+ /** 拦截状态 */
987
+ status: string;
988
+ /** 状态描述 */
989
+ statusDesc: string;
990
+ }
991
+ }
992
+
993
+ /** 菜鸟 */
994
+ declare namespace Cainiao.Yima {
995
+ /** {@link https://open.taobao.com/tmc.htm?docId=941&docType=9 短信记录推送} */
996
+ interface SmsRecordPush {
997
+ /** 快递公司工号 */
998
+ cp_user_id: string;
999
+ /** 运单号 */
1000
+ mailno: string;
1001
+ /** 小件员姓名 */
1002
+ name: string;
1003
+ /** 得到短信结果的时间 */
1004
+ result_time: number;
1005
+ /** 短信发送时间 */
1006
+ send_time: number;
1007
+ /** 短信内容 */
1008
+ sms_context: string;
1009
+ /** 1,为成功;2,为失败 */
1010
+ status: number;
1011
+ /** 短信类型 */
1012
+ template_type: string;
1013
+ /** 网点名称 */
1014
+ work_station: string;
1015
+ }
1016
+ }