ztk-rust-sdk 0.1.1

折淘客 (ZheTaoKe/ZTK) Rust SDK - 多平台电商 API 客户端库
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
//! 唯品会平台响应结构体
//!
//! 定义唯品会平台 API 的响应结构体

use serde::Deserialize;

/// 唯品会转链响应
///
/// convert 接口的响应
#[derive(Debug, Clone, Deserialize)]
pub struct VipConvertResponse {
    /// 返回码,0 表示成功
    #[serde(default, rename = "returnCode")]
    pub return_code: Option<String>,
    /// 转链结果
    #[serde(default)]
    pub result: Option<VipConvertResult>,
}

/// 唯品会转链结果
#[derive(Debug, Clone, Deserialize)]
pub struct VipConvertResult {
    /// URL 信息列表
    #[serde(default, rename = "urlInfoList")]
    pub url_info_list: Option<Vec<VipUrlInfo>>,
}

/// 唯品会 URL 信息
#[derive(Debug, Clone, Deserialize)]
pub struct VipUrlInfo {
    /// CPS 短链接
    #[serde(default)]
    pub url: Option<String>,
    /// CPS 长链接
    #[serde(default, rename = "longUrl")]
    pub long_url: Option<String>,
    /// CPS 短链接 (不唤起快应用)
    #[serde(default, rename = "noEvokeUrl")]
    pub no_evoke_url: Option<String>,
    /// CPS 长链接 (不唤起快应用)
    #[serde(default, rename = "noEvokeLongUrl")]
    pub no_evoke_long_url: Option<String>,
    /// 唯品会快应用链接
    #[serde(default, rename = "vipQuickAppUrl")]
    pub vip_quick_app_url: Option<String>,
    /// 唯品会小程序链接 (仅在根据商品 ID 获取时返回)
    #[serde(default, rename = "vipWxUrl")]
    pub vip_wx_url: Option<String>,
    /// CPS Deeplink 链接
    #[serde(default, rename = "deeplinkUrl")]
    pub deeplink_url: Option<String>,
    /// CPS 通用链接
    #[serde(default, rename = "ulUrl")]
    pub ul_url: Option<String>,
    /// 原始链接或商品 ID
    #[serde(default)]
    pub source: Option<String>,
    /// 小程序 CPS 参数 (通用小程序跟单参数)
    #[serde(default, rename = "traFrom")]
    pub tra_from: Option<String>,
}

/// 唯品会账号授权响应
///
/// authorize 接口的响应 (返回授权 URL)
#[derive(Debug, Clone, Deserialize)]
pub struct VipAuthorizeResponse {
    /// 状态码
    #[serde(default)]
    pub status: Option<i32>,
    /// 授权 URL
    #[serde(default)]
    pub url: Option<String>,
    /// 错误信息
    #[serde(default)]
    pub msg: Option<String>,
}

/// 唯品会授权列表响应
///
/// authorize_list 接口的响应
#[derive(Debug, Clone, Deserialize)]
pub struct VipAuthorizeListResponse {
    /// 状态码,200 表示成功
    #[serde(default)]
    pub status: Option<i32>,
    /// 授权账号列表
    #[serde(default)]
    pub data: Option<Vec<VipAuthorizeInfo>>,
}

/// 唯品会授权账号信息
#[derive(Debug, Clone, Deserialize)]
pub struct VipAuthorizeInfo {
    /// 唯品会账号授权后在折淘客生成的 ID
    #[serde(default)]
    pub sid: Option<String>,
    /// 折淘客账号
    #[serde(default)]
    pub account: Option<String>,
    /// 唯品会账号 (编号形式)
    #[serde(default)]
    pub user_id: Option<String>,
    /// 用户昵称 (暂时无用)
    #[serde(default)]
    pub user_nick: Option<String>,
    /// 授权时间
    #[serde(default)]
    pub auth_time: Option<String>,
    /// 授权过期时间
    #[serde(default)]
    pub expire_time: Option<String>,
    /// access_token
    #[serde(default)]
    pub access_token: Option<String>,
}

/// 唯品会订单查询响应
///
/// query_orders 接口的响应
#[derive(Debug, Clone, Deserialize)]
pub struct VipOrderResponse {
    /// 返回码,0 表示成功
    #[serde(default, rename = "returnCode")]
    pub return_code: Option<String>,
    /// 订单结果
    #[serde(default)]
    pub result: Option<VipOrderResult>,
}

