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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'AgentRetailVision', 'version' => '2026-05-06'],
'directories' => ['GenerateGroupImage', 'ImportProducts', 'QueryRecognitionResult', 'RecognizeOrder', 'RegisterWebhook', 'UpdateProduct'],
'components' => [
'schemas' => [],
],
'apis' => [
'GenerateGroupImage' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '调用方生成的组图请求ID', 'description' => '调用方生成的组图请求ID', 'type' => 'string', 'required' => false, 'example' => 'a5561c14-b5cd-49a4-ab79-01a63b10d99c'],
],
[
'name' => 'GroupType',
'in' => 'query',
'schema' => ['title' => '组图类型:1 = 单 SKU 多图组图;2 = 多 SKU 组图', 'description' => '组图类型:1 = 单 SKU 多图组图;2 = 多 SKU 组图', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PlatformItemIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '平台商品ID列表,对应 smart_retail_item.platform_item_id',
'description' => '平台商品ID列表,对应 smart_retail_item.platform_item_id',
'type' => 'array',
'items' => ['description' => '平台商品ID', 'type' => 'string', 'required' => false, 'example' => '09b3c623e32d49aaba78c55ddcc7cb63'],
'required' => false,
],
],
[
'name' => 'CallbackUrl',
'in' => 'query',
'schema' => ['title' => '客户回调地址', 'description' => '客户回调地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.com'],
],
[
'name' => 'CallbackSecret',
'in' => 'query',
'schema' => ['title' => '回调验签密钥', 'description' => '回调验签密钥', 'type' => 'string', 'required' => false, 'example' => 'your_secret_key'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
'Code' => ['title' => '错误码,正常调用时,不会返回该参数。', 'description' => '错误码,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '202'],
'Success' => ['title' => '是否调用成功:true:调用成功。false:调用失败。', 'description' => '是否调用成功:true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
'Message' => ['title' => '错误信息,正常调用时,不会返回该参数。', 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => '组图生成结果',
'description' => '组图生成结果',
'type' => 'object',
'properties' => [
'GroupId' => ['title' => '组图请求ID', 'description' => '组图请求ID', 'type' => 'string', 'example' => 'a5561c14-b5cd-49a4-ab79-01a63b10d99c'."\n"],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '组图',
'summary' => '组图接口,用于单item多图和多item生成组图',
'description' => '## 请求说明'."\n"
.'- `groupType=1`时,`platformItemIdList`必须只能包含一个元素'."\n"
.'- `groupType=2`时,`platformItemIdList`可以包含1-10个元素',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"202\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"a5561c14-b5cd-49a4-ab79-01a63b10d99c\\\\n\\"\\n }\\n}","type":"json"}]',
],
'ImportProducts' => [
'summary' => '用于新增商品信息,导入成功后,平台返回全局唯一 platform_item_id,供后续更新和识别结果关联使用。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'ItemUniqueId',
'in' => 'query',
'schema' => ['title' => '业务方商品ID,同一业务方下唯一', 'description' => '业务方商品ID,同一业务方下唯一', 'type' => 'string', 'required' => false, 'example' => 'ITEM_001'],
],
[
'name' => 'ImageTitle',
'in' => 'query',
'schema' => ['title' => '商品标题', 'description' => '商品标题', 'type' => 'string', 'required' => false, 'example' => '可口可乐330ml'],
],
[
'name' => 'MainImage',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '商品主图图片URL列表,至少1张',
'description' => '商品主图图片URL列表,至少1张',
'type' => 'array',
'items' => ['description' => '单房间多图情况下,是否为主图,默认true', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg'],
'required' => false,
'example' => '["https://img.example.com/item1.jpg"]',
],
],
[
'name' => 'MultiViewImages',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品多角度图片列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Url' => ['description' => '任务URL。', 'type' => 'string', 'required' => false, 'example' => 'https://img5-parcel.oss-cn-hangzhou.aliyuncs.com/2026/01/12/78568805914464s.jpeg?07'],
'Angle' => ['description' => '数字人角度'."\n"
."\n"
.'- 0: 正面,默认角度'."\n"
.'- 1: 左侧30度'."\n"
.'- 2: 右侧30度'."\n"
."\n"
.'具体每个角度的效果预览可以参考:[3D数字人视频合成使用指南](https://help.aliyun.com/document_detail/447834.html#a989eb5075t9y)', 'type' => 'string', 'required' => false, 'example' => '0'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'ExtraImages',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '其余可提供的图片URL列表',
'description' => '其余可提供的图片URL列表',
'type' => 'array',
'items' => ['description' => '图片URL', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg'],
'required' => false,
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['title' => '设备号,用于建立设备商品向量关联', 'description' => '设备号,用于建立设备商品向量关联', 'type' => 'string', 'required' => false, 'example' => 'DEVICE_001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
'Code' => ['title' => '错误码,正常调用时,不会返回该参数。', 'description' => '错误码,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '200'],
'Success' => ['title' => '是否调用成功:true:调用成功。false:调用失败。', 'description' => '是否调用成功:true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
'Message' => ['title' => '错误信息,正常调用时,不会返回该参数。', 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => '商品信息',
'description' => '商品信息',
'type' => 'object',
'properties' => [
'ItemUniqueId' => ['title' => '业务方商品ID,同一业务方下唯一', 'description' => '业务方商品ID,同一业务方下唯一', 'type' => 'string', 'example' => 'ITEM_001'],
'PlatformItemId' => ['title' => '平台商品ID,全局唯一', 'description' => '平台商品ID,全局唯一', 'type' => 'string', 'example' => 'PLAT_001'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '商品库上传',
'description' => '## 请求说明'."\n"
.'- 该接口用于用户新增商品信息。'."\n"
.'- 用户导入商品库后,会存储至阿里云OSS,便于商品识别API直接调用召回检索。'."\n"
.'- 必须提供至少一张主图URL,并且`item_unique_id`在同一业务方下必须唯一。'."\n"
.'- 可选提供多角度视图和额外图片以提高识别精度。'."\n"
.'- `device_id`字段可用于建立设备与商品向量之间的关联,但非必填。',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"ItemUniqueId\\": \\"ITEM_001\\",\\n \\"PlatformItemId\\": \\"PLAT_001\\"\\n }\\n}","type":"json"}]',
],
'QueryRecognitionResult' => [
'summary' => '需要至少需要接入一种结果获取方式:webhook 回调或任务状态查询;两种方式可同时接入。'."\n"
.' • 若用户选择 webhook 回调方式,需要提前准备好接收接口,并按以下入参和出参实现。'."\n"
.' • 当识别任务结束后,平台将根据任务绑定的回调地址向业务方推送结果。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['title' => '平台任务ID', 'description' => '平台任务ID', 'type' => 'string', 'required' => false, 'example' => 'TASK_001'],
],
[
'name' => 'OrderUniqueId',
'in' => 'query',
'schema' => ['title' => '业务方幂等请求ID', 'description' => '业务方幂等请求ID', 'type' => 'string', 'required' => false, 'example' => 'ORDER_001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
'Code' => ['title' => '错误码,正常调用时,不会返回该参数。', 'description' => '错误码,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '200'],
'Success' => ['title' => '是否调用成功:true:调用成功。false:调用失败。', 'description' => '是否调用成功:true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
'Message' => ['title' => '错误信息,正常调用时,不会返回该参数。', 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => '任务详情',
'description' => '任务详情',
'type' => 'object',
'properties' => [
'TaskId' => ['title' => '平台任务ID', 'description' => '平台任务ID', 'type' => 'string', 'example' => 'TASK_001'],
'OrderUniqueId' => ['title' => '业务方唯一幂等ID', 'description' => '业务方唯一幂等ID', 'type' => 'string', 'example' => 'ORDER_001'],
'TaskStatus' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'COMPLETED'],
'Result' => [
'title' => '识别结果',
'description' => '识别结果',
'type' => 'object',
'properties' => [
'CheckoutInfo' => [
'title' => '结账信息',
'description' => '结账信息',
'type' => 'object',
'properties' => [
'CheckoutStatus' => [
'title' => '结账状态',
'description' => '结账状态',
'type' => 'string',
'enumValueTitles' => ['TRUSTED:可直接结算' => 'TRUSTED:可直接结算', 'SUSPECT:建议人工复核' => 'SUSPECT:建议人工复核', 'ABNORMAL:无法处理' => 'ABNORMAL:无法处理'],
'example' => 'TRUSTED',
],
],
],
'Items' => [
'title' => '识别到的商品列表',
'description' => '识别到的商品列表',
'type' => 'array',
'items' => [
'description' => '请求ID。',
'type' => 'object',
'properties' => [
'PlatformItemId' => ['title' => '平台商品ID', 'description' => '平台商品ID', 'type' => 'string', 'example' => '535c3daaee3b4b5382db4913413419bc2d'],
'ItemUniqueId' => ['title' => '业务方商品ID', 'description' => '业务方商品ID', 'type' => 'string', 'example' => '690234524880781'],
'Quantity' => ['title' => '商品数量', 'description' => '商品数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Webhook 回调API',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"TASK_001\\",\\n \\"OrderUniqueId\\": \\"ORDER_001\\",\\n \\"TaskStatus\\": \\"COMPLETED\\",\\n \\"Result\\": {\\n \\"CheckoutInfo\\": {\\n \\"CheckoutStatus\\": \\"TRUSTED\\"\\n },\\n \\"Items\\": [\\n {\\n \\"PlatformItemId\\": \\"535c3daaee3b4b5382db4913413419bc2d\\",\\n \\"ItemUniqueId\\": \\"690234524880781\\",\\n \\"Quantity\\": 1\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'RecognizeOrder' => [
'summary' => '用于智能识别场景, 需要上传购物视频 OSS 地址,平台创建异步识别任务并立即返回task_id, 通过webhook 通知,需要主动查询接口获取结果',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'OrderUniqueId',
'in' => 'query',
'schema' => ['title' => '业务方唯一幂等ID,同一业务方下唯一', 'description' => '业务方唯一幂等ID,同一业务方下唯一', 'type' => 'string', 'required' => false, 'example' => 'ORDER_001'],
],
[
'name' => 'VideoUrls',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '购物视频OSS地址列表(目前只支持一个)',
'description' => '购物视频OSS地址列表(目前只支持一个)',
'type' => 'array',
'items' => ['description' => '录制视频的URL地址。', 'type' => 'string', 'required' => false, 'example' => 'https://oss.example.com/video1.mp4'],
'required' => false,
'example' => '["https://oss.example.com/video1.mp4"]',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['title' => '设备号', 'description' => '设备号', 'type' => 'string', 'required' => false, 'example' => 'DEVICE_001'],
],
[
'name' => 'CandidateItems',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '候选商品列表,建议传platform_item_id',
'description' => '候选商品列表,建议传platform_item_id',
'type' => 'array',
'items' => ['description' => '候选商品', 'type' => 'string', 'required' => false, 'example' => '535c3daaadgaf5382db49a90969bc2d'],
'required' => false,
],
],
[
'name' => 'CallbackUrl',
'in' => 'query',
'schema' => ['title' => '本次任务回调地址;不传则使用已注册默认地址', 'description' => '本次任务回调地址;不传则使用已注册默认地址', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/callback'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
'Code' => ['title' => '错误码,正常调用时,不会返回该参数。', 'description' => '错误码,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '200'],
'Success' => ['title' => '是否调用成功:true:调用成功。false:调用失败。', 'description' => '是否调用成功:true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
'Message' => ['title' => '错误信息,正常调用时,不会返回该参数。', 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => '识别任务信息',
'description' => '识别任务信息',
'type' => 'object',
'properties' => [
'TaskId' => ['title' => '平台任务ID', 'description' => '平台任务ID', 'type' => 'string', 'example' => 'TASK_001'],
'OrderUniqueId' => ['title' => '业务方唯一幂等ID', 'description' => '业务方唯一幂等ID', 'type' => 'string', 'example' => 'ORDER_001'],
'TaskStatus' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'string', 'example' => 'PROCESSING'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '购物识别API',
'description' => '## 请求说明'."\n"
.'- 用户需提供`caller_uid`和`order_unique_id`作为必填参数。'."\n"
.'- `video_urls`参数支持mp4, avi, mov, mkv格式的视频文件,大小限制在100M以内,时长不超过3分钟,分辨率要求为480p至1080p之间,且满足特定的长宽比条件。'."\n"
.'- 至少需要提供`device_id`或`candidate_items`之一来指定识别范围;如果两者都提供,则先按设备商品库过滤,再根据候选商品列表进一步筛选。'."\n"
.'- 可选地,用户可以指定一个`callback_url`用于接收识别结果的通知。如果没有提供,则使用预先注册的默认webhook地址。'."\n"
.'- 如果使用相同的`order_unique_id`重复提交请求,系统将直接返回之前已存在的任务状态。',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"TASK_001\\",\\n \\"OrderUniqueId\\": \\"ORDER_001\\",\\n \\"TaskStatus\\": \\"PROCESSING\\"\\n }\\n}","type":"json"}]',
],
'RegisterWebhook' => [
'summary' => '用于注册&更新默认webhook 回调地址',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'CallbackUrl',
'in' => 'query',
'schema' => ['title' => '默认回调地址,要求公网HTTPS', 'description' => '默认回调地址,要求公网HTTPS', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/callback'],
],
[
'name' => 'CallbackSecret',
'in' => 'query',
'schema' => ['title' => '回调验签密钥', 'description' => '回调验签密钥', 'type' => 'string', 'required' => false, 'example' => 'your_secret_key'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
'Code' => ['title' => '错误码,正常调用时,不会返回该参数。', 'description' => '错误码,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '200'],
'Success' => ['title' => '是否调用成功:true:调用成功。false:调用失败。', 'description' => '是否调用成功:true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
'Message' => ['title' => '错误信息,正常调用时,不会返回该参数。', 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Webhook 地址注册API',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]',
],
'UpdateProduct' => [
'summary' => '用于更新平台内已存在的商品信息。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'ItemUniqueId',
'in' => 'query',
'schema' => ['title' => '业务方商品ID,同一业务方下唯一', 'description' => '业务方商品ID,同一业务方下唯一', 'type' => 'string', 'required' => false, 'example' => 'ITEM_001'],
],
[
'name' => 'PlatformItemId',
'in' => 'query',
'schema' => ['title' => '平台商品ID,全局唯一', 'description' => '平台商品ID,全局唯一', 'type' => 'string', 'required' => false, 'example' => 'PLAT_001'],
],
[
'name' => 'ImageTitle',
'in' => 'query',
'schema' => ['title' => '商品标题', 'description' => '商品标题', 'type' => 'string', 'required' => false, 'example' => '可口可乐330ml'],
],
[
'name' => 'MainImage',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '商品主图图片URL列表,至少1张',
'description' => '商品主图图片URL列表,至少1张',
'type' => 'array',
'items' => ['title' => '1', 'description' => '1', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg'],
'required' => false,
'example' => '["https://img.example.com/item1.jpg"]',
],
],
[
'name' => 'MultiViewImages',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品多角度图片列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Url' => ['description' => 'URL地址', 'type' => 'string', 'required' => false, 'example' => 'https://nova-tems.oss-cn-shanghai.aliyuncs.com/crop/33dfc602-c9a4-11f0-ac99-ee21a901d6ec.png?OSSAccessKeyId=****&Expires=1764058353&Signature=****'],
'Angle' => ['description' => '数字人角度'."\n"
."\n"
.'- 0: 正面,默认角度'."\n"
.'- 1: 左侧30度'."\n"
.'- 2: 右侧30度'."\n"
."\n"
.'具体每个角度的效果预览可以参考:[3D数字人视频合成使用指南](https://help.aliyun.com/document_detail/447834.html#a989eb5075t9y)', 'type' => 'string', 'required' => false, 'example' => '0'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'ExtraImages',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '其余可提供的图片URL列表',
'description' => '其余可提供的图片URL列表',
'type' => 'array',
'items' => ['title' => '额外图片列表中的第一张图片', 'description' => '额外图片列表中的第一张图片', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg'],
'required' => false,
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['title' => '设备号,用于建立设备商品向量关联', 'description' => '设备号,用于建立设备商品向量关联', 'type' => 'string', 'required' => false, 'example' => 'DEVICE_001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
'Code' => ['title' => '错误码,正常调用时,不会返回该参数。', 'description' => '错误码,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '200'],
'Success' => ['title' => '是否调用成功:true:调用成功。false:调用失败。', 'description' => '是否调用成功:true:调用成功。false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
'Message' => ['title' => '错误信息,正常调用时,不会返回该参数。', 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => '商品信息',
'description' => '商品信息',
'type' => 'object',
'properties' => [
'ItemUniqueId' => ['title' => '业务方商品ID,同一业务方下唯一', 'description' => '业务方商品ID,同一业务方下唯一', 'type' => 'string', 'example' => 'ITEM_001'],
'PlatformItemId' => ['title' => '平台商品ID,全局唯一', 'description' => '平台商品ID,全局唯一', 'type' => 'string', 'example' => 'PLAT_001'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '商品更新API',
'description' => '## 请求说明'."\n"
.'- 更新时以 `platform_item_id` 作为主标识。'."\n"
.'- 若同时传入 `platform_item_id` 和 `item_unique_id`,二者必须指向同一商品。'."\n"
.'- 商品标题 (`image_title`) 和商品主图图片 URL 列表 (`main_image`) 是必填项,其中 `main_image` 至少需要提供一张图片。'."\n"
.'- 可选参数包括多角度图片列表 (`multi_view_images`)、其余可提供的图片 URL 列表 (`extra_images`) 以及设备号 (`device_id`)。'."\n"
.'- 在 `multi_view_images` 中,每个对象需包含图片 OSS 地址 (`url`) 和拍摄角度 (`angle`),其中 `angle` 的取值范围为:上视图(`up`)、下视图(`down`)、左视图(`left`)、右视图(`right`)、前视图(`front`)、后视图(`back`)。',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1AD60F1-BAC7-546B-9533-E7AD02B16E3F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"ItemUniqueId\\": \\"ITEM_001\\",\\n \\"PlatformItemId\\": \\"PLAT_001\\"\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'agentretailvision.cn-beijing.aliyuncs.com', 'endpoint' => 'agentretailvision.cn-beijing.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [],
'changeSet' => [],
];
|