summaryrefslogtreecommitdiff
path: root/data/en_us/agentretailvision/2026-05-06/api-docs.php
blob: b5c55bf5ccd8393473f32c4f1078754186d47d87 (plain)
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
<?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' => '', 'description' => 'The composite image request ID generated by the caller.', 'type' => 'string', 'required' => false, 'example' => 'a5561c14-b5cd-49a4-ab79-01a63b10d99c'],
                ],
                [
                    'name' => 'GroupType',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The composite image type. Valid values:'."\n"
                        .'- 1: single-SKU multi-image composite.'."\n"
                        .'- 2: multi-SKU composite.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
                ],
                [
                    'name' => 'PlatformItemIdList',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'The list of platform item IDs, corresponding to smart_retail_item.platform_item_id.',
                        'type' => 'array',
                        'items' => ['description' => 'The platform item ID.', 'type' => 'string', 'required' => false, 'example' => '09b3c623e32d49aaba78c55ddcc7cb63', 'title' => ''],
                        'required' => false,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'CallbackUrl',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The callback URL of the customer.', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.com'],
                ],
                [
                    'name' => 'CallbackSecret',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The key used for callback signature verification.', 'type' => 'string', 'required' => false, 'example' => 'your_secret_key'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
                            'Code' => ['title' => '', 'description' => 'The error code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '202'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n"
                                .'- true: The call is successful.'."\n"
                                .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'],
                            'Message' => ['title' => '', 'description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => 'OK'],
                            'Data' => [
                                'title' => '',
                                'description' => 'The composite image generation result.',
                                'type' => 'object',
                                'properties' => [
                                    'GroupId' => ['title' => '', 'description' => 'The composite image request ID.', 'type' => 'string', 'example' => 'a5561c14-b5cd-49a4-ab79-01a63b10d99c'."\n"],
                                ],
                                'example' => '',
                            ],
                        ],
                        'example' => '',
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => 'Generate composite image',
            'summary' => 'Generates a composite image for single-item multi-image or multi-item scenarios.',
            'description' => '## Request description'."\n"
                .'- When `groupType=1`, `platformItemIdList` must contain only one element.'."\n"
                .'- When `groupType=2`, `platformItemIdList` can contain 1 to 10 elements.',
            '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' => 'Adds product information. After a successful import, the platform returns a globally unique platform_item_id for subsequent updates and recognition result association.',
            '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' => '', 'description' => 'The product ID assigned by the business party. This ID must be unique within the same business party.', 'type' => 'string', 'example' => 'ITEM_001', 'required' => false],
                ],
                [
                    'name' => 'ImageTitle',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The product title.', 'type' => 'string', 'example' => '可口可乐330ml', 'required' => false],
                ],
                [
                    'name' => 'MainImage',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'The list of main product image URLs. At least one URL is required.',
                        'type' => 'array',
                        'items' => ['description' => 'Specifies whether the image is the main image when multiple images exist for a single room. Default value: true.', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg', 'title' => ''],
                        'required' => false,
                        'example' => '["https://img.example.com/item1.jpg"]',
                    ],
                ],
                [
                    'name' => 'MultiViewImages',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'description' => 'The list of multi-angle product images.',
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'Url' => ['description' => 'The task URL.', 'type' => 'string', 'required' => false, 'example' => 'https://img5-parcel.oss-cn-hangzhou.aliyuncs.com/2026/01/12/78568805914464s.jpeg?07', 'title' => ''],
                                'Angle' => ['description' => 'The digital human angle. Valid values:'."\n"
                                    ."\n"
                                    .'- 0: front view, which is the default angle'."\n"
                                    .'- 1: left side at 30 degrees'."\n"
                                    .'- 2: right side at 30 degrees'."\n"
                                    ."\n"
                                    .'For a preview of each angle, refer to [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html#a989eb5075t9y).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
                            ],
                            'required' => false,
                            'description' => '',
                            'title' => '',
                            'example' => '',
                        ],
                        'required' => false,
                        'title' => '',
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'ExtraImages',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'The list of additional image URLs that can be provided.',
                        'type' => 'array',
                        'items' => ['description' => 'The image URL.', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg', 'title' => ''],
                        'required' => false,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The device ID. This ID is used to establish an association between the device and product vectors.', 'type' => 'string', 'example' => 'DEVICE_001', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
                            'Code' => ['title' => '', 'description' => 'The error code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '200'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n"
                                .'- true: The call is successful.'."\n"
                                .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'],
                            'Message' => ['title' => '', 'description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => 'OK'],
                            'Data' => [
                                'title' => '',
                                'description' => 'The product information.',
                                'type' => 'object',
                                'properties' => [
                                    'ItemUniqueId' => ['title' => '', 'description' => 'The product ID assigned by the business party. This ID must be unique within the same business party.', 'type' => 'string', 'example' => 'ITEM_001'],
                                    'PlatformItemId' => ['title' => '', 'description' => 'The platform product ID, which is globally unique.', 'type' => 'string', 'example' => 'PLAT_001'],
                                ],
                                'example' => '',
                            ],
                        ],
                        'example' => '',
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => 'Upload product to product library',
            'description' => '## Operation description'."\n"
                .'- This operation is used to add product information.'."\n"
                .'- After you import products to the product library, they are stored in Alibaba Cloud OSS for direct recall and retrieval by the product recognition API.'."\n"
                .'- You must provide at least one main image URL, and the `item_unique_id` must be unique within the same business party.'."\n"
                .'- You can optionally provide multi-angle views and extra images to improve recognition accuracy.'."\n"
                .'- The `device_id` field can be used to establish an association between a device and product vectors, but it is not required.',
            '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' => 'At least one result retrieval method must be integrated: webhook callback or task status query. Both methods can be used simultaneously.'."\n"
                .'	•	If the user chooses the webhook callback method, the receiving endpoint must be prepared in advance and implemented according to the following request and response parameters.'."\n"
                .'	•	After the recognition task is completed, the platform will push the results to the business party based on the callback URL bound to the task.',
            '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' => '', 'description' => 'Platform Task ID', 'type' => 'string', 'example' => 'TASK_001', 'required' => false],
                ],
                [
                    'name' => 'OrderUniqueId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'Business idempotent request ID', 'type' => 'string', 'example' => 'ORDER_001', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
                            'Code' => ['title' => '', 'description' => 'Error code. This parameter is not returned for a successful call.', 'type' => 'string', 'example' => '200'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'True'],
                            'Message' => ['title' => '', 'description' => 'Error message. This parameter is not returned for a successful call.', 'type' => 'string', 'example' => 'OK'],
                            'Data' => [
                                'title' => '',
                                'description' => 'Task details',
                                'type' => 'object',
                                'properties' => [
                                    'TaskId' => ['title' => '', 'description' => 'Platform Task ID', 'type' => 'string', 'example' => 'TASK_001'],
                                    'OrderUniqueId' => ['title' => '', 'description' => 'Business unique idempotent ID', 'type' => 'string', 'example' => 'ORDER_001'],
                                    'TaskStatus' => ['title' => '', 'description' => 'Task status', 'type' => 'string', 'example' => 'COMPLETED'],
                                    'Result' => [
                                        'title' => '',
                                        'description' => 'Recognition result',
                                        'type' => 'object',
                                        'properties' => [
                                            'CheckoutInfo' => [
                                                'title' => '',
                                                'description' => 'Checkout information',
                                                'type' => 'object',
                                                'properties' => [
                                                    'CheckoutStatus' => [
                                                        'title' => '',
                                                        'description' => 'Checkout status',
                                                        'enumValueTitles' => ['TRUSTED: Can be settled directly' => 'TRUSTED: Can be settled directly', 'SUSPECT: Manual review recommended' => 'SUSPECT: Manual review recommended', 'ABNORMAL: Unable to process' => 'ABNORMAL: Unable to process'],
                                                        'type' => 'string',
                                                        'example' => 'TRUSTED',
                                                    ],
                                                ],
                                                'example' => '',
                                            ],
                                            'Items' => [
                                                'title' => '',
                                                'description' => 'List of recognized items',
                                                'type' => 'array',
                                                'items' => [
                                                    'description' => 'Request ID.',
                                                    'type' => 'object',
                                                    'properties' => [
                                                        'PlatformItemId' => ['title' => '', 'description' => 'Platform Item ID', 'type' => 'string', 'example' => '535c3daaee3b4b5382db4913413419bc2d'],
                                                        'ItemUniqueId' => ['title' => '', 'description' => 'Business Item ID', 'type' => 'string', 'example' => '690234524880781'],
                                                        'Quantity' => ['title' => '', 'description' => 'Item quantity', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
                                                    ],
                                                    'title' => '',
                                                    'example' => '',
                                                ],
                                                'example' => '',
                                            ],
                                        ],
                                        'example' => '',
                                    ],
                                ],
                                'example' => '',
                            ],
                        ],
                        'example' => '',
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => 'Webhook Callback 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' => 'Used for intelligent recognition scenarios. Requires uploading the OSS address of shopping videos. The platform creates an asynchronous recognition task and immediately returns a task_id. Notifications are sent via webhook, and the results need to be actively retrieved through the query API.',
            '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' => '', 'description' => 'Unique idempotent ID of the business party, unique within the same business party', 'type' => 'string', 'example' => 'ORDER_001', 'required' => false],
                ],
                [
                    'name' => 'VideoUrls',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'List of shopping video OSS addresses (currently only one is supported)',
                        'type' => 'array',
                        'items' => ['description' => 'URL address of the recorded video.', 'type' => 'string', 'required' => false, 'example' => 'https://oss.example.com/video1.mp4', 'title' => ''],
                        'required' => false,
                        'example' => '["https://oss.example.com/video1.mp4"]',
                    ],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => 'DEVICE_001', 'required' => false],
                ],
                [
                    'name' => 'CandidateItems',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'List of candidate items. It is recommended to pass platform_item_id.',
                        'type' => 'array',
                        'items' => ['description' => 'Candidate item', 'type' => 'string', 'required' => false, 'example' => '535c3daaadgaf5382db49a90969bc2d', 'title' => ''],
                        'required' => false,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'CallbackUrl',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'Callback URL for this task. If not provided, the registered default address is used.', 'type' => 'string', 'example' => 'https://example.com/callback', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
                            'Code' => ['title' => '', 'description' => 'Error code. This parameter is not returned during a normal call.', 'type' => 'string', 'example' => '200'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. true: The call is successful. false: The call has failed.', 'type' => 'boolean', 'example' => 'True'],
                            'Message' => ['title' => '', 'description' => 'Error message. This parameter is not returned during a normal call.', 'type' => 'string', 'example' => 'OK'],
                            'Data' => [
                                'title' => '',
                                'description' => 'Recognition task information',
                                'type' => 'object',
                                'properties' => [
                                    'TaskId' => ['title' => '', 'description' => 'Platform task ID', 'type' => 'string', 'example' => 'TASK_001'],
                                    'OrderUniqueId' => ['title' => '', 'description' => 'Unique idempotent ID of the business party', 'type' => 'string', 'example' => 'ORDER_001'],
                                    'TaskStatus' => ['title' => '', 'description' => 'Task status', 'type' => 'string', 'example' => 'PROCESSING'],
                                ],
                                'example' => '',
                            ],
                        ],
                        'example' => '',
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => 'Shopping Recognition API',
            'description' => '## Request Description'."\n"
                .'- The user must provide `caller_uid` and `order_unique_id` as required parameters.'."\n"
                .'- The `video_urls` parameter supports video files in mp4, avi, mov, and mkv formats, with a size limit of 100 MB, a duration of no more than 3 minutes, a resolution between 480p and 1080p, and specific aspect ratio requirements.'."\n"
                .'- At least one of `device_id` or `candidate_items` must be provided to specify the recognition scope. If both are provided, the system first filters by the device product library and then further filters based on the candidate items list.'."\n"
                .'- Optionally, the user can specify a `callback_url` to receive notifications of the recognition results. If not provided, the pre-registered default webhook address is used.'."\n"
                .'- If a request is submitted repeatedly with the same `order_unique_id`, the system directly returns the previously existing task status.',
            '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' => 'Registers or updates the default webhook callback URL.',
            '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' => '', 'description' => 'The default callback URL. A public HTTPS URL is required.', 'type' => 'string', 'example' => 'https://example.com/callback', 'required' => false],
                ],
                [
                    'name' => 'CallbackSecret',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The key used for callback signature verification.', 'type' => 'string', 'example' => 'your_secret_key', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
                            'Code' => ['title' => '', 'description' => 'The error code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '200'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n"
                                .'- true: The call is successful.'."\n"
                                .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'],
                            'Message' => ['title' => '', 'description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => 'OK'],
                        ],
                        'example' => '',
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => 'Register webhook URL',
            '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' => 'Updates the information of an existing item on the platform.',
            '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' => '', 'description' => 'The business-side item ID, which is unique within the same business party.', 'type' => 'string', 'example' => 'ITEM_001', 'required' => false],
                ],
                [
                    'name' => 'PlatformItemId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The platform item ID, which is globally unique.', 'type' => 'string', 'example' => 'PLAT_001', 'required' => false],
                ],
                [
                    'name' => 'ImageTitle',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The title of the item.', 'type' => 'string', 'example' => '可口可乐330ml', 'required' => false],
                ],
                [
                    'name' => 'MainImage',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'The list of main image URLs for the item. At least one image is required.',
                        'type' => 'array',
                        'items' => ['title' => '', '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' => 'The list of multi-angle images for the item.',
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'Url' => ['description' => 'The URL of the image.', 'type' => 'string', 'required' => false, 'example' => 'https://nova-tems.oss-cn-shanghai.aliyuncs.com/crop/33dfc602-c9a4-11f0-ac99-ee21a901d6ec.png?OSSAccessKeyId=****&Expires=1764058353&Signature=****', 'title' => ''],
                                'Angle' => ['description' => 'The angle of the digital human.'."\n"
                                    ."\n"
                                    .'- 0: front view, the default angle'."\n"
                                    .'- 1: 30 degrees from the left'."\n"
                                    .'- 2: 30 degrees from the right'."\n"
                                    ."\n"
                                    .'For a preview of each angle, refer to [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html#a989eb5075t9y).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
                            ],
                            'required' => false,
                            'description' => '',
                            'title' => '',
                            'example' => '',
                        ],
                        'required' => false,
                        'title' => '',
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'ExtraImages',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'The list of additional image URLs that can be provided.',
                        'type' => 'array',
                        'items' => ['title' => '', 'description' => 'The first image in the additional image list.', 'type' => 'string', 'required' => false, 'example' => 'https://img.example.com/item1.jpg'],
                        'required' => false,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The device ID, which is used to establish the vector association between the device and the item.', 'type' => 'string', 'example' => 'DEVICE_001', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E1AD60F1-BAC7-546B-9533-E7AD02B16E3F'],
                            'Code' => ['title' => '', 'description' => 'The error code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '200'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the call is successful. Valid values:'."\n"
                                .'- true: The call is successful.'."\n"
                                .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True'],
                            'Message' => ['title' => '', 'description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => 'OK'],
                            'Data' => [
                                'title' => '',
                                'description' => 'The item information.',
                                'type' => 'object',
                                'properties' => [
                                    'ItemUniqueId' => ['title' => '', 'description' => 'The business-side item ID, which is unique within the same business party.', 'type' => 'string', 'example' => 'ITEM_001'],
                                    'PlatformItemId' => ['title' => '', 'description' => 'The platform item ID, which is globally unique.', 'type' => 'string', 'example' => 'PLAT_001'],
                                ],
                                'example' => '',
                            ],
                        ],
                        'example' => '',
                    ],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => 'Update item',
            'description' => '## Operation description'."\n"
                .'- The platform_item_id parameter is used as the primary identifier for the update.'."\n"
                .'- If both platform_item_id and item_unique_id are specified, they must point to the same item.'."\n"
                .'- The item title (image_title) and the list of main image URLs (main_image) are required. The main_image parameter must contain at least one image.'."\n"
                .'- Optional parameters include the multi-angle image list (multi_view_images), the list of additional image URLs (extra_images), and the device ID (device_id).'."\n"
                .'- In multi_view_images, each object must contain the image OSS address (url) and the shooting angle (angle). Valid values of angle: top view (up), bottom view (down), left view (left), right view (right), front view (front), and back view (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' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agentretailvision.cn-beijing.aliyuncs.com', 'endpoint' => 'agentretailvision.cn-beijing.aliyuncs.com', 'vpc' => ''],
    ],
    'errorCodes' => [],
    'changeSet' => [],
];