/// 唯品会订单结果
#[derive(Debug, Clone, Deserialize)]
pub struct VipOrderResult {
    /// 订单列表
    #[serde(default, rename = "orderInfoList")]
    pub order_info_list: Option<Vec<VipOrderInfo>>,
    /// 总数量
    #[serde(default)]
    pub total: Option<i64>,
    /// 页码
    #[serde(default)]
    pub page: Option<i32>,
    /// 每页数量
    #[serde(default, rename = "pageSize")]
    pub page_size: Option<i32>,
}

/// 唯品会订单信息
#[derive(Debug, Clone, Deserialize)]
pub struct VipOrderInfo {
    /// 订单号
    #[serde(default, rename = "orderSn")]
    pub order_sn: Option<String>,
    /// 商品 ID
    #[serde(default, rename = "goodsId")]
    pub goods_id: Option<String>,
    /// 商品名称
    #[serde(default, rename = "goodsName")]
    pub goods_name: Option<String>,
    /// 商品图片
    #[serde(default, rename = "goodsThumb")]
    pub goods_thumb: Option<String>,
    /// 商品数量
    #[serde(default, rename = "goodsCount")]
    pub goods_count: Option<i32>,
    /// 商品单价 (元)
    #[serde(default, rename = "goodsPrice")]
    pub goods_price: Option<String>,
    /// 订单金额 (元)
    #[serde(default, rename = "orderAmount")]
    pub order_amount: Option<String>,
    /// 佣金金额 (元)
    #[serde(default)]
    pub commission: Option<String>,
    /// 佣金比例 (%)
    #[serde(default, rename = "commissionRate")]
    pub commission_rate: Option<String>,
    /// 订单状态: 0-不合格,1-待定,2-已完结
    #[serde(default)]
    pub status: Option<i32>,
    /// 订单状态描述
    #[serde(default, rename = "statusName")]
    pub status_name: Option<String>,
    /// 订单时间
    #[serde(default, rename = "orderTime")]
    pub order_time: Option<String>,
    /// 更新时间
    #[serde(default, rename = "updateTime")]
    pub update_time: Option<String>,
    /// 渠道标识
    #[serde(default, rename = "chanTag")]
    pub chan_tag: Option<String>,
    /// 自定义参数
    #[serde(default, rename = "statParam")]
    pub stat_param: Option<String>,
}

/// 唯品会商品详情响应 (V2 版本)
///
/// goods_detail 接口的响应
#[derive(Debug, Clone, Deserialize)]
pub struct VipGoodsDetailResponse {
    /// 返回码,0 表示成功
    #[serde(default, rename = "returnCode")]
    pub return_code: Option<String>,
    /// 商品详情列表
    #[serde(default)]
    pub result: Option<Vec<VipGoodsDetail>>,
}

/// 唯品会商品详情
#[derive(Debug, Clone, Deserialize)]
pub struct VipGoodsDetail {
    /// 商品 ID
    #[serde(default, rename = "goodsId")]
    pub goods_id: Option<String>,
    /// 商品名称
    #[serde(default, rename = "goodsName")]
    pub goods_name: Option<String>,
    /// 市场价 (元)
    #[serde(default, rename = "marketPrice")]
    pub market_price: Option<String>,
    /// 唯品价 (元)
    #[serde(default, rename = "vipPrice")]
    pub vip_price: Option<String>,
    /// 折扣 (唯品价/市场价)
    #[serde(default)]
    pub discount: Option<String>,
    /// 佣金比例 (%)
    #[serde(default, rename = "commissionRate")]
    pub commission_rate: Option<String>,
    /// 佣金金额 (元)
    #[serde(default)]
    pub commission: Option<String>,
    /// 商品主图
    #[serde(default, rename = "goodsMainPicture")]
    pub goods_main_picture: Option<String>,
    /// 商品缩略图
    #[serde(default, rename = "goodsThumbUrl")]
    pub goods_thumb_url: Option<String>,
    /// 商品轮播图 (queryDetail=true 时返回)
    #[serde(default, rename = "goodsCarouselPictures")]
    pub goods_carousel_pictures: Option<Vec<String>>,
    /// 商品详情图 (queryDetail=true 时返回)
    #[serde(default, rename = "goodsDetailPictures")]
    pub goods_detail_pictures: Option<Vec<String>>,
    /// 商品落地页
    #[serde(default, rename = "destUrl")]
    pub dest_url: Option<String>,
    /// 品牌名称
    #[serde(default, rename = "brandName")]
    pub brand_name: Option<String>,
    /// 品牌 ID
    #[serde(default, rename = "brandId")]
    pub brand_id: Option<i64>,
    /// 品牌 Logo
    #[serde(default, rename = "brandLogoFull")]
    pub brand_logo_full: Option<String>,
    /// 品牌店铺 SN
    #[serde(default, rename = "brandStoreSn")]
    pub brand_store_sn: Option<String>,
    /// 一级分类 ID
    #[serde(default, rename = "cat1stId")]
    pub cat1st_id: Option<i64>,
    /// 一级分类名称
    #[serde(default, rename = "cat1stName")]
    pub cat1st_name: Option<String>,
    /// 二级分类 ID
    #[serde(default, rename = "cat2ndId")]
    pub cat2nd_id: Option<i64>,
    /// 二级分类名称
    #[serde(default, rename = "cat2ndName")]
    pub cat2nd_name: Option<String>,
    /// 三级分类 ID
    #[serde(default, rename = "categoryId")]
    pub category_id: Option<i64>,
    /// 三级分类名称
    #[serde(default, rename = "categoryName")]
    pub category_name: Option<String>,
    /// 是否海淘商品: 1-是,0-否
    #[serde(default, rename = "haiTao")]
    pub hai_tao: Option<i32>,
    /// 商品类型: 0-自营,1-MP
    #[serde(default, rename = "sourceType")]
    pub source_type: Option<i32>,
    /// 商品状态: 0-下架,1-上架
    #[serde(default)]
    pub status: Option<i32>,
    /// SPU ID
    #[serde(default, rename = "spuId")]
    pub spu_id: Option<String>,
    /// 商品售卖开始时间 (毫秒时间戳)
    #[serde(default, rename = "sellTimeFrom")]
    pub sell_time_from: Option<i64>,
    /// 商品售卖结束时间 (毫秒时间戳)
    #[serde(default, rename = "sellTimeTo")]
    pub sell_time_to: Option<i64>,
    /// 推广方案开始时间 (毫秒时间戳)
    #[serde(default, rename = "schemeStartTime")]
    pub scheme_start_time: Option<i64>,
    /// 推广方案结束时间 (毫秒时间戳)
    #[serde(default, rename = "schemeEndTime")]
    pub scheme_end_time: Option<i64>,
    /// 店铺信息
    #[serde(default, rename = "storeInfo")]
    pub store_info: Option<VipStoreInfo>,
}

/// 唯品会店铺信息
#[derive(Debug, Clone, Deserialize)]
pub struct VipStoreInfo {
    /// 店铺 ID
    #[serde(default, rename = "storeId")]
    pub store_id: Option<String>,
    /// 店铺名称
    #[serde(default, rename = "storeName")]
    pub store_name: Option<String>,
}

/// 唯品会商品搜索响应
///
/// search_goods 接口的响应
#[derive(Debug, Clone, Deserialize)]
pub struct VipSearchGoodsResponse {
    /// 返回码,0 表示成功
    #[serde(default, rename = "returnCode")]
    pub return_code: Option<String>,
    /// 搜索结果
    #[serde(default)]
    pub result: Option<VipSearchResult>,
}

/// 唯品会商品搜索结果
#[derive(Debug, Clone, Deserialize)]
pub struct VipSearchResult {
    /// 商品总数
    #[serde(default)]
    pub total: Option<i64>,
    /// 商品列表
    #[serde(default, rename = "goodsInfoList")]
    pub goods_info_list: Option<Vec<VipGoodsInfo>>,
    /// 页码
    #[serde(default)]
    pub page: Option<i32>,
    /// 每页数量
    #[serde(default, rename = "pageSize")]
    pub page_size: Option<i32>,
    /// 可用排序字段
    #[serde(default, rename = "sortFields")]
    pub sort_fields: Option<Vec<VipSortField>>,
}

/// 唯品会商品信息 (搜索结果)
#[derive(Debug, Clone, Deserialize)]
pub struct VipGoodsInfo {
    /// 商品 ID
    #[serde(default, rename = "goodsId")]
    pub goods_id: Option<String>,
    /// 商品名称
    #[serde(default, rename = "goodsName")]
    pub goods_name: Option<String>,
    /// 市场价 (元)
    #[serde(default, rename = "marketPrice")]
    pub market_price: Option<String>,
    /// 唯品价 (元)
    #[serde(default, rename = "vipPrice")]
    pub vip_price: Option<String>,
    /// 折扣 (唯品价/市场价)
    #[serde(default)]
    pub discount: Option<String>,
    /// 佣金比例 (%)
    #[serde(default, rename = "commissionRate")]
    pub commission_rate: Option<String>,
    /// 佣金金额 (元)
    #[serde(default)]
    pub commission: Option<String>,
    /// 商品主图
    #[serde(default, rename = "goodsMainPicture")]
    pub goods_main_picture: Option<String>,
    /// 商品缩略图
    #[serde(default, rename = "goodsThumbUrl")]
    pub goods_thumb_url: Option<String>,
    /// 商品落地页
    #[serde(default, rename = "destUrl")]
    pub dest_url: Option<String>,
    /// 品牌名称
    #[serde(default, rename = "brandName")]
    pub brand_name: Option<String>,
    /// 品牌 ID
    #[serde(default, rename = "brandId")]
    pub brand_id: Option<i64>,
    /// 品牌 Logo
    #[serde(default, rename = "brandLogoFull")]
    pub brand_logo_full: Option<String>,
    /// 品牌店铺 SN
    #[serde(default, rename = "brandStoreSn")]
    pub brand_store_sn: Option<String>,
    /// 一级分类 ID
    #[serde(default, rename = "cat1stId")]
    pub cat1st_id: Option<i64>,
    /// 一级分类名称
    #[serde(default, rename = "cat1stName")]
    pub cat1st_name: Option<String>,
    /// 二级分类 ID
    #[serde(default, rename = "cat2ndId")]
    pub cat2nd_id: Option<i64>,
    /// 二级分类名称
    #[serde(default, rename = "cat2ndName")]
    pub cat2nd_name: Option<String>,
    /// 三级分类 ID
    #[serde(default, rename = "categoryId")]
    pub category_id: Option<i64>,
    /// 三级分类名称
    #[serde(default, rename = "categoryName")]
    pub category_name: Option<String>,
    /// 是否海淘商品: 1-是,0-否
    #[serde(default, rename = "haiTao")]
    pub hai_tao: Option<i32>,
    /// 商品类型: 0-自营,1-MP
    #[serde(default, rename = "sourceType")]
    pub source_type: Option<i32>,
    /// 商品状态: 0-下架,1-上架
    #[serde(default)]
    pub status: Option<i32>,
    /// SPU ID
    #[serde(default, rename = "spuId")]
    pub spu_id: Option<String>,
    /// 商品售卖开始时间 (毫秒时间戳)
    #[serde(default, rename = "sellTimeFrom")]
    pub sell_time_from: Option<i64>,
    /// 商品售卖结束时间 (毫秒时间戳)
    #[serde(default, rename = "sellTimeTo")]
    pub sell_time_to: Option<i64>,
    /// 推广方案开始时间 (毫秒时间戳)
    #[serde(default, rename = "schemeStartTime")]
    pub scheme_start_time: Option<i64>,
    /// 推广方案结束时间 (毫秒时间戳)
    #[serde(default, rename = "schemeEndTime")]
    pub scheme_end_time: Option<i64>,
    /// 店铺信息
    #[serde(default, rename = "storeInfo")]
    pub store_info: Option<VipStoreInfo>,
}

/// 唯品会排序字段
#[derive(Debug, Clone, Deserialize)]
pub struct VipSortField {
    /// 字段名称
    #[serde(default, rename = "fieldName")]
    pub field_name: Option<String>,
    /// 字段描述
    #[serde(default, rename = "fieldDesc")]
    pub field_desc: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_vip_convert_response_deserialize() {
        let json = r#"{
            "returnCode": "0",
            "result": {
                "urlInfoList": [
                    {
                        "url": "https://t.vip.com/mlCYWuKuVNA",
                        "longUrl": "https://t.vip.com/redirect.php?url=xxx",
                        "noEvokeUrl": "https://t.vip.com/mlCYWuKuVNA?wq=1",
                        "vipWxUrl": "pages/productDetail/productDetail?goodsId=123",
                        "deeplinkUrl": "vipshop://showGoodsDetail?pid=123",
                        "source": "https://m.vip.com/product-123.html"
                    }
                ]
            }
        }"#;

        let response: VipConvertResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.return_code, Some("0".to_string()));
        assert!(response.result.is_some());
        let result = response.result.unwrap();
        assert!(result.url_info_list.is_some());
        let urls = result.url_info_list.unwrap();
        assert_eq!(urls.len(), 1);
        assert_eq!(
            urls[0].url,
            Some("https://t.vip.com/mlCYWuKuVNA".to_string())
        );
    }

    #[test]
    fn test_vip_authorize_list_response_deserialize() {
        let json = r#"{
            "status": 200,
            "data": [
                {
                    "sid": "123",
                    "account": "test@example.com",
                    "user_id": "456",
                    "auth_time": "2023/11/12 15:55:49",
                    "expire_time": "2024/11/12 15:55:49",
                    "access_token": "token123"
                }
            ]
        }"#;

        let response: VipAuthorizeListResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.status, Some(200));
        assert!(response.data.is_some());
        let data = response.data.unwrap();
        assert_eq!(data.len(), 1);
        assert_eq!(data[0].sid, Some("123".to_string()));
    }

    #[test]
    fn test_vip_order_response_deserialize() {
        let json = r#"{
            "returnCode": "0",
            "result": {
                "orderInfoList": [
                    {
                        "orderSn": "123456789",
                        "goodsId": "6919173790682972930",
                        "goodsName": "测试商品",
                        "status": 2,
                        "orderAmount": "99.00",
                        "commission": "4.95"
                    }
                ],
                "total": 1,
                "page": 1,
                "pageSize": 20
            }
        }"#;

        let response: VipOrderResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.return_code, Some("0".to_string()));
        assert!(response.result.is_some());
        let result = response.result.unwrap();
        assert_eq!(result.total, Some(1));
        assert!(result.order_info_list.is_some());
        let orders = result.order_info_list.unwrap();
        assert_eq!(orders.len(), 1);
        assert_eq!(orders[0].order_sn, Some("123456789".to_string()));
    }

    #[test]
    fn test_vip_goods_detail_response_deserialize() {
        let json = r#"{
            "returnCode": "0",
            "result": [
                {
                    "goodsId": "6919173790682972930",
                    "goodsName": "测试商品",
                    "marketPrice": "539.00",
                    "vipPrice": "179.00",
                    "discount": "0.33",
                    "commissionRate": "5",
                    "commission": "8.95",
                    "brandName": "测试品牌",
                    "cat1stName": "男装",
                    "status": 1
                }
            ]
        }"#;

        let response: VipGoodsDetailResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.return_code, Some("0".to_string()));
        assert!(response.result.is_some());
        let result = response.result.unwrap();
        assert_eq!(result.len(), 1);
        assert_eq!(result[0].goods_id, Some("6919173790682972930".to_string()));
        assert_eq!(result[0].market_price, Some("539.00".to_string()));
    }

    #[test]
    fn test_vip_search_goods_response_deserialize() {
        let json = r#"{
            "returnCode": "0",
            "result": {
                "total": 3250,
                "goodsInfoList": [
                    {
                        "goodsId": "6918901004295698011",
                        "goodsName": "测试球鞋",
                        "marketPrice": "339.00",
                        "vipPrice": "179.00",
                        "discount": "0.68",
                        "commissionRate": "3",
                        "commission": "5.37",
                        "brandName": "乔丹",
                        "cat1stName": "运动户外",
                        "status": 1
                    }
                ],
                "page": 1,
                "pageSize": 20,
                "sortFields": [
                    {"fieldName": "PRICE", "fieldDesc": "价格排序"},
                    {"fieldName": "DISCOUNT", "fieldDesc": "折扣排序"}
                ]
            }
        }"#;

        let response: VipSearchGoodsResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.return_code, Some("0".to_string()));
        assert!(response.result.is_some());
        let result = response.result.unwrap();
        assert_eq!(result.total, Some(3250));
        assert!(result.goods_info_list.is_some());
        let goods = result.goods_info_list.unwrap();
        assert_eq!(goods.len(), 1);
        assert_eq!(goods[0].goods_name, Some("测试球鞋".to_string()));
    }

    #[test]
    fn test_response_with_missing_fields() {
        let json = r#"{"returnCode": "0"}"#;

        let response: VipConvertResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.return_code, Some("0".to_string()));
        assert!(response.result.is_none());
    }
}