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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'cloudesl', 'version' => '2020-02-01'],
'directories' => [
[
'children' => ['BindEslDevice', 'UnbindEslDevice', 'UpdateEslDeviceLight', 'DescribeBinders', 'DescribeEslDevice', 'DescribeEslDevices'],
'type' => 'directory',
'title' => 'CloudESL devices',
],
[
'children' => ['CreateStore', 'DeleteStore', 'UpdateStore', 'UpdateStoreConfig', 'DescribeStores', 'DescribeStoreConfig'],
'type' => 'directory',
'title' => 'Stores',
],
[
'children' => ['DeleteItem', 'BatchInsertItems', 'DescribeItems'],
'type' => 'directory',
'title' => 'Items',
],
[
'children' => ['AssignUser', 'UnassignUser', 'DescribeUserLog'],
'type' => 'directory',
'title' => 'Users',
],
[
'children' => ['AddApDevice', 'DeleteApDevice', 'ActivateApDevice', 'DescribeApDevices'],
'type' => 'directory',
'title' => 'Base station devices',
],
[
'children' => ['ApplyCompanyTemplateVersionToStores', 'DescribeStoreByTemplateVersion', 'DescribeCompanyTemplateVersions', 'DescribeEslModelByTemplateVersion', 'DescribeTemplateByModel', 'DescribeAvailableEslModels', 'DeleteCompanyTemplate', 'AddCompanyTemplate', 'SyncAddMaterial', 'QueryTemplateListByGroupId'],
'type' => 'directory',
'title' => 'Other',
],
[
'children' => ['AddUser', 'DeleteUser', 'DescribeUsers', 'GetUser'],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'ActivateApDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApMac',
'in' => 'formData',
'schema' => ['description' => 'The MAC address of the base station device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'The request status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'ActivateApDevice',
'summary' => 'Activates a base station device.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:47.000Z', 'description' => 'Error codes changed'],
],
],
'AddApDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ApMac',
'in' => 'formData',
'schema' => ['description' => 'The MAC address of the base station device. You can call DescribeApDevices to obtain this value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'formData',
'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => '天猫店的基站设备', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '1*', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'SerialNumber',
'in' => 'formData',
'schema' => ['description' => 'The serial number (SN) of the device.', 'type' => 'string', 'required' => false, 'example' => '18****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Add a base station device',
'summary' => 'Adds a base station device with the specified MAC address and automatically attempts to activate it.',
'requestParamsDescription' => 'The Remark parameter is not supported.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:47.000Z', 'description' => 'Error codes changed'],
],
],
'AddCompanyTemplate' => [
'summary' => 'Add a template.'."\n",
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Scene',
'in' => 'formData',
'schema' => ['description' => 'Scenarios. Select an appropriate scenario.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'NORMAL', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'System extension field. Ignore this field.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'EslSize',
'in' => 'formData',
'schema' => ['description' => 'ESL size', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '800X480', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'formData',
'schema' => ['description' => 'Template Name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '促销', 'maxLength' => 128, 'minLength' => 0, 'title' => ''],
],
[
'name' => 'Layout',
'in' => 'formData',
'schema' => ['description' => 'Layout information.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => ['description' => 'Outlet template version.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.1.0', 'title' => ''],
],
[
'name' => 'DeviceType',
'in' => 'formData',
'schema' => ['description' => 'Device type', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
[
'name' => 'TemplateType',
'in' => 'formData',
'schema' => ['description' => 'Template type'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'IfPromotion',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether it is a promotion. Valid values: - true: Yes. - false: No.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IfSourceCode',
'in' => 'formData',
'schema' => ['description' => 'Indicates whether source tracing is enabled. Valid values: - true: Yes. - false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IfDefault',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether the template is the default one. Valid values: - true: Yes. - false: No.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IfMember',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether it is for membership. Valid values: - true: Yes. - false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IfOutOfInventory',
'in' => 'formData',
'schema' => ['description' => 'Indicates whether the item is out of stock. Valid values: - true: Yes. - false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'Vendor',
'in' => 'formData',
'schema' => ['description' => 'Device manufacturer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ali', 'title' => ''],
],
[
'name' => 'GroupId',
'in' => 'formData',
'schema' => ['description' => 'Template group ID', 'type' => 'string', 'required' => false, 'example' => '9', 'title' => ''],
],
[
'name' => 'TemplateSceneId',
'in' => 'formData',
'schema' => ['description' => 'Custom Template ID'."\n", 'type' => 'string', 'required' => false, 'example' => '大甩卖', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'C033DCCE-FA85-5AD8-9A7C-C3F41220B898', 'title' => ''],
'ErrorMessage' => ['description' => 'Error message returned when the invocation fails.'."\n", 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request succeeded.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'Error code'."\n", 'type' => 'string', 'example' => 'InvalidResourceType.NotSupported', 'title' => ''],
'Code' => ['description' => 'HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'Response message. If the request succeeds, the value is "success".'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'Error message'."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code.'."\n", 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
418 => [
['errorCode' => 'DuplicateTemplateSceneIdErrorPub', 'errorMessage' => 'The TemplateSceneId is duplicated.', 'description' => ''],
['errorCode' => 'ContainerLayoutBindEslDevicePub', 'errorMessage' => 'The Layout of the Container has been bound to an ESL device.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C033DCCE-FA85-5AD8-9A7C-C3F41220B898\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"InvalidResourceType.NotSupported\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'changeSet' => [
['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'title' => '',
],
'AddUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '134****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '1*', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Create a user',
'summary' => 'Creates a user.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:46.000Z', 'description' => 'Error codes changed'],
],
],
'ApplyCompanyTemplateVersionToStores' => [
'summary' => 'Apply the version to outlets.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => ['description' => 'Outlet template version number.', 'type' => 'string', 'required' => true, 'example' => '1.1.0', 'title' => ''],
],
[
'name' => 'Stores',
'in' => 'formData',
'schema' => ['description' => 'List of outlet IDs. Convert it to a JSON string.', 'type' => 'string', 'required' => false, 'example' => '[\\"s-y9eoecc7mu\\"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764', 'title' => ''],
'ErrorMessage' => ['description' => 'Error message returned when the invocation fails.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'Response message. If the request succeeds, the value is "success".', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the ErrorMessage parameter of the response.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450E6CA4-5C5D-5DED-86C2-2B577C291764\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
],
'AssignUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Stores',
'in' => 'formData',
'schema' => ['description' => 'The list of store IDs.', 'type' => 'string', 'required' => false, 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The UID of the Alibaba Cloud RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***', 'title' => ''],
],
[
'name' => 'UserType',
'in' => 'formData',
'schema' => ['description' => 'The type of the user. Valid values:'."\n"
."\n"
.'- `USER_TYPE_COMPANY_ROOT`: Super merchant administrator. This role can create, read, update, and delete accounts related to merchants and stores.'."\n"
."\n"
.'- `USER_TYPE_COMPANY_ADMIN`: Merchant administrator. This role can create, read, update, and delete accounts related to stores under the merchant.'."\n"
."\n"
.'- `USER_TYPE_STORE_ADMIN`: Store administrator. A store administrator can be associated with multiple stores, but each store can only be associated with one store administrator.'."\n"
."\n"
.'- `USER_TYPE_STORE_OPERATOR`: Store operator. This role can only be associated with one store.'."\n"
."\n"
.'- `USER_TYPE_GUEST`: Guest with no permissions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The extended information.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters ', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001 ', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters \\",\\n \\"Code\\": \\"-1001 \\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'AssignUser',
'summary' => 'Assigns user permissions.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:46.000Z', 'description' => 'Error codes changed'],
],
],
'BatchInsertItems' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or merchant-defined custom store ID. A maximum of 100 records can be inserted at a time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'SyncByItemId',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to update item information for other items with the same ItemId in the store. Default value: false. If this parameter is set to true, the item information is updated for all items with the same ItemId in the store. If the item list contains multiple items with the same ItemId, the last item in the list is used for the update.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ItemInfo',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of item information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ActionPrice' => ['description' => 'The actual selling price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '500', 'title' => ''],
'ItemTitle' => ['description' => 'The full name of the item. Maximum length: 100 characters.', 'type' => 'string', 'required' => true, 'example' => '光明儿童星', 'title' => ''],
'BrandName' => ['description' => 'The brand name. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '光明乳业', 'title' => ''],
'SourceCode' => ['description' => 'The traceability code. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '1234567', 'title' => ''],
'PriceUnit' => ['description' => 'The pricing unit. Maximum length: 64 characters.', 'type' => 'string', 'required' => true, 'example' => '箱', 'title' => ''],
'ForestFirstId' => ['description' => 'The first-level item category ID. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '食品', 'title' => ''],
'CustomizeFeatureF' => ['description' => 'The custom attribute F. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性F', 'title' => ''],
'CustomizeFeatureA' => ['description' => 'The custom attribute A. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性A', 'title' => ''],
'CustomizeFeatureK' => ['description' => 'The custom attribute K. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性K', 'title' => ''],
'TemplateSceneId' => ['description' => 'The custom template ID. If valid characters are specified, the system matches the custom template for item display. Default value: empty string "".', 'type' => 'string', 'required' => false, 'example' => '23452', 'title' => ''],
'CustomizeFeatureD' => ['description' => 'The custom attribute D. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性D', 'title' => ''],
'MemberPrice' => ['description' => 'The member price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', 'title' => ''],
'ModelNumber' => ['description' => 'The model number. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '330', 'title' => ''],
'PromotionStart' => ['description' => 'The promotion start time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'required' => false, 'example' => '2020-02-10T00:00:00Z', 'title' => ''],
'CategoryName' => ['description' => 'The category name. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '饮料', 'title' => ''],
'CustomizeFeatureE' => ['description' => 'The custom attribute E. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性E', 'title' => ''],
'SuggestPrice' => ['description' => 'The suggested retail price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', 'title' => ''],
'SaleSpec' => ['description' => 'The specification. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '330毫升', 'title' => ''],
'PromotionText' => ['description' => 'The promotion text. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '买一送一', 'title' => ''],
'PromotionReason' => ['description' => 'The promotion reason. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '儿童节活动', 'title' => ''],
'Rank' => ['description' => 'The rank. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '1级', 'title' => ''],
'CustomizeFeatureG' => ['description' => 'The custom attribute G. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性G', 'title' => ''],
'SalesPrice' => ['description' => 'The sales price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
'CustomizeFeatureH' => ['description' => 'The custom attribute H. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性H', 'title' => ''],
'OriginalPrice' => ['description' => 'The original price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
'CustomizeFeatureI' => ['description' => 'The custom attribute I. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性I', 'title' => ''],
'ProductionPlace' => ['description' => 'The place of origin. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '中国', 'title' => ''],
'CustomizeFeatureB' => ['description' => 'The custom attribute B. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性B', 'title' => ''],
'ItemShortTitle' => ['description' => 'The short name of the item. If not specified, the value is truncated from the full item name. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '牛奶', 'title' => ''],
'CustomizeFeatureN' => ['description' => 'The custom attribute N. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性N', 'title' => ''],
'BeMember' => ['description' => 'Specifies whether to match the member template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'TaxFee' => ['description' => 'The tax information. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '增值税', 'title' => ''],
'InventoryStatus' => ['description' => 'Specifies whether to match the out-of-stock template for display. Valid values:'."\n"
."\n"
.'- `OUT_OF_STOCK`: out of stock.'."\n"
."\n"
.'- `NORMAL`: Normal.'."\n"
."\n"
.'Default value: NORMAL. If this parameter is set to OUT_OF_STOCK, the out-of-stock template is used for display.', 'type' => 'string', 'required' => false, 'example' => 'OUT_OF_STOCK', 'title' => ''],
'ItemPicUrl' => ['description' => 'The URL of the item image. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
'SupplierName' => ['description' => 'The distributor name. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '天猫超市', 'title' => ''],
'CustomizeFeatureL' => ['description' => 'The custom attribute L. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性L', 'title' => ''],
'EnergyEfficiency' => ['description' => 'The energy efficiency rating. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '2焦/毫升', 'title' => ''],
'CustomizeFeatureC' => ['description' => 'The custom attribute C. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性C', 'title' => ''],
'ItemId' => ['description' => 'The custom item barcode. Only Arabic numerals that form an integer are allowed.', 'type' => 'string', 'required' => true, 'example' => '1234567', 'title' => ''],
'Manufacturer' => ['description' => 'The manufacturer name. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '中国制造', 'title' => ''],
'Material' => ['description' => 'The material. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '新鲜牛奶', 'title' => ''],
'CustomizeFeatureJ' => ['description' => 'The custom attribute J. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性J', 'title' => ''],
'CustomizeFeatureO' => ['description' => 'The custom attribute O. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性O', 'title' => ''],
'CustomizeFeatureP' => ['description' => 'The custom attribute P. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性P', 'title' => ''],
'CustomizeFeatureQ' => ['description' => 'The custom attribute Q. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性Q', 'title' => ''],
'CustomizeFeatureR' => ['description' => 'The custom attribute R. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性R', 'title' => ''],
'CustomizeFeatureS' => ['description' => 'The custom attribute S. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性S', 'title' => ''],
'CustomizeFeatureT' => ['description' => 'The custom attribute T. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性T', 'title' => ''],
'CustomizeFeatureU' => ['description' => 'The custom attribute U. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性U', 'title' => ''],
'CustomizeFeatureV' => ['description' => 'The custom attribute V. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性V', 'title' => ''],
'CustomizeFeatureW' => ['description' => 'The custom attribute W. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性W', 'title' => ''],
'CustomizeFeatureX' => ['description' => 'The custom attribute X. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '345678', 'title' => ''],
'CustomizeFeatureY' => ['description' => 'The custom attribute Y. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => 'YYY', 'title' => ''],
'CustomizeFeatureZ' => ['description' => 'The custom attribute Z. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => 'ZZZZ', 'title' => ''],
'SkuId' => ['description' => 'The item ID (SKU). Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '1234567', 'title' => ''],
'CustomizeFeatureM' => ['description' => 'The custom attribute M. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性M', 'title' => ''],
'BePromotion' => ['description' => 'Specifies whether to match the promotion template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'BeSourceCode' => ['description' => 'Specifies whether to match the traceability template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'ForestSecondId' => ['description' => 'The second-level item category ID. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '饮料', 'title' => ''],
'ItemQrCode' => ['description' => 'The QR code URL of the item. Maximum length: 1024 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
'ItemInfoIndex' => ['description' => 'The item information index. You do not need to specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'PromotionEnd' => ['description' => 'The promotion end time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'required' => false, 'example' => '2020-02-01T00:00:00Z', 'title' => ''],
'ItemBarCode' => ['description' => 'The item barcode. The value is case-insensitive. Maximum length: 64 characters.', 'type' => 'string', 'required' => true, 'example' => '690560583****', 'title' => ''],
'BeClearance' => ['description' => 'Specifies whether to match the clearance template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 500,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'BatchResults' => [
'description' => 'The batch results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Index' => ['description' => 'The index of the request sequence.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current item was inserted successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"BatchResults\\": [\\n {\\n \\"Index\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'BatchInsertItems',
'summary' => 'Creates or updates item information in batches. A maximum of 100 items can be processed per request, and each request cannot contain duplicate item barcodes.',
'requestParamsDescription' => 'The following item information fields are used for template matching and display, listed in descending order of priority:'."\n"
."\n"
.'- TemplateSceneId: attempts to match a custom template.'."\n"
.'- InventoryStatus: attempts to match the out-of-stock template.'."\n"
.'- BeMember: attempts to match the member template.'."\n"
.'- BeSourceCode && BePromotion: attempts to match the marketing template.'."\n"
.'- BeSourceCode: attempts to match the traceability template.'."\n"
.'- BePromotion: attempts to match the promotion template.'."\n"
.'- BeClearance: attempts to match the clearance template.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-07-18T13:13:48.000Z', 'description' => 'Request parameters changed'],
],
],
'BindEslDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The item bar code.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
[
'name' => 'EslBarCode',
'in' => 'formData',
'schema' => ['description' => 'The ESL bar code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18bc5a63****', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'Shelf',
'in' => 'formData',
'schema' => ['description' => 'The shelf number in the display system.', 'type' => 'string', 'required' => false, 'example' => '20200201', 'title' => ''],
],
[
'name' => 'Layer',
'in' => 'formData',
'schema' => ['description' => 'The layer number in the display system.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Column',
'in' => 'formData',
'schema' => ['description' => 'The logical column in the display system.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'LayoutId',
'in' => 'formData',
'schema' => ['description' => 'The layout ID. Only a single ID is supported.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
],
[
'name' => 'ContainerId',
'in' => 'formData',
'schema' => ['description' => 'The container ID.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'ContainerName',
'in' => 'formData',
'schema' => ['description' => 'The container name.', 'type' => 'string', 'required' => false, 'example' => '区域4号', 'title' => ''],
],
[
'name' => 'LayoutName',
'in' => 'formData',
'schema' => ['description' => 'The layout name.', 'type' => 'string', 'required' => false, 'example' => '布局2号', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
418 => [
['errorCode' => 'LayoutOrContainerIsNotExistErrorPub', 'errorMessage' => 'Layout or Container is not exist.', 'description' => ''],
['errorCode' => 'ContainerTemplateNoMatchPub', 'errorMessage' => 'The Template of the Container has not match at all.', 'description' => 'The Template of the Container has not match at all.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Bind a cloudESL device',
'summary' => 'Binds a CloudESL device.',
'description' => 'This operation supports two modes: display mode and standard mode. In display mode, binding is performed by using a display shelf position and an ESL bar code. In standard mode, binding is performed by using an item bar code and an ESL bar code.',
'requestParamsDescription' => ' In standard binding mode, StoreId, EslBarCode, and ItemBarCode are required.'."\n"
.'In display binding mode, StoreId, EslBarCode, Shelf, Layer, and Column are required. If ItemBarCode is specified, it must be consistent with the information stored in the display shelf position.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
],
'CreateStore' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ParentId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the parent store.', 'type' => 'string', 'required' => false, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'UserStoreCode',
'in' => 'formData',
'schema' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'required' => false, 'example' => '20200201', 'title' => ''],
],
[
'name' => 'StoreName',
'in' => 'formData',
'schema' => ['description' => 'The store name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '天猫旗舰店', 'title' => ''],
],
[
'name' => 'Phone',
'in' => 'formData',
'schema' => ['description' => 'The phone number of the store.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571-5666888', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '1212', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'TimeZone',
'in' => 'formData',
'schema' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'GMT+08:00', 'title' => ''],
],
[
'name' => 'BarCodeEncode',
'in' => 'formData',
'schema' => [
'description' => 'The barcode encoding method. Valid values:'."\n"
.'- 0: Code128.'."\n"
.'- 1: EAN13.'."\n"
."\n"
.'Default value: 0.',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'maximum' => '1',
'minimum' => '0',
'example' => '0',
'default' => '0',
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Create store',
'summary' => 'Adds a store.',
'requestParamsDescription' => ' The ParentId parameter is not supported.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteApDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ApMac',
'in' => 'formData',
'schema' => ['description' => 'The MAC address of the base station device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Delete a base station device',
'summary' => 'Deletes a base station device with the specified MAC address.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:44.000Z', 'description' => 'Error codes changed'],
],
],
'DeleteCompanyTemplate' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'formData',
'schema' => ['description' => 'Template ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '742842379343605760', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'System extension field. Ignore it. ', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'A7571D49-9B36-5782-AD3D-32C8436D45B7', 'title' => ''],
'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the POP request succeeded. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'Error code. The value is described as follows: If the request succeeds, the ErrorCode field is not returned. If the request fails, the ErrorCode field is returned. For more information, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'HTTP status code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'Error code. ', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the error message returned by the ErrMessage parameter. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7571D49-9B36-5782-AD3D-32C8436D45B7\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
'summary' => '',
],
'DeleteItem' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or merchant-defined custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The bar code of the item.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '693737264225', 'title' => ''],
],
[
'name' => 'UnbindEslDevice',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to unbind the CloudESL device that is bound to the item. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Delete a store item',
'summary' => 'Deletes a store item.',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:43.000Z', 'description' => 'Error codes changed'],
],
],
'DeleteStore' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'DeleteStore',
'summary' => 'Deletes a store.',
'description' => 'Before you begin: The store must not contain any items or electronic shelf labels (ESLs).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' Before deleting a store, ensure that the store does not contain any items, ESL devices, or base station devices.',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:43.000Z', 'description' => 'Error codes changed'],
],
],
'DeleteUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Delete a user',
'summary' => 'Deletes a user.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:42.000Z', 'description' => 'Error codes changed'],
],
],
'DescribeApDevices' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ApMac',
'in' => 'formData',
'schema' => ['description' => 'The MAC address of the AP device.', 'type' => 'string', 'required' => false, 'example' => '112233445566', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => ['description' => 'The online or offline status of the device. Valid values:'."\n"
.'- true: online.'."\n"
.'- false: offline.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => ['description' => 'The device model.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''],
],
[
'name' => 'BeActivate',
'in' => 'formData',
'schema' => ['description' => 'The activation status of the device.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'ApDevices' => [
'description' => 'The list of AP devices.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The online status of the device, such as offline.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-cxsds****', 'title' => ''],
'Model' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''],
'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '测试数据', 'title' => ''],
'BeActivate' => ['description' => 'Indicates whether the device is activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Mac' => ['description' => 'The MAC address of the device.', 'type' => 'string', 'example' => '112233445566', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"ApDevices\\": [\\n {\\n \\"Status\\": false,\\n \\"StoreId\\": \\"s-cxsds****\\",\\n \\"Model\\": \\"aliyun\\",\\n \\"Remark\\": \\"测试数据\\",\\n \\"BeActivate\\": true,\\n \\"Mac\\": \\"112233445566\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query AP devices',
'summary' => 'Queries information about access point (AP) devices.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:42.000Z', 'description' => 'Error codes changed'],
],
],
'DescribeAvailableEslModels' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'ModelId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Device model ID ', 'type' => 'string', 'required' => false, 'example' => '6cd23870539e43759e65eef5b6808a49'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Model name ', 'type' => 'string', 'required' => false, 'example' => 'aa_ssaaa'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Page size ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'DescribeAvailableEslModelsResponse',
'description' => 'DescribeAvailableEslModelsResponse',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'Total count. ', 'type' => 'integer', 'format' => 'int32', 'example' => '436', 'title' => ''],
'PageSize' => ['description' => 'Pagination parameter: number of entries per page. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'Pagination parameter: current page number. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'EslModels' => [
'description' => 'List of ESL information. ',
'type' => 'array',
'items' => [
'description' => 'List of ESL information. ',
'type' => 'object',
'properties' => [
'ModelId' => ['title' => '', 'description' => 'Model ID ', 'type' => 'string', 'example' => '201167'],
'Name' => ['title' => '', 'description' => 'Name ', 'type' => 'string', 'example' => '中文名测试'],
'DeviceType' => ['title' => '', 'description' => 'Device type ', 'type' => 'string', 'example' => '3'],
'Vendor' => ['title' => '', 'description' => 'Vendor ', 'type' => 'string', 'example' => 'ali'],
'ScreenWidth' => ['title' => '', 'description' => 'Screen width ', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
'ScreenHeight' => ['title' => '', 'description' => 'Screen height ', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
'EslSize' => ['title' => '', 'description' => 'Screen size ', 'type' => 'string', 'example' => '800X480'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'Success' => ['description' => 'Request status identifier. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'Response message. If the request succeeded, the value is "success". ', 'type' => 'string', 'example' => 'success', 'title' => ''],
'ErrorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Code' => ['description' => 'Status code. A return value of 200 indicates success. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message, used to replace the "%s" placeholder in the error message returned in the ErrMessage parameter. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 436,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"EslModels\\": [\\n {\\n \\"ModelId\\": \\"201167\\",\\n \\"Name\\": \\"中文名测试\\",\\n \\"DeviceType\\": \\"3\\",\\n \\"Vendor\\": \\"ali\\",\\n \\"ScreenWidth\\": 0,\\n \\"ScreenHeight\\": 0,\\n \\"EslSize\\": \\"800X480\\"\\n }\\n ],\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Code\\": \\"-1001\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\"\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
'summary' => '',
],
'DescribeBinders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The bar code of the item.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
[
'name' => 'EslBarCode',
'in' => 'formData',
'schema' => ['description' => 'The bar code of the ESL. If you query by store ID and ESL bar code, you do not need to specify the shelf number or layer number.', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ItemTitle',
'in' => 'formData',
'schema' => ['description' => 'The name of the item.', 'type' => 'string', 'required' => false, 'example' => '纯牛奶', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6E0FF7FA-3F89-598F-9BF2-57DF480FE111', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code. If the request is successful, the ErrorCode field is not returned. If the request fails, the ErrorCode field is returned. For more information, see the error codes section of this topic.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic error message, which is used to replace the %s placeholder in the ErrMessage parameter.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'EslItemBindInfos' => [
'description' => 'The list of binding information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EslBarCode' => ['description' => 'The bar code of the ESL. If you query by store ID and ESL bar code, you do not need to specify the shelf number or layer number.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
'TemplateSceneId' => ['description' => 'The custom template ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'ActionPrice' => ['description' => 'The actual selling price, in cents.', 'type' => 'string', 'example' => '690', 'title' => ''],
'ItemTitle' => ['description' => 'The name of the item.', 'type' => 'string', 'example' => '麦麸吐司', 'title' => ''],
'PromotionStart' => ['description' => 'The promotion start time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2020-03-16T07:05:34Z', 'title' => ''],
'PriceUnit' => ['description' => 'The pricing unit. Maximum length: 64 characters.', 'type' => 'string', 'example' => '187', 'title' => ''],
'OriginalPrice' => ['description' => 'The original price, in cents.', 'type' => 'string', 'example' => '500', 'title' => ''],
'ItemId' => ['description' => 'The custom item bar code.', 'type' => 'string', 'example' => '1234567', 'title' => ''],
'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1656469716000', 'title' => ''],
'EslPic' => ['description' => 'The image displayed on the ESL. Use a Base64 decoding tool to decode the value into an image.', 'type' => 'string', 'example' => 'kUzlfuzgayDo5uTXW3D66Q', 'title' => ''],
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-pdwrrnkufn', 'title' => ''],
'ItemShortTitle' => ['description' => 'The short name of the item. If not specified, the value is truncated from the full item name. Maximum length: 64 characters.', 'type' => 'string', 'example' => '牛奶', 'title' => ''],
'BindId' => ['description' => 'The binding ID.', 'type' => 'string', 'example' => 'b4adf048-f36d-4da5-a8bb-ab4adbd5eb04', 'title' => ''],
'PromotionText' => ['description' => 'The promotion text. Maximum length: 64 characters.', 'type' => 'string', 'example' => '买一送一', 'title' => ''],
'EslModel' => ['description' => 'The ESL model.', 'type' => 'string', 'example' => 'AESL0213', 'title' => ''],
'BePromotion' => ['description' => 'Indicates whether the promotion template is matched for display. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'SkuId' => ['description' => 'The item ID (SKU).', 'type' => 'string', 'example' => '124', 'title' => ''],
'EslConnectAp' => ['description' => 'The MAC address of the access point to which the ESL is connected.', 'type' => 'string', 'example' => '11:22:33:44:55:66', 'title' => ''],
'EslStatus' => ['description' => 'The ESL status. Valid values:'."\n"
."\n"
.'- `ESL_STATUS_ONLINE`: online and bound'."\n"
."\n"
.'- `ESL_STATUS_OFFLINE`: offline and bound'."\n"
."\n"
.'- `ESL_STATUS_UNBIND`: unbound.', 'type' => 'string', 'example' => 'ESL_STATUS_ONLINE', 'title' => ''],
'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'PromotionEnd' => ['description' => 'The promotion end time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2020-03-17T07:05:34Z', 'title' => ''],
'ItemBarCode' => ['description' => 'The item bar code.', 'type' => 'string', 'example' => '690560583****', 'title' => ''],
'ContainerName' => ['title' => '', 'description' => 'The name of the bound template area.', 'type' => 'string', 'example' => '2'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E0FF7FA-3F89-598F-9BF2-57DF480FE111\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"null\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 24,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"EslItemBindInfos\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"TemplateSceneId\\": \\"123456\\",\\n \\"ActionPrice\\": \\"690\\",\\n \\"ItemTitle\\": \\"麦麸吐司\\",\\n \\"PromotionStart\\": \\"2020-03-16T07:05:34Z\\",\\n \\"PriceUnit\\": \\"187\\",\\n \\"OriginalPrice\\": \\"500\\",\\n \\"ItemId\\": \\"1234567\\",\\n \\"GmtModified\\": \\"1656469716000\\",\\n \\"EslPic\\": \\"kUzlfuzgayDo5uTXW3D66Q\\",\\n \\"StoreId\\": \\"s-pdwrrnkufn\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"BindId\\": \\"b4adf048-f36d-4da5-a8bb-ab4adbd5eb04\\",\\n \\"PromotionText\\": \\"买一送一\\",\\n \\"EslModel\\": \\"AESL0213\\",\\n \\"BePromotion\\": true,\\n \\"SkuId\\": \\"124\\",\\n \\"EslConnectAp\\": \\"11:22:33:44:55:66\\",\\n \\"EslStatus\\": \\"ESL_STATUS_ONLINE\\",\\n \\"TemplateId\\": \\"123456\\",\\n \\"PromotionEnd\\": \\"2020-03-17T07:05:34Z\\",\\n \\"ItemBarCode\\": \\"690560583****\\",\\n \\"ContainerName\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query binding information',
'summary' => 'Queries the binding information between items and electronic shelf labels (ESLs).',
'changeSet' => [
['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
],
'DescribeCompanyTemplateVersions' => [
'summary' => 'Version List ',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => [
'description' => 'Pagination parameter: current page number. Default value is 1.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [1 => '1'],
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => 'Pagination parameter: number of entries per page. Default value is 10.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [10 => '10'],
'example' => '10',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => '',
'description' => 'Total count. ',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => [18 => '18'],
'example' => '16',
],
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '6248311A-3296-5084-B057-D0EC3DCE5C47'],
'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the POP request succeeded.',
'type' => 'boolean',
'enumValueTitles' => ['True' => 'True'],
'example' => 'true',
'title' => '',
],
'ErrorCode' => ['description' => 'Error code. The following rules apply: If the request succeeded, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For details, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'Response message. If the request succeeded, the value is "success". ', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the error message returned in the ErrMessage parameter. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code associated with this request. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'PageSize' => ['description' => 'Pagination parameter: number of entries per page. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'Pagination parameter: current page number. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Versions' => [
'description' => 'List of versions. ',
'type' => 'array',
'items' => [
'description' => 'List of versions. ',
'type' => 'object',
'properties' => [
'Version' => ['description' => 'Version number. ', 'type' => 'string', 'example' => '1.1.0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 16,\\n \\"RequestId\\": \\"6248311A-3296-5084-B057-D0EC3DCE5C47\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Versions\\": [\\n {\\n \\"Version\\": \\"1.1.0\\"\\n }\\n ]\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
],
'DescribeEslDevice' => [
'summary' => 'Incrementally queries the data binding status of price tags.',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'FromDate',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ToDate',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'PageSize' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'PageNumber' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'EslDetails' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EslBarCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'LastUpdateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ItemBarCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'ItemId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'ItemShortTitle' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'StoreId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'example' => '',
],
],
],
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 0,\\n \\"PageSize\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"PageNumber\\": 0,\\n \\"Success\\": false,\\n \\"EslDetails\\": [\\n {\\n \\"EslBarCode\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"ItemBarCode\\": 0,\\n \\"ItemId\\": 0,\\n \\"ItemShortTitle\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"StoreId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '',
],
'DescribeEslDevices' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => 'The type of the electronic shelf label (ESL). Valid values:'."\n"
."\n"
.'- `ESL_TYPE_E_INK`: e-ink screen'."\n"
."\n"
.'- `ESL_TYPE_DM_LCD`: segment code screen'."\n"
."\n"
.'- `ESL_TYPE_FULL_COLOR`: color screen.', 'type' => 'string', 'required' => false, 'example' => 'ESL_TYPE_E_INK', 'title' => ''],
],
[
'name' => 'TypeEncode',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The type of the ESL. Valid values:'."\n"
."\n"
.'- `NORMAL`: standard'."\n"
."\n"
.'- `LOW_TEMPLATE`: low-temperature'."\n"
."\n"
.'- `THREE_COLOR`: three-color'."\n"
."\n"
.'- `ESL_TYPE_DM_LCD`: segment code'."\n"
."\n"
.'- `ESL_TYPE_FULL_COLOR`: color'."\n"
."\n"
.'- `ESL_TYPE_MUTI_MEDIA`: multimedia.', 'type' => 'string', 'required' => false, 'example' => 'LOW_TEMPLATE'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ToBatteryLevel',
'in' => 'formData',
'schema' => ['description' => 'The upper bound of the battery level range. The battery level is greater than or equal to the specified value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'EslStatus',
'in' => 'formData',
'schema' => ['description' => 'The status of the ESL. Valid values:'."\n"
."\n"
.'- `ESL_STATUS_ONLINE`: online and bound'."\n"
."\n"
.'- `ESL_STATUS_OFFLINE`: offline and bound'."\n"
."\n"
.'- `ESL_STATUS_UNBIND`: unbound.', 'type' => 'string', 'required' => false, 'example' => 'ESL_STATUS_ONLINE', 'title' => ''],
],
[
'name' => 'EslBarCode',
'in' => 'formData',
'schema' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****', 'title' => ''],
],
[
'name' => 'FromBatteryLevel',
'in' => 'formData',
'schema' => ['description' => 'The lower bound of the battery level range. The battery level is less than or equal to the specified value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters ', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'EslDevices' => [
'description' => 'The list of ESL device information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of the ESL. Valid values:'."\n"
."\n"
.'- `ESL_TYPE_E_INK`: e-ink screen'."\n"
."\n"
.'- `ESL_TYPE_DM_LCD`: segment code screen'."\n"
."\n"
.'- `ESL_TYPE_FULL_COLOR`: color screen.', 'type' => 'string', 'example' => 'ESL_TYPE_E_INK', 'title' => ''],
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx****', 'title' => ''],
'EslBarCode' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
'Model' => ['description' => 'The model of the ESL.', 'type' => 'string', 'example' => 'AESL0213', 'title' => ''],
'LastCommunicateTime' => ['description' => 'The last communication time.', 'type' => 'string', 'example' => '2020-03-16T07:04:16Z', 'title' => ''],
'ScreenHeight' => ['description' => 'The screen height, in px.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'ScreenWidth' => ['description' => 'The screen width, in px.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'EslSignal' => ['description' => 'The signal strength of the ESL.', 'type' => 'integer', 'format' => 'int32', 'example' => '54', 'title' => ''],
'BatteryLevel' => ['description' => 'The battery level.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'EslStatus' => ['description' => 'The status of the ESL. Valid values:'."\n"
."\n"
.'- `ESL_STATUS_ONLINE`: online and bound'."\n"
."\n"
.'- `ESL_STATUS_OFFLINE`: offline and bound'."\n"
."\n"
.'- `ESL_STATUS_UNBIND`: unbound.', 'type' => 'string', 'example' => 'ESL_STATUS_ONLINE', 'title' => ''],
'Mac' => ['description' => 'The MAC address of the ESL.', 'type' => 'string', 'example' => '18:bc:5a:63:**:**', 'title' => ''],
'TypeEncode' => ['title' => '', 'description' => 'The type encoding. Valid values:'."\n"
.'NORMAL: standard'."\n"
.'LOW_TEMPLATE: low-temperature ESL'."\n"
.'THREE_COLOR: three-color ESL'."\n"
.'ESL_TYPE_DM_LCD: segment code screen'."\n"
.'ESL_TYPE_FULL_COLOR: color screen'."\n"
.'ESL_TYPE_MUTIMEDIA: multimedia.', 'type' => 'string', 'example' => 'THREE_COLOR'],
'LayoutId' => ['description' => 'The layout ID. Only a single ID is supported.', 'type' => 'string', 'example' => '7', 'title' => ''],
'LayoutName' => ['description' => 'The layout name.', 'type' => 'string', 'example' => '新增布局', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters \\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"EslDevices\\": [\\n {\\n \\"Type\\": \\"ESL_TYPE_E_INK\\",\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"Model\\": \\"AESL0213\\",\\n \\"LastCommunicateTime\\": \\"2020-03-16T07:04:16Z\\",\\n \\"ScreenHeight\\": 200,\\n \\"ScreenWidth\\": 200,\\n \\"EslSignal\\": 54,\\n \\"BatteryLevel\\": 100,\\n \\"EslStatus\\": \\"ESL_STATUS_ONLINE\\",\\n \\"Mac\\": \\"18:bc:5a:63:**:**\\",\\n \\"TypeEncode\\": \\"THREE_COLOR\\",\\n \\"LayoutId\\": \\"7\\",\\n \\"LayoutName\\": \\"新增布局\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query cloudESL devices',
'summary' => 'Queries CloudESL device information.',
'requestParamsDescription' => 'Querying by battery level range is not currently supported.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-03-30T08:13:18.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'],
],
],
'DescribeEslModelByTemplateVersion' => [
'summary' => 'Query device types by version ',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => [
'description' => 'The outlet template version number. ',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['1.1.0' => '1.1.0'],
'example' => '1.1.0',
'title' => '',
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'Pagination parameter: the current page number. Default value: 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'Pagination parameter: the number of entries to display per page. Default value: 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '', 'description' => 'TotalCount is the total amount of data under the conditions of this request. This parameter is optional and does not need to be returned by default. ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'RequestId' => ['description' => 'The request ID. ', 'type' => 'string', 'example' => '38F85526-14B8-54A8-A0BB-3B200BBC3682', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'The request status identifier. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code. The value is interpreted as follows: If the request succeeded, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For more information, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The HTTP status code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The error message. ', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the ErrMessage error message. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'PageNumber' => ['description' => 'Pagination parameter: the current page number. Default value: 1. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'Pagination parameter: the number of entries to display per page. Default value: 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'EslModels' => [
'description' => 'List of template version information. ',
'type' => 'array',
'items' => [
'description' => 'List of template version information. ',
'type' => 'object',
'properties' => [
'ModelId' => ['description' => 'Model ID ', 'type' => 'string', 'example' => '9946366490094af4ab16bfe023ad5f22', 'title' => ''],
'Name' => ['description' => 'The model name. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
'Image' => ['description' => 'Product image. ', 'type' => 'string', 'example' => '/9xwqexcdaxasada....', 'title' => ''],
'DeviceType' => ['description' => 'Device type ', 'type' => 'string', 'example' => '3', 'title' => ''],
'Vendor' => ['description' => 'Vendor name ', 'type' => 'string', 'example' => 'ali', 'title' => ''],
'ScreenWidth' => ['description' => 'Screen width. ', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
'ScreenHeight' => ['description' => 'Screen height. ', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
'EslSize' => ['description' => 'ESL model. ', 'type' => 'string', 'example' => '800X480', 'title' => ''],
'EslPhysicalSize' => ['description' => 'Memory size. Unit: GiB ', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"38F85526-14B8-54A8-A0BB-3B200BBC3682\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"EslModels\\": [\\n {\\n \\"ModelId\\": \\"9946366490094af4ab16bfe023ad5f22\\",\\n \\"Name\\": \\"test\\",\\n \\"Image\\": \\"/9xwqexcdaxasada....\\",\\n \\"DeviceType\\": \\"3\\",\\n \\"Vendor\\": \\"ali\\",\\n \\"ScreenWidth\\": 0,\\n \\"ScreenHeight\\": 0,\\n \\"EslSize\\": \\"800X480\\",\\n \\"EslPhysicalSize\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
],
'DescribeItems' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'Pagination parameter: the number of entries to display per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'Pagination parameter: the current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ItemTitle',
'in' => 'formData',
'schema' => ['description' => 'The item title.', 'type' => 'string', 'required' => false, 'example' => '纯牛奶', 'title' => ''],
],
[
'name' => 'SkuId',
'in' => 'formData',
'schema' => ['description' => 'The SKU ID.', 'type' => 'string', 'required' => false, 'example' => '1234565', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or merchant-defined custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The item barcode.', 'type' => 'string', 'required' => false, 'example' => '6941297417178', 'title' => ''],
],
[
'name' => 'ItemId',
'in' => 'formData',
'schema' => ['description' => 'The item ID.', 'type' => 'string', 'required' => false, 'example' => '6959294202901', 'title' => ''],
],
[
'name' => 'BePromotion',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to display with the promotion template. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TemplateSceneId' => ['description' => 'The custom template ID.', 'type' => 'string', 'example' => '1223', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The error prompt message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic error message used to replace **%s** in the **ErrMessage** return parameter.'."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'PageNumber' => ['description' => 'Pagination parameter: the current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'Pagination parameter: the number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Items' => [
'description' => 'The list of item information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ActionPrice' => ['description' => 'The actual selling price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
'ItemTitle' => ['description' => 'The item title.', 'type' => 'string', 'example' => '纯牛奶', 'title' => ''],
'BrandName' => ['description' => 'The brand name. Maximum length: 64 characters.', 'type' => 'string', 'example' => '阿里巴巴', 'title' => ''],
'SourceCode' => ['description' => 'The traceability code. Maximum length: 128 characters.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'PriceUnit' => ['description' => 'The pricing unit. Maximum length: 64 characters.', 'type' => 'string', 'example' => '瓶', 'title' => ''],
'ForestFirstId' => ['description' => 'The first-level item category ID.', 'type' => 'string', 'example' => '酒类', 'title' => ''],
'CustomizeFeatureF' => ['description' => 'Custom attribute F.', 'type' => 'string', 'example' => '自定义属性F', 'title' => ''],
'CustomizeFeatureA' => ['description' => 'Custom attribute A.', 'type' => 'string', 'example' => '自定义属性A', 'title' => ''],
'CustomizeFeatureK' => ['description' => 'Custom attribute K.', 'type' => 'string', 'example' => '自定义属性K', 'title' => ''],
'TemplateSceneId' => ['description' => 'The custom template ID.', 'type' => 'string', 'example' => '11223', 'title' => ''],
'CustomizeFeatureD' => ['description' => 'Custom attribute D.', 'type' => 'string', 'example' => '自定义属性D', 'title' => ''],
'MemberPrice' => ['description' => 'The member price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '4000', 'title' => ''],
'PromotionStart' => ['description' => 'The promotion start time in UTC format "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2022-04-25T16:00:00Z', 'title' => ''],
'ModelNumber' => ['description' => 'The model number. Maximum length: 64 characters.', 'type' => 'string', 'example' => 'CH8850AS', 'title' => ''],
'CategoryName' => ['description' => 'The category name. Maximum length: 64 characters.', 'type' => 'string', 'example' => '手机', 'title' => ''],
'CustomizeFeatureE' => ['description' => 'Custom attribute E.', 'type' => 'string', 'example' => '自定义属性E', 'title' => ''],
'SuggestPrice' => ['description' => 'The suggested retail price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
'SaleSpec' => ['description' => 'The specification. Maximum length: 64 characters.', 'type' => 'string', 'example' => '1台/盒', 'title' => ''],
'PromotionText' => ['description' => 'The promotion text. Maximum length: 64 characters.', 'type' => 'string', 'example' => '买一送一', 'title' => ''],
'Rank' => ['description' => 'The rank. Maximum length: 32 characters.', 'type' => 'string', 'example' => '一级', 'title' => ''],
'PromotionReason' => ['description' => 'The promotion reason. Maximum length: 64 characters.', 'type' => 'string', 'example' => '情人节活动', 'title' => ''],
'CustomizeFeatureG' => ['description' => 'Custom attribute G.', 'type' => 'string', 'example' => '自定义属性G', 'title' => ''],
'SalesPrice' => ['description' => 'The sales price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
'CustomizeFeatureH' => ['description' => 'Custom attribute H.', 'type' => 'string', 'example' => '自定义属性H', 'title' => ''],
'OriginalPrice' => ['description' => 'The original price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
'GmtModified' => ['description' => 'The time when the item was last modified.', 'type' => 'string', 'example' => '2020-03-09T00:00:00Z', 'title' => ''],
'CustomizeFeatureI' => ['description' => 'Custom attribute I.', 'type' => 'string', 'example' => '自定义属性I', 'title' => ''],
'ProductionPlace' => ['description' => 'The place of production. Maximum length: 64 characters.', 'type' => 'string', 'example' => '中国', 'title' => ''],
'CustomizeFeatureB' => ['description' => 'Custom attribute B.', 'type' => 'string', 'example' => '1:1:16', 'title' => ''],
'ItemShortTitle' => ['description' => 'The item short title. If not specified, it is extracted from the full item title. Maximum length: 64 characters.', 'type' => 'string', 'example' => '牛奶', 'title' => ''],
'CustomizeFeatureN' => ['description' => 'Custom attribute N.', 'type' => 'string', 'example' => '自定义属性N', 'title' => ''],
'BeMember' => ['description' => 'Specifies whether to display with the member template. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'TaxFee' => ['description' => 'The tax information. Maximum length: 32 characters.', 'type' => 'string', 'example' => '增值税', 'title' => ''],
'InventoryStatus' => ['description' => 'The inventory status. Valid values:'."\n"
."\n"
.'- `OUT_OF_STOCK`: out of stock.'."\n"
."\n"
.'- `NORMAL`: normal.', 'type' => 'string', 'example' => 'OUT_OF_STOCK', 'title' => ''],
'SupplierName' => ['description' => 'The supplier name.', 'type' => 'string', 'example' => '天猫超市', 'title' => ''],
'ItemPicUrl' => ['description' => 'The item image URL.', 'type' => 'string', 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
'EnergyEfficiency' => ['description' => 'The energy efficiency. Maximum length: 64 characters.', 'type' => 'string', 'example' => '1kw/h', 'title' => ''],
'CustomizeFeatureL' => ['description' => 'Custom attribute L.', 'type' => 'string', 'example' => '自定义属性L', 'title' => ''],
'CustomizeFeatureC' => ['description' => 'Custom attribute C.', 'type' => 'string', 'example' => '自定义属性C', 'title' => ''],
'ItemId' => ['description' => 'The custom item barcode. Only Arabic numerals that form an integer are allowed.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'Manufacturer' => ['description' => 'The manufacturer. Maximum length: 128 characters.', 'type' => 'string', 'example' => '广东省深圳', 'title' => ''],
'Material' => ['description' => 'The material. Maximum length: 64 characters.', 'type' => 'string', 'example' => '金属', 'title' => ''],
'CustomizeFeatureO' => ['description' => 'Custom attribute O.', 'type' => 'string', 'example' => '自定义属性O', 'title' => ''],
'CustomizeFeatureP' => ['description' => 'Custom attribute P.', 'type' => 'string', 'example' => '自定义属性P', 'title' => ''],
'CustomizeFeatureQ' => ['description' => 'Custom attribute Q.', 'type' => 'string', 'example' => '自定义属性Q', 'title' => ''],
'CustomizeFeatureR' => ['description' => 'Custom attribute R.', 'type' => 'string', 'example' => '自定义属性R', 'title' => ''],
'CustomizeFeatureS' => ['description' => 'Custom attribute S.', 'type' => 'string', 'example' => '自定义属性S', 'title' => ''],
'CustomizeFeatureT' => ['description' => 'Custom attribute T.', 'type' => 'string', 'example' => '自定义属性T', 'title' => ''],
'CustomizeFeatureU' => ['description' => 'Custom attribute U.', 'type' => 'string', 'example' => '自定义属性U', 'title' => ''],
'CustomizeFeatureV' => ['description' => 'Custom attribute V.', 'type' => 'string', 'example' => '自定义属性V', 'title' => ''],
'CustomizeFeatureW' => ['description' => 'Custom attribute W.', 'type' => 'string', 'example' => '自定义属性W', 'title' => ''],
'CustomizeFeatureX' => ['description' => 'Custom attribute X.', 'type' => 'string', 'example' => '自定义属性X', 'title' => ''],
'CustomizeFeatureY' => ['description' => 'Custom attribute Y.', 'type' => 'string', 'example' => '自定义属性Y', 'title' => ''],
'CustomizeFeatureZ' => ['description' => 'Custom attribute Z.', 'type' => 'string', 'example' => '自定义属性Z', 'title' => ''],
'CustomizeFeatureJ' => ['description' => 'Custom attribute J.', 'type' => 'string', 'example' => '酸酸甜甜,肉厚饱满', 'title' => ''],
'GmtCreate' => ['description' => 'The creation time. Format: timestamp. Unit: milliseconds.', 'type' => 'string', 'example' => '2020-03-09T00:00:00Z', 'title' => ''],
'CustomizeFeatureM' => ['description' => 'Custom attribute M.', 'type' => 'string', 'example' => '自定义属性M', 'title' => ''],
'BePromotion' => ['description' => 'Specifies whether to display with the promotion template. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'SkuId' => ['description' => 'The SKU ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'BeSourceCode' => ['description' => 'Specifies whether to display with the traceability template. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ForestSecondId' => ['description' => 'The second-level item category ID.', 'type' => 'string', 'example' => '白酒', 'title' => ''],
'ItemQrCode' => ['description' => 'The item QR code URL. Maximum length: 1024 characters.', 'type' => 'string', 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
'ItemInfoIndex' => ['description' => 'The item information index. This field does not need to be specified.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PromotionEnd' => ['description' => 'The promotion end time in UTC format "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2020-02-11T00:00:00Z', 'title' => ''],
'ItemBarCode' => ['description' => 'The item barcode.', 'type' => 'string', 'example' => '01838', 'title' => ''],
'BeClearance' => ['description' => 'Indicates whether custom attributes have been added.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateSceneId\\": \\"1223\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"ActionPrice\\": 500,\\n \\"ItemTitle\\": \\"纯牛奶\\",\\n \\"BrandName\\": \\"阿里巴巴\\",\\n \\"SourceCode\\": \\"123456\\",\\n \\"PriceUnit\\": \\"瓶\\",\\n \\"ForestFirstId\\": \\"酒类\\",\\n \\"CustomizeFeatureF\\": \\"自定义属性F\\",\\n \\"CustomizeFeatureA\\": \\"自定义属性A\\",\\n \\"CustomizeFeatureK\\": \\"自定义属性K\\",\\n \\"TemplateSceneId\\": \\"11223\\",\\n \\"CustomizeFeatureD\\": \\"自定义属性D\\",\\n \\"MemberPrice\\": 4000,\\n \\"PromotionStart\\": \\"2022-04-25T16:00:00Z\\",\\n \\"ModelNumber\\": \\"CH8850AS\\",\\n \\"CategoryName\\": \\"手机\\",\\n \\"CustomizeFeatureE\\": \\"自定义属性E\\",\\n \\"SuggestPrice\\": 500,\\n \\"SaleSpec\\": \\"1台/盒\\",\\n \\"PromotionText\\": \\"买一送一\\",\\n \\"Rank\\": \\"一级\\",\\n \\"PromotionReason\\": \\"情人节活动\\",\\n \\"CustomizeFeatureG\\": \\"自定义属性G\\",\\n \\"SalesPrice\\": 500,\\n \\"CustomizeFeatureH\\": \\"自定义属性H\\",\\n \\"OriginalPrice\\": 500,\\n \\"GmtModified\\": \\"2020-03-09T00:00:00Z\\",\\n \\"CustomizeFeatureI\\": \\"自定义属性I\\",\\n \\"ProductionPlace\\": \\"中国\\",\\n \\"CustomizeFeatureB\\": \\"1:1:16\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"CustomizeFeatureN\\": \\"自定义属性N\\",\\n \\"BeMember\\": false,\\n \\"TaxFee\\": \\"增值税\\",\\n \\"InventoryStatus\\": \\"OUT_OF_STOCK\\",\\n \\"SupplierName\\": \\"天猫超市\\",\\n \\"ItemPicUrl\\": \\"http://m.taobao.com/xxx.html\\",\\n \\"EnergyEfficiency\\": \\"1kw/h\\",\\n \\"CustomizeFeatureL\\": \\"自定义属性L\\",\\n \\"CustomizeFeatureC\\": \\"自定义属性C\\",\\n \\"ItemId\\": \\"123456\\",\\n \\"Manufacturer\\": \\"广东省深圳\\",\\n \\"Material\\": \\"金属\\",\\n \\"CustomizeFeatureO\\": \\"自定义属性O\\",\\n \\"CustomizeFeatureP\\": \\"自定义属性P\\",\\n \\"CustomizeFeatureQ\\": \\"自定义属性Q\\",\\n \\"CustomizeFeatureR\\": \\"自定义属性R\\",\\n \\"CustomizeFeatureS\\": \\"自定义属性S\\",\\n \\"CustomizeFeatureT\\": \\"自定义属性T\\",\\n \\"CustomizeFeatureU\\": \\"自定义属性U\\",\\n \\"CustomizeFeatureV\\": \\"自定义属性V\\",\\n \\"CustomizeFeatureW\\": \\"自定义属性W\\",\\n \\"CustomizeFeatureX\\": \\"自定义属性X\\",\\n \\"CustomizeFeatureY\\": \\"自定义属性Y\\",\\n \\"CustomizeFeatureZ\\": \\"自定义属性Z\\",\\n \\"CustomizeFeatureJ\\": \\"酸酸甜甜,肉厚饱满\\",\\n \\"GmtCreate\\": \\"2020-03-09T00:00:00Z\\",\\n \\"CustomizeFeatureM\\": \\"自定义属性M\\",\\n \\"BePromotion\\": false,\\n \\"SkuId\\": \\"123456\\",\\n \\"BeSourceCode\\": false,\\n \\"ForestSecondId\\": \\"白酒\\",\\n \\"ItemQrCode\\": \\"http://m.taobao.com/xxx.html\\",\\n \\"ItemInfoIndex\\": 1,\\n \\"PromotionEnd\\": \\"2020-02-11T00:00:00Z\\",\\n \\"ItemBarCode\\": \\"01838\\",\\n \\"BeClearance\\": true\\n }\\n ]\\n}","type":"json"}]',
'title' => 'QueryItems',
'summary' => 'Queries item information.',
'changeSet' => [
['createdAt' => '2022-07-18T13:13:48.000Z', 'description' => 'Response parameters changed'],
],
],
'DescribeStoreByTemplateVersion' => [
'summary' => 'Query outlets to which the template is applied ',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => ['description' => 'Outlet Template Version number. ', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'Fault message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the Request succeeded. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'Error code. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'HTTP status code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'Response message. If the request succeeded, the value is "success". ', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the **ErrMessage** error message in the response parameters. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code associated with this request. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'Stores' => [
'description' => 'List of outlet information. ',
'type' => 'array',
'items' => [
'description' => 'List of outlet information. ',
'type' => 'object',
'properties' => [
'StoreName' => ['description' => 'Outlet Name. ', 'type' => 'string', 'example' => '天猫旗舰店', 'title' => ''],
'StoreId' => ['description' => 'Outlet ID. ', 'type' => 'string', 'example' => 's-nxwd8sutd6', 'title' => ''],
'ParentId' => ['description' => 'Parent outlet ID. ', 'type' => 'string', 'example' => 'rm-2zeb2rt850x880j1n', 'title' => ''],
'UserStoreCode' => ['description' => 'User outlet code ', 'type' => 'string', 'example' => 's-2zeb2r1t12sq', 'title' => ''],
'GmtModified' => ['description' => 'Updated At', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
'Phone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Level' => ['description' => 'Level. ', 'type' => 'string', 'example' => '1级', 'title' => ''],
'TemplateVersion' => ['description' => 'Outlet Template Version number. ', 'type' => 'string', 'example' => '1.1.0', 'title' => ''],
'TimeZone' => ['description' => 'Time Zone. ', 'type' => 'string', 'example' => 'GMT+08:00', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Stores\\": [\\n {\\n \\"StoreName\\": \\"天猫旗舰店\\",\\n \\"StoreId\\": \\"s-nxwd8sutd6\\",\\n \\"ParentId\\": \\"rm-2zeb2rt850x880j1n\\",\\n \\"UserStoreCode\\": \\"s-2zeb2r1t12sq\\",\\n \\"GmtModified\\": \\"2020-03-06T02:58:16Z\\",\\n \\"Phone\\": \\"\\",\\n \\"Level\\": \\"1级\\",\\n \\"TemplateVersion\\": \\"1.1.0\\",\\n \\"TimeZone\\": \\"GMT+08:00\\"\\n }\\n ]\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
],
'DescribeStoreConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'StoreConfigInfo' => [
'description' => 'The store configuration information.',
'type' => 'object',
'properties' => [
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx****', 'title' => ''],
'EnableNotification' => ['description' => 'Indicates whether DingTalk exception notification is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NotificationWebHook' => ['description' => 'The webhook URL for DingTalk messages.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?.', 'title' => ''],
'NotificationSilentTimes' => ['description' => 'The cool-down periods configured by the user during which no notification messages are sent. The value is a JSON array. The unit is minutes. Each JSON object represents a cool-down period. The values are specified in minutes within a day in UTC time. The from field specifies the start minute of the cool-down period, and the to field specifies the end minute.', 'type' => 'string', 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]', 'title' => ''],
'SubscribeContents' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Category' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Enable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'Threshold' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'AtAll' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'AtMobileList' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"StoreConfigInfo\\": {\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"EnableNotification\\": true,\\n \\"NotificationWebHook\\": \\"https://oapi.dingtalk.com/robot/send?.\\",\\n \\"NotificationSilentTimes\\": \\"[{\\\\\\"from\\\\\\":960,\\\\\\"to\\\\\\":1320},{\\\\\\"from\\\\\\":1170,\\\\\\"to\\\\\\":1230}]\\",\\n \\"SubscribeContents\\": [\\n {\\n \\"Category\\": \\"\\",\\n \\"Enable\\": false,\\n \\"Threshold\\": \\"\\",\\n \\"AtAll\\": false,\\n \\"AtMobileList\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeStoreConfig',
'summary' => 'Queries the configuration information of a store.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DescribeStores' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'UserStoreCode',
'in' => 'formData',
'schema' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'StoreName',
'in' => 'formData',
'schema' => ['description' => 'The store name.', 'type' => 'string', 'required' => false, 'example' => '天猫超市', 'title' => ''],
],
[
'name' => 'ToDate',
'in' => 'formData',
'schema' => ['description' => 'The end time of the store creation time range.', 'type' => 'string', 'required' => false, 'example' => '2020-03-08T02:58:16Z', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID.', 'type' => 'string', 'required' => false, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'FromDate',
'in' => 'formData',
'schema' => ['description' => 'The start time of the store creation time range.', 'type' => 'string', 'required' => false, 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => ['description' => 'The version number of the template configured for the store.', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'Stores' => [
'description' => 'The list of store information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx**** ', 'title' => ''],
'ParentId' => ['description' => 'The parent store ID.', 'type' => 'string', 'example' => 's-aasx****', 'title' => ''],
'TimeZone' => ['description' => 'The time zone configured for the store.', 'type' => 'string', 'example' => 'GMT+08:00', 'title' => ''],
'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
'StoreName' => ['description' => 'The store name.', 'type' => 'string', 'example' => '天猫旗舰店', 'title' => ''],
'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
'TemplateVersion' => ['description' => 'The version number of the store template.', 'type' => 'string', 'example' => '1.1.0', 'title' => ''],
'Level' => ['description' => 'The level.', 'type' => 'string', 'example' => '1级', 'title' => ''],
'Phone' => ['description' => 'The supervision phone number of the local administration for industry and commerce where the store is located.', 'type' => 'string', 'example' => '0571-5666888', 'title' => ''],
'UserStoreCode' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'example' => '20200201', 'title' => ''],
'BarCodeEncode' => ['description' => 'The barcode encoding method. Valid values:'."\n"
.'- 0: Code128.'."\n"
.'- 1: EAN13.'."\n"
."\n"
.'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'default' => '0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Stores\\": [\\n {\\n \\"StoreId\\": \\"s-dxsxx**** \\",\\n \\"ParentId\\": \\"s-aasx****\\",\\n \\"TimeZone\\": \\"GMT+08:00\\",\\n \\"GmtCreate\\": \\"2020-03-06T02:58:16Z\\",\\n \\"StoreName\\": \\"天猫旗舰店\\",\\n \\"GmtModified\\": \\"2020-03-06T02:58:16Z\\",\\n \\"TemplateVersion\\": \\"1.1.0\\",\\n \\"Level\\": \\"1级\\",\\n \\"Phone\\": \\"0571-5666888\\",\\n \\"UserStoreCode\\": \\"20200201\\",\\n \\"BarCodeEncode\\": 0\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query stores',
'summary' => 'Queries the basic information about stores.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DescribeTemplateByModel' => [
'summary' => 'Template query.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'EslSize',
'in' => 'formData',
'schema' => ['description' => 'ESL size', 'type' => 'string', 'required' => false, 'example' => '200X200', 'title' => ''],
],
[
'name' => 'DeviceType',
'in' => 'formData',
'schema' => ['description' => 'Device type ', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => ['description' => 'Outlet template version number;', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'Pagination Parameters: current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'Pagination Parameters: number of entries displayed per page. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B9E230F7-8BC6-5E4B-B540-14142DD94E3B', 'title' => ''],
'ErrorMessage' => ['description' => 'Error message returned when the invocation failed. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current Product was inserted successfully. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'Error code. The value is described as follows: If the request succeeded, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For more information, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'Backend error code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'null', 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic message. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'TotalCount' => ['description' => 'Total number of templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'PageSize' => ['description' => 'Pagination parameter: number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'Pagination parameter: current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Items' => [
'description' => 'List of product information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BasePicture' => ['description' => 'Image.', 'type' => 'string', 'title' => '', 'example' => ''],
'TemplateId' => ['description' => 'Template ID ', 'type' => 'string', 'example' => '772629024140898304', 'title' => ''],
'TemplateName' => ['description' => 'Template Name.', 'type' => 'string', 'example' => '常规', 'title' => ''],
'EslSize' => ['description' => 'ESL size.', 'type' => 'string', 'example' => '250X122', 'title' => ''],
'EslType' => ['description' => 'Price tag type. The return values correspond as follows: - [unk]esl_type_e_ink[unk]: electron ink screen - [unk]px_type_dm_lcd[unk]: segment screen - [unk]x-ddl_type_full_color[unk]: color screen. ', 'type' => 'string', 'title' => '', 'example' => ''],
'Width' => ['description' => 'Width. Unit: px. ', 'type' => 'integer', 'format' => 'int64', 'example' => '400', 'title' => ''],
'Height' => ['description' => 'Video height.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'TemplateVersion' => ['description' => 'Outlet template version number.', 'type' => 'string', 'example' => '15.15.15', 'title' => ''],
'Layout' => ['description' => 'Layout information.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Scene' => ['description' => 'Scenario. Select an appropriate scenario. ', 'type' => 'string', 'example' => 'MEMBER', 'title' => ''],
'Brand' => ['description' => 'Brand.', 'type' => 'string', 'example' => 'ZTE', 'title' => ''],
'TemplateSceneId' => ['description' => 'Displays the matching Custom Template ID. ', 'type' => 'string', 'example' => '大甩卖', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B9E230F7-8BC6-5E4B-B540-14142DD94E3B\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"null\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"BasePicture\\": \\"\\",\\n \\"TemplateId\\": \\"772629024140898304\\",\\n \\"TemplateName\\": \\"常规\\",\\n \\"EslSize\\": \\"250X122\\",\\n \\"EslType\\": \\"\\",\\n \\"Width\\": 400,\\n \\"Height\\": 200,\\n \\"TemplateVersion\\": \\"15.15.15\\",\\n \\"Layout\\": \\"1\\",\\n \\"Scene\\": \\"MEMBER\\",\\n \\"Brand\\": \\"ZTE\\",\\n \\"TemplateSceneId\\": \\"大甩卖\\"\\n }\\n ]\\n}","type":"json"}]',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:37.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Response parameters changed'],
],
'title' => '',
],
'DescribeUserLog' => [
'summary' => 'Queries the operation log records of a user.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ItemShortTitle',
'in' => 'formData',
'schema' => ['description' => 'The short title of the item.', 'type' => 'string', 'required' => false, 'example' => '牛奶', 'title' => ''],
],
[
'name' => 'OperationType',
'in' => 'formData',
'schema' => ['description' => 'The log type. Valid values:'."\n"
."\n"
.'- `OPERATION_TYPE_BIND`: ESL binding.'."\n"
."\n"
.'- `OPERATION_TYPE_UNBIND`: ESL unbinding.'."\n"
."\n"
.'- `OPERATION_TYPE_FORCE_UPDATE`: ESL refresh - manual refresh.'."\n"
."\n"
.'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`: ESL refresh - item update.'."\n"
."\n"
.'- `OPERATION_TYPE_ALL_UPDATE`: ESL refresh - store-level refresh.'."\n"
."\n"
.'- `OPERATION_TYPE_SEND_FAILED_RETRY`: Operation retry - send failed.'."\n"
."\n"
.'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`: Operation retry - display failed.'."\n"
."\n"
.'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`: ESL LED light-up.', 'type' => 'string', 'required' => false, 'example' => 'OPERATION_TYPE_BIND', 'title' => ''],
],
[
'name' => 'EslBarCode',
'in' => 'formData',
'schema' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****', 'title' => ''],
],
[
'name' => 'FromDate',
'in' => 'formData',
'schema' => ['description' => 'The start time for querying operation logs. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2020-03-18T02:26:28Z', 'title' => ''],
],
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The barcode of the item.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ToDate',
'in' => 'formData',
'schema' => ['description' => 'The end time for querying operation logs. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2020-03-17T02:26:28Z', 'title' => ''],
],
[
'name' => 'LogId',
'in' => 'formData',
'schema' => ['description' => 'The log ID.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'OperationStatus',
'in' => 'formData',
'schema' => ['description' => 'The log status. Valid values:'."\n"
."\n"
.'- `OPERATION_STATUS_NEW`: new.'."\n"
."\n"
.'- `OPERATION_STATUS_SENT`: sent.'."\n"
."\n"
.'- `OPERATION_STATUS_DISPLAY`: displayed.'."\n"
."\n"
.'- `OPERATION_STATUS_DELETE`: deleted.'."\n"
."\n"
.'- `OPERATION_STATUS_BREAK`: interrupted.'."\n"
."\n"
.'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`: retrying.'."\n"
."\n"
.'- `OPERATION_STATUS_SEND_FAILED`: send failed.'."\n"
."\n"
.'- `OPERATION_STATUS_DISPLAY_FAILED`: display failed.', 'type' => 'string', 'required' => false, 'example' => 'OPERATION_STATUS_NEW', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '134****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'UserLogs' => [
'description' => 'The list of log entries.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EslBarCode' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
'OperationSendTime' => ['description' => 'The time when the operation was sent.', 'type' => 'string', 'example' => '2020-03-17T02:25:17Z', 'title' => ''],
'ActionPrice' => ['description' => 'The actual selling price, in cents.', 'type' => 'string', 'example' => '500', 'title' => ''],
'UserId' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'example' => '134****', 'title' => ''],
'PriceUnit' => ['description' => 'The pricing unit.', 'type' => 'string', 'example' => '台', 'title' => ''],
'ResultCode' => ['description' => 'The execution result code.', 'type' => 'string', 'example' => '2002', 'title' => ''],
'ItemId' => ['description' => 'The custom item barcode.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z', 'title' => ''],
'OperationType' => ['description' => 'The log type. Valid values:'."\n"
."\n"
.'- `OPERATION_TYPE_BIND`: ESL binding.'."\n"
."\n"
.'- `OPERATION_TYPE_UNBIND`: ESL unbinding.'."\n"
."\n"
.'- `OPERATION_TYPE_FORCE_UPDATE`: ESL refresh - manual refresh.'."\n"
."\n"
.'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`: ESL refresh - item update.'."\n"
."\n"
.'- `OPERATION_TYPE_ALL_UPDATE`: ESL refresh - store-level refresh.'."\n"
."\n"
.'- `OPERATION_TYPE_SEND_FAILED_RETRY`: Operation retry - send failed.'."\n"
."\n"
.'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`: Operation retry - display failed.'."\n"
."\n"
.'- `OPERATION_TYPE_TIMEOUT_RETRY`: Operation retry - operation timeout.'."\n"
."\n"
.'- `OPERATION_TYPE_ESL_NOT_FOUND_RETRY`: Operation retry - unknown device.'."\n"
."\n"
.'- `OPERATION_TYPE_TEMPLATE_NOT_FOUND_RETRY`: Operation retry - unknown template.'."\n"
."\n"
.'- `OPERATION_TYPE_DRAW_PICTURE_FAILED_RETRY`: Operation retry - abnormal template.'."\n"
."\n"
.'- `OPERATION_TYPE_BATCH_TIMES_DIRECTIONAL_REFRESH`: ESL refresh - item import.'."\n"
."\n"
.'- `OPERATION_TYPE_ON_LINE_RETRY`: ESL refresh - online retry.'."\n"
."\n"
.'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`: LED light-up.', 'type' => 'string', 'example' => 'OPERATION_TYPE_BIND', 'title' => ''],
'OperationResponseTime' => ['description' => 'The operation response time.', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z', 'title' => ''],
'OperationStatus' => ['description' => 'The log status. Valid values:'."\n"
."\n"
.'- `OPERATION_STATUS_NEW`: new operation.'."\n"
."\n"
.'- `OPERATION_STATUS_SENT`: send operation.'."\n"
."\n"
.'- `OPERATION_STATUS_DISPLAY`: completed operation.'."\n"
."\n"
.'- `OPERATION_STATUS_DELETE`: delete operation.'."\n"
."\n"
.'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`: retry operation.'."\n"
."\n"
.'- `OPERATION_STATUS_SEND_FAILED`: send failed.'."\n"
."\n"
.'- `OPERATION_STATUS_DISPLAY_FAILED`: refresh failed.', 'type' => 'string', 'example' => 'OPERATION_STATUS_NEW', 'title' => ''],
'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxxx****', 'title' => ''],
'ItemShortTitle' => ['description' => 'The short title of the item.', 'type' => 'string', 'example' => '牛奶', 'title' => ''],
'LogId' => ['description' => 'The log ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
'BePromotion' => ['description' => 'Indicates whether the item is on promotion.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z', 'title' => ''],
'EslSignal' => ['description' => 'The signal strength of the ESL.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
'SpendTime' => ['description' => 'The time consumed, in milliseconds.', 'type' => 'string', 'example' => '10', 'title' => ''],
'ItemBarCode' => ['description' => 'The barcode of the item.', 'type' => 'string', 'example' => '690560583****', 'title' => ''],
'I18nResultKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"UserLogs\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"OperationSendTime\\": \\"2020-03-17T02:25:17Z\\",\\n \\"ActionPrice\\": \\"500\\",\\n \\"UserId\\": \\"134****\\",\\n \\"PriceUnit\\": \\"台\\",\\n \\"ResultCode\\": \\"2002\\",\\n \\"ItemId\\": \\"123456\\",\\n \\"GmtModified\\": \\"2020-03-17T02:26:17Z\\",\\n \\"OperationType\\": \\"OPERATION_TYPE_BIND\\",\\n \\"OperationResponseTime\\": \\"2020-03-17T02:26:17Z\\",\\n \\"OperationStatus\\": \\"OPERATION_STATUS_NEW\\",\\n \\"StoreId\\": \\"s-dxsxxx****\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"LogId\\": \\"123456\\",\\n \\"BePromotion\\": false,\\n \\"GmtCreate\\": \\"2020-03-17T02:26:17Z\\",\\n \\"EslSignal\\": 50,\\n \\"SpendTime\\": \\"10\\",\\n \\"ItemBarCode\\": \\"690560583****\\",\\n \\"I18nResultKey\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query operation logs',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DescribeUsers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'UserType',
'in' => 'formData',
'schema' => ['description' => 'The user type. Valid values:'."\n"
."\n"
.'- `USER_TYPE_COMPANY_OWNER`: company owner account'."\n"
."\n"
.'- `USER_TYPE_COMPANY_ROOT`: senior company administrator'."\n"
."\n"
.'- `USER_TYPE_COMPANY_ADMIN`: company administrator'."\n"
."\n"
.'- `USER_TYPE_STORE_ADMIN`: store administrator'."\n"
."\n"
.'- `USER_TYPE_STORE_OPERATOR`: store operator'."\n"
."\n"
.'- `USER_TYPE_GUEST`: guest without any permissions.', 'type' => 'string', 'required' => false, 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => false, 'example' => '1344***', 'title' => ''],
],
[
'name' => 'UserName',
'in' => 'formData',
'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'Users' => [
'description' => 'The list of user information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UserType' => ['description' => 'The user type. Valid values:'."\n"
."\n"
.'- `USER_TYPE_COMPANY_OWNER`: company owner account'."\n"
."\n"
.'- `USER_TYPE_COMPANY_ROOT`: senior company administrator'."\n"
."\n"
.'- `USER_TYPE_COMPANY_ADMIN`: company administrator'."\n"
."\n"
.'- `USER_TYPE_STORE_ADMIN`: store administrator'."\n"
."\n"
.'- `USER_TYPE_STORE_OPERATOR`: store operator'."\n"
."\n"
.'- `USER_TYPE_GUEST`: guest without any permissions.', 'type' => 'string', 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
'UserId' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'example' => '1344***', 'title' => ''],
'Stores' => ['description' => 'The list of store IDs.', 'type' => 'string', 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', 'title' => ''],
'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Bid' => ['description' => 'The account type. 26842: Alibaba Cloud.', 'type' => 'string', 'example' => '26842', 'title' => ''],
'OwnerId' => ['description' => 'The Alibaba Cloud account.', 'type' => 'string', 'example' => '1212124434535', 'title' => ''],
'DingTalkInfos' => [
'description' => 'The DingTalk account information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DingTalkCompanyId' => ['description' => 'The DingTalk company ID.', 'type' => 'string', 'example' => '13124', 'title' => ''],
'DingTalkUserId' => ['description' => 'The DingTalk user ID.', 'type' => 'string', 'example' => '3455566', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Users\\": [\\n {\\n \\"UserType\\": \\"USER_TYPE_COMPANY_OWNER\\",\\n \\"UserId\\": \\"1344***\\",\\n \\"Stores\\": \\"[s-dxsxxxxxx,s-dxsyyyyyyy]\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Bid\\": \\"26842\\",\\n \\"OwnerId\\": \\"1212124434535\\",\\n \\"DingTalkInfos\\": [\\n {\\n \\"DingTalkCompanyId\\": \\"13124\\",\\n \\"DingTalkUserId\\": \\"3455566\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query users',
'summary' => 'Queries user information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:37.000Z', 'description' => 'Error codes changed'],
],
],
'GetUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The UID of the Alibaba Cloud RAM user.', 'type' => 'string', 'required' => false, 'example' => '1344***', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'User' => [
'description' => 'The user information.',
'type' => 'object',
'properties' => [
'UserType' => ['description' => 'The user type. Valid values:'."\n"
."\n"
.'USER_TYPE_COMPANY_OWNER: the primary account of the merchant.'."\n"
.'USER_TYPE_COMPANY_ROOT: a senior merchant administrator.'."\n"
.'USER_TYPE_COMPANY_ADMIN: a merchant administrator.'."\n"
.'USER_TYPE_STORE_ADMIN: a store administrator.'."\n"
.'USER_TYPE_STORE_OPERATOR: a store operator.'."\n"
.'USER_TYPE_GUEST: a guest without any permissions.', 'type' => 'string', 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
'UserId' => ['description' => 'The UID of the Alibaba Cloud RAM user.', 'type' => 'string', 'example' => '1344***', 'title' => ''],
'Stores' => ['description' => 'The list of store IDs.', 'type' => 'string', 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', 'title' => ''],
'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Bid' => ['description' => 'The account type.'."\n"
."\n"
.'26842: Alibaba Cloud.', 'type' => 'string', 'example' => '26842', 'title' => ''],
'OwnerId' => ['description' => 'The UID of the Alibaba Cloud primary account.', 'type' => 'string', 'example' => '12143124132', 'title' => ''],
'DingTalkInfos' => [
'description' => 'The DingTalk account information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DingTalkCompanyId' => ['description' => 'The DingTalk merchant ID.', 'type' => 'string', 'example' => '131242', 'title' => ''],
'DingTalkUserId' => ['description' => 'The DingTalk user ID.', 'type' => 'string', 'example' => '34352525', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"User\\": {\\n \\"UserType\\": \\"USER_TYPE_COMPANY_OWNER\\",\\n \\"UserId\\": \\"1344***\\",\\n \\"Stores\\": \\"[s-dxsxxxxxx,s-dxsyyyyyyy]\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Bid\\": \\"26842\\",\\n \\"OwnerId\\": \\"12143124132\\",\\n \\"DingTalkInfos\\": [\\n {\\n \\"DingTalkCompanyId\\": \\"131242\\",\\n \\"DingTalkUserId\\": \\"34352525\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'Query a Single User',
'summary' => 'Queries the information about a single user.',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:36.000Z', 'description' => 'Error codes changed'],
],
],
'QueryTemplateListByGroupId' => [
'summary' => 'Query templates by group ID ',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'GroupId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'ErrorCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DynamicMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DynamicCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'TemplateList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BasePicture' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'TemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'TemplateName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EslSize' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EslType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Width' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'Height' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
'TemplateVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Layout' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Scene' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Brand' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'TemplateSceneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Relation' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'changeSet' => [
['createdAt' => '2024-04-26T06:18:35.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-18T13:15:18.000Z', 'description' => 'OpenAPI offline'],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"Success\\": false,\\n \\"ErrorCode\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"DynamicMessage\\": \\"\\",\\n \\"DynamicCode\\": \\"\\",\\n \\"TotalCount\\": 0,\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0,\\n \\"TemplateList\\": [\\n {\\n \\"BasePicture\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"TemplateName\\": \\"\\",\\n \\"EslSize\\": \\"\\",\\n \\"EslType\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"TemplateVersion\\": \\"\\",\\n \\"Layout\\": \\"\\",\\n \\"Scene\\": \\"\\",\\n \\"Brand\\": \\"\\",\\n \\"GroupId\\": \\"\\",\\n \\"TemplateSceneId\\": \\"\\",\\n \\"Relation\\": false\\n }\\n ]\\n}","type":"json"}]',
'title' => '',
],
'SyncAddMaterial' => [
'summary' => 'Asynchronously add media material ',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'Material Name', 'type' => 'string', 'required' => true, 'example' => 'xx图片', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => 'Material Link', 'type' => 'string', 'required' => true, 'example' => 'https://iotx-alg-picture-auto.oss-cn-shanghai.aliyuncs.com/0622/zxytest/12.jpg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SyncAddEslMaterialResponse',
'description' => 'SyncAddEslMaterialResponse',
'type' => 'object',
'properties' => [
'Result' => [
'description' => 'Return Result ',
'type' => 'object',
'properties' => [
'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true'],
'Message' => ['title' => '', 'description' => 'Basic information ', 'type' => 'string', 'example' => 'success'],
'DynamicMessage' => ['title' => '', 'description' => 'POP dynamic supplementary information ', 'type' => 'string', 'example' => 'The specified store %s does not exist.'],
'DynamicCode' => ['title' => '', 'description' => 'POP dynamic supplementary information ', 'type' => 'string', 'example' => ''],
'ErrorCode' => ['title' => '', 'description' => 'Error Type. See the ErrorCodes enumeration.', 'type' => 'string', 'example' => 'MandatoryParameters'],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'Request ID '."\n", 'type' => 'string', 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764'."\n", 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation succeeded. '."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The error message returned when the invocation fails. '."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'ErrorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message returned when the invocation fails. '."\n", 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Code' => ['description' => 'HTTP status code. ', 'type' => 'string', 'example' => '200', 'title' => ''],
'DynamicCode' => ['description' => 'Dynamic code ', 'type' => 'string', 'example' => 'PlatformResponseError.%s'."\n", 'title' => ''],
'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the ErrMessage parameter returned in the response. '."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\"\\n },\\n \\"RequestId\\": \\"450E6CA4-5C5D-5DED-86C2-2B577C291764\\\\n\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Code\\": \\"200\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\\\n\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\"\\n}","type":"json"}]',
'changeSet' => [],
'title' => '',
],
'UnassignUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'UnassignUser',
'summary' => 'Revokes permissions from a user.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:34.000Z', 'description' => 'Error codes changed'],
],
],
'UnbindEslDevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'EslBarCode',
'in' => 'formData',
'schema' => ['description' => 'The ESL bar code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18bc5a63****', 'title' => ''],
],
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The item bar code.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
[
'name' => 'Column',
'in' => 'formData',
'schema' => ['description' => 'The logical column in the display system.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'Shelf',
'in' => 'formData',
'schema' => ['description' => 'The shelf number in the display system.', 'type' => 'string', 'required' => false, 'example' => '20200201', 'title' => ''],
],
[
'name' => 'Layer',
'in' => 'formData',
'schema' => ['description' => 'The layer number in the display system.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'ContainerName',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Unbind an ESL device',
'summary' => 'Unbinds an electronic shelf label (ESL) device.',
'description' => 'This operation supports two modes: display mode and standard mode. In display mode, the ESL is unbound by using the display shelf position and ESL bar code. In standard mode, the ESL is unbound by using the item bar code and ESL bar code.',
'requestParamsDescription' => 'In standard mode, StoreId and EslBarCode are required. In display mode, StoreId, EslBarCode, Shelf, Layer, and Column are required. The EslBarCode specified in the request must exist at the current shelf position. If ItemBarCode is specified, it must match the information stored for the display shelf position.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
],
'UpdateEslDeviceLight' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'LedColor',
'in' => 'formData',
'schema' => ['description' => 'The LED color. Valid values:'."\n"
."\n"
.'- `GREEN`: green'."\n"
."\n"
.'- `RED`: red'."\n"
."\n"
.'- `BLUE`: blue'."\n"
."\n"
.'- `OFF`: off.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GREEN', 'title' => ''],
],
[
'name' => 'Frequency',
'in' => 'formData',
'schema' => ['description' => 'The LED blinking frequency. Valid values:'."\n"
."\n"
.'- `ALWAYS`: always on'."\n"
."\n"
.'- `HEIGHT`: high frequency'."\n"
."\n"
.'- `MIDDLE`: medium frequency'."\n"
."\n"
.'- `NORMAL`: normal frequency.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NORMAL', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or merchant-defined custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ItemBarCode',
'in' => 'formData',
'schema' => ['description' => 'The item bar code.', 'type' => 'string', 'required' => false, 'example' => '6905605836648', 'title' => ''],
],
[
'name' => 'LightUpTime',
'in' => 'formData',
'schema' => ['description' => 'The duration for which the LED stays on. Unit: seconds. The value must be greater than 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '30', 'title' => ''],
],
[
'name' => 'EslBarCode',
'in' => 'formData',
'schema' => ['description' => 'The ESL bar code.', 'type' => 'string', 'required' => false, 'example' => '18bc5a631ak9', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'FailCount' => ['description' => 'The number of failures.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'SuccessCount' => ['description' => 'The number of successes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
'LightFailEslInfos' => [
'description' => 'The list of ESLs that failed to light up.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EslBarCode' => ['description' => 'The ESL bar code.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified ESL device does not exist.', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"FailCount\\": 0,\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"SuccessCount\\": 1,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"LightFailEslInfos\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"ErrorMessage\\": \\"The specified ESL device does not exist.\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Control the LED light of an ESL',
'summary' => 'Controls the LED light of an electronic shelf label (ESL) to change its frequency and color.',
'requestParamsDescription' => ' Specify either ItemBarCode or EslBarCode. If both are specified, EslBarCode takes priority.'."\n"
.'If only EslBarCode is specified, a single ESL is lit up.'."\n"
.'If only ItemBarCode is specified, all ESLs bound to the item bar code are lit up.',
'responseParamsDescription' => ' When EslBarCode is used to light up an ESL, the response indicates success or failure.'."\n"
.'When ItemBarCode is used to light up ESLs, the response returns the number of successes and failures, along with information about the ESLs that failed.',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-04-26T06:18:34.000Z', 'description' => 'Error codes changed'],
],
],
'UpdateStore' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'UserStoreCode',
'in' => 'formData',
'schema' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
'name' => 'StoreName',
'in' => 'formData',
'schema' => ['description' => 'The store name.', 'type' => 'string', 'required' => false, 'example' => '天猫超市', 'title' => ''],
],
[
'name' => 'Phone',
'in' => 'formData',
'schema' => ['description' => 'The supervision phone number of the local administration for industry and commerce where the store is located.', 'type' => 'string', 'required' => false, 'example' => '0571-5666888', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => ['description' => 'The store template version.', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
[
'name' => 'Timezone',
'in' => 'formData',
'schema' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'GMT+08:00', 'title' => ''],
],
[
'name' => 'BarCodeEncode',
'in' => 'formData',
'schema' => ['description' => 'The barcode encoding method. Valid values:'."\n"
."\n"
.'- 0: Code128.'."\n"
.'- 1: EAN13.'."\n"
."\n"
.'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'The request status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Modify store information',
'summary' => 'Modifies the basic information of a store.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'UpdateStoreConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NotificationSilentTimes',
'in' => 'formData',
'schema' => ['description' => 'The silent periods configured by the user during which notification messages are not sent. The value is a JSON list in minutes. Each JSON object represents a silent period time range, where the values are the minute offsets within a day in UTC time. The "from" field specifies the start minute of the silent period, and the "to" field specifies the end minute.', 'type' => 'string', 'required' => false, 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]', 'title' => ''],
],
[
'name' => 'EnableNotification',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to enable DingTalk exception message notifications. Set to true to enable or false to disable.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
'schema' => ['description' => 'The store ID or a custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-sds1233****', 'title' => ''],
],
[
'name' => 'NotificationWebHook',
'in' => 'formData',
'schema' => ['description' => 'The webhook URL for DingTalk messages.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?.', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'SubscribeContents',
'in' => 'formData',
'schema' => ['description' => 'The subscription content.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '97B41B7F-A6EC-524C-9B8F-1BDD7E733F5E', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => ['description' => 'The request status indicator.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97B41B7F-A6EC-524C-9B8F-1BDD7E733F5E\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
'title' => 'Modify Store Configuration',
'summary' => 'Modifies the configuration information of a store.',
'changeSet' => [],
],
],
'endpoints' => [
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => 'cloudesl-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => 'cloudesl-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.cn-hangzhou.aliyuncs.com', 'endpoint' => 'cloudesl.cn-hangzhou.aliyuncs.com', 'vpc' => 'cloudesl-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'ActionPermissionError', 'message' => 'You are not authorized to perform the action %s.', 'http_code' => 401, 'description' => 'You are not authorized to perform the action %s.'],
['code' => 'ActionPermissionErrorPub', 'message' => 'You are not authorized to perform the action %s.', 'http_code' => 411, 'description' => 'You are not authorized to perform the action %s.'],
['code' => 'AlarmError', 'message' => 'An error occurred while processing the specified alert.', 'http_code' => 510, 'description' => 'An error occurred while processing the specified alert.'],
['code' => 'ApDeviceActivateErrorPub', 'message' => 'Failed to activate the AP device.', 'http_code' => 418, 'description' => 'Failed to activate the AP device.'],
['code' => 'ApDeviceActivateErrorPub', 'message' => 'Failed to active the AP device.', 'http_code' => 418, 'description' => 'Failed to activate the AP device.'],
['code' => 'ApDeviceAlreadyExistPub', 'message' => 'The specified AP device already exists.', 'http_code' => 418, 'description' => 'The specified AP device already exists.'],
['code' => 'ApDeviceInStorePub', 'message' => 'The store contains an AP device.', 'http_code' => 418, 'description' => 'The store contains an AP device.'],
['code' => 'ApDeviceOtherStorePub', 'message' => 'The specified AP device is being used by another store.', 'http_code' => 418, 'description' => 'The specified AP device is being used by another store.'],
['code' => 'ApDeviceRegisterErrorPub', 'message' => 'Failed to register the AP device.', 'http_code' => 418, 'description' => 'Failed to register the AP device.'],
['code' => 'ApNumberLimitPub', 'message' => 'The number of AP devices under the store exceeds the limit.', 'http_code' => 418, 'description' => 'The number of AP devices under the store exceeds the limit.'],
['code' => 'BetaTestLabelError', 'message' => 'You are not authorized to use the public beta version.', 'http_code' => 405, 'description' => 'You are not authorized to use the public beta version.'],
['code' => 'BetaTestLabelErrorPub', 'message' => 'You are not authorized to use the public preview version.', 'http_code' => 418, 'description' => 'You are not authorized to use the public beta version.'],
['code' => 'BeyondBatchLimit', 'message' => 'The maximum number of items that you can insert is exceeded.', 'http_code' => 405, 'description' => 'The maximum number of items that you can insert is exceeded.'],
['code' => 'BeyondBatchLimitPub', 'message' => 'The maximum number of items that you can insert is exceeded.', 'http_code' => 418, 'description' => 'The maximum number of items that you can insert is exceeded.'],
['code' => 'CompanyAlreadyExist', 'message' => 'The specified company already exists.', 'http_code' => 405, 'description' => 'The specified company already exists.'],
['code' => 'CompanyAlreadyExistPub', 'message' => 'The specified company already exists.', 'http_code' => 418, 'description' => 'The specified company already exists.'],
['code' => 'CompanyDataNotMigratePub', 'message' => 'The specified company data is not migrated.', 'http_code' => 418, 'description' => 'The specified company data is not migrated.'],
['code' => 'CompanyError', 'message' => 'An error occurred while processing your request related to companies.', 'http_code' => 506, 'description' => 'An error occurred while processing your request related to companies.'],
['code' => 'CompanyOwnerError', 'message' => 'Failed to configure the specified company.', 'http_code' => 405, 'description' => 'Failed to configure the specified company.'],
['code' => 'CompanyOwnerErrorPub', 'message' => 'Failed to configure the specified company.', 'http_code' => 418, 'description' => 'Failed to configure the specified company.'],
['code' => 'CompanyTemplatePermissionErrorPub', 'message' => 'You are not authorized to operate on the specified company template %s.', 'http_code' => 411, 'description' => 'You do not have permissions to perform operations on the enterprise template.'],
['code' => 'ContainerLayoutBindEslDevicePub', 'message' => 'The Layout of the Container has been bound to an ESL device.', 'http_code' => 418, 'description' => ''],
['code' => 'ContainerTemplateNoMatchPub', 'message' => 'The Template of the Container has not match at all.', 'http_code' => 418, 'description' => 'The Template of the Container has not match at all.'],
['code' => 'CreateCompanyError', 'message' => 'Failed to create a company.', 'http_code' => 405, 'description' => 'Failed to create a company.'],
['code' => 'CreateCompanyErrorPub', 'message' => 'Failed to create a company.', 'http_code' => 418, 'description' => 'Failed to create a company.'],
['code' => 'DeviceError', 'message' => 'An error occurred while processing your request related to devices.', 'http_code' => 508, 'description' => 'An error occurred while processing your request related to devices.'],
['code' => 'DingTalkAlreadyExistPub', 'message' => 'The specified DingTalk information already exists.', 'http_code' => 418, 'description' => 'The specified DingTalk information already exists.'],
['code' => 'DuplicateContainerNameErrorPub', 'message' => 'The ContainerName is duplicated.', 'http_code' => 418, 'description' => ''],
['code' => 'DuplicateTemplateGroupNameErrorPub', 'message' => 'The TemplateGroupName is duplicated.', 'http_code' => 418, 'description' => ''],
['code' => 'DuplicateTemplateSceneIdErrorPub', 'message' => 'The TemplateSceneId is duplicated.', 'http_code' => 418, 'description' => ''],
['code' => 'ErrorParameter', 'message' => 'The parameter %s is invalid.', 'http_code' => 403, 'description' => 'The parameter %s is invalid.'],
['code' => 'ErrorParameterPub', 'message' => 'The parameter %s is invalid.', 'http_code' => 413, 'description' => 'The parameter %s is invalid.'],
['code' => 'EslDeviceInPlanogramPositionPub', 'message' => 'The ESL device is used in planogram position.', 'http_code' => 418, 'description' => 'The ESL device is used in planogram position.'],
['code' => 'EslDeviceInStore', 'message' => 'The store contains an ESL device.', 'http_code' => 405, 'description' => 'The store contains an ESL device.'],
['code' => 'EslDeviceInStorePub', 'message' => 'The store contains an ESL device.', 'http_code' => 418, 'description' => 'The store contains an ESL device.'],
['code' => 'EslDeviceNotMatchEslPositionPub', 'message' => 'The specified ESL device does not match the ESL position.', 'http_code' => 418, 'description' => 'The specified ESL device does not match the ESL position.'],
['code' => 'EslDeviceOtherStore', 'message' => 'The specified ESL device is being used by another store', 'http_code' => 405, 'description' => 'The specified ESL device is being used by another store.'],
['code' => 'EslDeviceOtherStorePub', 'message' => 'The specified ESL device is being used by another store', 'http_code' => 418, 'description' => 'The specified ESL device is being used by another store.'],
['code' => 'FailInsertItemPub', 'message' => 'Failed to insert the same item.', 'http_code' => 412, 'description' => 'Failed to insert the same item.'],
['code' => 'InternalError', 'message' => 'An error occurred while processing API operations of Cloud ESL.', 'http_code' => 500, 'description' => 'An error occurred while processing API operations of Cloud ESL.'],
['code' => 'InvalidActionPermissionPub', 'message' => 'The specified action permission is invalid.', 'http_code' => 412, 'description' => 'The specified action permission is invalid.'],
['code' => 'InvalidCompanyTemplatePub', 'message' => 'The company template is invalid.', 'http_code' => 412, 'description' => 'The enterprise template is invalid.'],
['code' => 'InvalidCompanyTemplateScenePub', 'message' => 'The specified company template scenario is invalid.', 'http_code' => 412, 'description' => 'The use scenario of the enterprise template is invalid.'],
['code' => 'InvalidDeviceMac', 'message' => 'The specified device MAC address is invalid.', 'http_code' => 400, 'description' => 'The specified device MAC address is invalid.'],
['code' => 'InvalidDeviceMacPub', 'message' => 'The specified device MAC address is invalid.', 'http_code' => 412, 'description' => 'The specified device MAC address is invalid.'],
['code' => 'InvalidEslBarCode', 'message' => 'The specified ESL bar code is invalid.', 'http_code' => 400, 'description' => 'The specified ESL bar code is invalid.'],
['code' => 'InvalidEslBarCodePub', 'message' => 'The specified ESL bar code is invalid.', 'http_code' => 412, 'description' => 'The specified ESL bar code is invalid.'],
['code' => 'InvalidFileSize', 'message' => 'The specified size of the material is invalid.', 'http_code' => 412, 'description' => 'The specified size of the material is invalid.'],
['code' => 'InvalidHttpSignaturePub', 'message' => 'The HTTP signature is invalid.', 'http_code' => 412, 'description' => 'The HTTP signature is invalid.'],
['code' => 'InvalidItemBarCode', 'message' => 'The specified item bar code is invalid.', 'http_code' => 400, 'description' => 'The specified item bar code is invalid.'],
['code' => 'InvalidItemBarCodePub', 'message' => 'The specified item bar code is invalid.', 'http_code' => 412, 'description' => 'The specified item bar code is invalid.'],
['code' => 'InvalidMaterialId', 'message' => 'The material id is invalid.', 'http_code' => 418, 'description' => ''],
['code' => 'InvalidPageNumber', 'message' => 'The specified starting page number is invalid.', 'http_code' => 400, 'description' => 'The specified starting page number is invalid.'],
['code' => 'InvalidPageNumberPub', 'message' => 'The specified starting page number is invalid.', 'http_code' => 412, 'description' => 'The specified starting page number is invalid.'],
['code' => 'InvalidPageSize', 'message' => 'The specified number of entries to return on each page is invalid.', 'http_code' => 400, 'description' => 'The specified number of entries to return on each page is invalid.'],
['code' => 'InvalidPageSizePub', 'message' => 'The specified number of entries to return on each page is invalid.', 'http_code' => 412, 'description' => 'The specified number of entries to return on each page is invalid.'],
['code' => 'InvalidParameter.DataViolated', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
['code' => 'InvalidParameter.ValidationFailure', 'message' => 'An error occurred while validating parameters.', 'http_code' => 400, 'description' => 'An error occurred while validating parameters.'],
['code' => 'InvalidPlatformType', 'message' => 'The specified system type is invalid.', 'http_code' => 400, 'description' => 'The specified system type is invalid.'],
['code' => 'InvalidPlatformTypePub', 'message' => 'The specified system type is invalid.', 'http_code' => 412, 'description' => 'The specified system type is invalid.'],
['code' => 'InvalidResourceType', 'message' => 'The specified resource type is invalid.', 'http_code' => 400, 'description' => 'The specified resource type is invalid.'],
['code' => 'InvalidResourceTypePub', 'message' => 'The specified resource type is invalid.', 'http_code' => 412, 'description' => 'The specified resource type is invalid.'],
['code' => 'InvalidShelfTypePub', 'message' => 'The specified shelf type is invalid.', 'http_code' => 412, 'description' => 'The specified shelf type is invalid.'],
['code' => 'InvalidUserType', 'message' => 'The specified user type is invalid.', 'http_code' => 400, 'description' => 'The specified user type is invalid.'],
['code' => 'InvalidUserTypePub', 'message' => 'The specified user type is invalid.', 'http_code' => 412, 'description' => 'The specified user type is invalid.'],
['code' => 'ItemAlreadyExistPub', 'message' => 'The item already exists.', 'http_code' => 412, 'description' => 'The item already exists.'],
['code' => 'ItemBindEslDevice', 'message' => 'The item has been bound to an ESL device.', 'http_code' => 405, 'description' => 'The item has been bound to an ESL device.'],
['code' => 'ItemBindEslDevicePub', 'message' => 'The item has been bound to an ESL device.', 'http_code' => 418, 'description' => 'The item has been bound to an ESL device.'],
['code' => 'ItemError', 'message' => 'An error occurred while processing your request related to items.', 'http_code' => 509, 'description' => 'An error occurred while processing your request related to items.'],
['code' => 'ItemInStore', 'message' => 'The store contains an item.', 'http_code' => 405, 'description' => 'The store contains an item.'],
['code' => 'ItemInStorePub', 'message' => 'The store contains an item.', 'http_code' => 418, 'description' => 'The store contains an item.'],
['code' => 'ItemNotMatch', 'message' => 'The specified item does not match the item that has been bound to the specified ESL device.', 'http_code' => 405, 'description' => 'The specified item does not match the item that has been bound to the specified ESL device.'],
['code' => 'ItemNotMatchPlanogramPositionPub', 'message' => 'The specified item does not match the planogram position.', 'http_code' => 418, 'description' => 'The specified item does not match the planogram position.'],
['code' => 'ItemNotMatchPub', 'message' => 'The specified item does not match the item that has been bound to the specified ESL device.', 'http_code' => 418, 'description' => 'The specified item does not match the item that has been bound to the specified ESL device.'],
['code' => 'ItemNumberLimitPub', 'message' => 'The number of products under the store exceeds the limit.', 'http_code' => 418, 'description' => 'The number of products under the store exceeds the limit.'],
['code' => 'ItemNumLimit', 'message' => 'The maximum number of items is %s.', 'http_code' => 410, 'description' => 'The maximum number of items is %s.'],
['code' => 'LayerBindOtherRailPub', 'message' => 'The layer has been bound to another rail.', 'http_code' => 418, 'description' => 'The layer has been bound to another rail.'],
['code' => 'LayoutBindEslDevicePub', 'message' => 'The Layout has been bound to an ESL device.', 'http_code' => 418, 'description' => ''],
['code' => 'LayoutNameContainerNameErrorPub', 'message' => 'The LayoutName is duplicated.', 'http_code' => 418, 'description' => ''],
['code' => 'LayoutOrContainerIsNotExistErrorPub', 'message' => 'Layout or Container is not exist.', 'http_code' => 418, 'description' => ''],
['code' => 'LockError', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => 'A server error occurred while processing your request.'],
['code' => 'LockErrorPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => 'An internal system error occurred.'],
['code' => 'MandatoryParameter', 'message' => 'Missing parameter %s.', 'http_code' => 403, 'description' => 'Missing parameter %s.'],
['code' => 'MandatoryParameterPub', 'message' => 'Missing parameter %s.', 'http_code' => 413, 'description' => 'Missing parameter %s.'],
['code' => 'MaterialContainIllegalContent', 'message' => 'The material contains illegal content.', 'http_code' => 416, 'description' => 'The material contains illegal content.'],
['code' => 'MaterialHasBindToItem', 'message' => 'The material has been bound to the items.', 'http_code' => 418, 'description' => 'The material has been bound to the items.'],
['code' => 'MaterialInfoParserError', 'message' => 'Type of material is invalid.', 'http_code' => 418, 'description' => 'The type of material is invalid.'],
['code' => 'MissingParameter', 'message' => 'You must specify the parameters.', 'http_code' => 400, 'description' => 'You must specify the parameters.'],
['code' => 'MoreThanOneStore', 'message' => 'The specified store operator can only manage one store.', 'http_code' => 405, 'description' => 'The specified store operator can only manage one store.'],
['code' => 'MoreThanOneStorePub', 'message' => 'The specified store operator can only manage one store.', 'http_code' => 418, 'description' => 'The specified store operator can only manage one store.'],
['code' => 'NotAcquireLockPub', 'message' => 'The lock is not acquired.', 'http_code' => 417, 'description' => 'An error occurred while obtaining'],
['code' => 'NotAllowDifferentDeviceTypePub', 'message' => 'The specified Not allow Different device type to copy template.', 'http_code' => 418, 'description' => 'You are not allowed to copy a template across device types.'],
['code' => 'NotBindEslDevice', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 405, 'description' => 'The specified ESL device has not been bound.'],
['code' => 'NotBindEslDevicePub', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 418, 'description' => 'The specified ESL device has not been bound.'],
['code' => 'NotFindAlarm', 'message' => 'The specified alert does not exist.', 'http_code' => 404, 'description' => 'The specified alert item does not exist.'],
['code' => 'NotFindAlarmPub', 'message' => 'The specified alert does not exist.', 'http_code' => 417, 'description' => 'The specified alert item does not exist.'],
['code' => 'NotFindApDevicePub', 'message' => 'The specified AP device does not exist.', 'http_code' => 417, 'description' => 'The specified AP device does not exist.'],
['code' => 'NotFindCompany', 'message' => 'The specified company does not exist.', 'http_code' => 404, 'description' => 'The specified company does not exist.'],
['code' => 'NotFindCompanyAccount', 'message' => 'The Alibaba Cloud account of the specified company does not exist.', 'http_code' => 404, 'description' => 'The Alibaba Cloud account of the specified company does not exist.'],
['code' => 'NotFindCompanyAccountPub', 'message' => 'The Alibaba Cloud account of the specified company does not exist.', 'http_code' => 417, 'description' => 'The Alibaba Cloud account of the specified company does not exist.'],
['code' => 'NotFindCompanyConfigPub', 'message' => 'The specified company configuration does not exist.', 'http_code' => 417, 'description' => 'The merchant configuration information does not exist.'],
['code' => 'NotFindCompanyConfigStatusPub', 'message' => 'The specified company configuration status does not exist.', 'http_code' => 417, 'description' => 'The specified company configuration status does not exist.'],
['code' => 'NotFindCompanyIdByConfigPub', 'message' => 'The company ID cannot be found based on the company configuration information.', 'http_code' => 417, 'description' => 'The company ID cannot be found based on the company configuration information.'],
['code' => 'NotFindCompanyPub', 'message' => 'The specified company does not exist.', 'http_code' => 417, 'description' => 'The specified company does not exist.'],
['code' => 'NotFindCompanySessionTokenPub', 'message' => 'The specified session token does not exist.', 'http_code' => 417, 'description' => 'No access token is configured for the merchant.'],
['code' => 'NotFindCompanyTemplatePub', 'message' => 'The specified company template does not exist.', 'http_code' => 417, 'description' => 'The enterprise template does not exist.'],
['code' => 'NotFindEslDevice', 'message' => 'The specified ESL device does not exist.', 'http_code' => 404, 'description' => 'The specified ESL device does not exist.'],
['code' => 'NotFindEslDevicePub', 'message' => 'The specified ESL device does not exist.', 'http_code' => 417, 'description' => 'The specified ESL device does not exist.'],
['code' => 'NotFindEslPositionPub', 'message' => 'The specified ESL position does not exist.', 'http_code' => 417, 'description' => 'The specified ESL position does not exist.'],
['code' => 'NotFindItem', 'message' => 'The specified item does not exist.', 'http_code' => 404, 'description' => 'The specified item does not exist.'],
['code' => 'NotFindItemPub', 'message' => 'The specified item does not exist.', 'http_code' => 417, 'description' => 'The specified item does not exist.'],
['code' => 'NotFindOperatorAccount', 'message' => 'The specified RAM user of the operator does not exist.', 'http_code' => 404, 'description' => 'The specified RAM user of the operator does not exist.'],
['code' => 'NotFindOperatorAccountPub', 'message' => 'The specified RAM user of the operator does not exist.', 'http_code' => 417, 'description' => 'The specified RAM user of the operator does not exist.'],
['code' => 'NotFindOperatorUser', 'message' => 'The specified ESL user of the operator does not exist.', 'http_code' => 404, 'description' => 'The specified ESL user of the operator does not exist.'],
['code' => 'NotFindOperatorUserPub', 'message' => 'The specified ESL user of the operator does not exist.', 'http_code' => 417, 'description' => 'The specified ESL user of the operator does not exist.'],
['code' => 'NotFindPlanogramPositionPub', 'message' => 'The specified planogram position does not exist.', 'http_code' => 417, 'description' => 'The specified planogram position does not exist.'],
['code' => 'NotFindPlanogramShelfPub', 'message' => 'The specified planogram shelf does not exist.', 'http_code' => 417, 'description' => 'The specified planogram shelf does not exist.'],
['code' => 'NotFindRailMappingPub', 'message' => 'The specified rail mapping does not exist.', 'http_code' => 417, 'description' => 'The specified rail mapping does not exist.'],
['code' => 'NotFindRamUser', 'message' => 'The specified RAM user does not exist.', 'http_code' => 404, 'description' => 'The specified RAM user does not exist.'],
['code' => 'NotFindRamUserPub', 'message' => 'The specified RAM user does not exist.', 'http_code' => 417, 'description' => 'The specified RAM user does not exist.'],
['code' => 'NotFindResource', 'message' => 'The specified resource %s does not exist.', 'http_code' => 404, 'description' => 'The specified resource %s does not exist.'],
['code' => 'NotFindResourcePub', 'message' => 'The specified resource %s does not exist.', 'http_code' => 417, 'description' => 'The specified resource %s does not exist.'],
['code' => 'NotFindRoleByRoleCodePub', 'message' => 'The specified role code does not exist.', 'http_code' => 417, 'description' => 'The specified role code does not exist.'],
['code' => 'NotFindStore', 'message' => 'The specified store %s does not exist.', 'http_code' => 404, 'description' => 'The specified store %s does not exist.'],
['code' => 'NotFindStorePub', 'message' => 'The specified store %s does not exist.', 'http_code' => 417, 'description' => 'The specified store %s does not exist.'],
['code' => 'NotFindTaoCustomItem', 'message' => 'Failed to get the information about the Taobao item using user-defined information.', 'http_code' => 404, 'description' => 'Failed to get the information about the Taobao item using user-defined information.'],
['code' => 'NotFindTaoItem', 'message' => 'Failed to get the item information from Taobao.', 'http_code' => 404, 'description' => 'Failed to get the item information from Taobao.'],
['code' => 'NotFindTaoItemByOuterId', 'message' => 'Failed to get the Taobao item using outer ID.', 'http_code' => 404, 'description' => 'Failed to get the Taobao item using outer ID.'],
['code' => 'NotFindTaoItemPrice', 'message' => 'Failed to get the price of the Taobao item.', 'http_code' => 404, 'description' => 'Failed to get the price of the Taobao item.'],
['code' => 'NotFindTaoItemPromotion', 'message' => 'Failed to get the Taobao item promotion information.', 'http_code' => 404, 'description' => 'Failed to get the Taobao item promotion information.'],
['code' => 'NotFindTaoItemSku', 'message' => 'Failed to get the Taobao SKU ID.', 'http_code' => 404, 'description' => 'Failed to get the Taobao SKU ID.'],
['code' => 'NotFindTaoItemSkuPrice', 'message' => 'Failed to get the price of the Taobao item SKU.', 'http_code' => 404, 'description' => 'Failed to get the price of the Taobao item SKU.'],
['code' => 'NotFindTaoPromotion', 'message' => 'Failed to get the Taobao promotion.', 'http_code' => 404, 'description' => 'Failed to get the Taobao promotion.'],
['code' => 'NotFindTaoSkuPromotion', 'message' => 'Failed to get the Taobao item SKU promotion information.', 'http_code' => 404, 'description' => 'Failed to get the Taobao item SKU promotion information.'],
['code' => 'NotFindTaoToken', 'message' => 'Failed to get the access token.', 'http_code' => 404, 'description' => 'Failed to get the access token from Taobao.'],
['code' => 'NotFindUser', 'message' => 'The specified ESL user does not exist.', 'http_code' => 404, 'description' => 'The specified ESL user does not exist.'],
['code' => 'NotFindUserAccount', 'message' => 'The specified RAM user does not exist.', 'http_code' => 404, 'description' => 'The specified RAM user does not exist.'],
['code' => 'NotFindUserAccountPub', 'message' => 'The specified RAM user does not exist.', 'http_code' => 417, 'description' => 'The specified RAM user does not exist.'],
['code' => 'NotFindUserPub', 'message' => 'The specified ESL user does not exist.', 'http_code' => 417, 'description' => 'The specified ESL user does not exist.'],
['code' => 'NotFoundTheMaterial', 'message' => 'Failed to found the material in the brand.', 'http_code' => 418, 'description' => 'Failed to found the material in the brand.'],
['code' => 'OAuthException', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => 'A server error occurred while processing your request.'],
['code' => 'OAuthExceptionPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => 'An internal system error occurred.'],
['code' => 'OperationFail.CompanyNotFound', 'message' => 'The specified company does not exist.', 'http_code' => 400, 'description' => 'The specified company does not exist.'],
['code' => 'OperationFail.DuplicatedBind', 'message' => 'The specified ESL device has already been bound.', 'http_code' => 403, 'description' => 'The specified ESL device has already been bound.'],
['code' => 'OperationFail.EslDeviceNotBound', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 403, 'description' => 'The specified ESL device has not been bound.'],
['code' => 'OperationFail.EslDeviceNotFound', 'message' => 'The specified ESL device does not exist.', 'http_code' => 403, 'description' => 'The specified ESL device does not exist.'],
['code' => 'OperationFail.ItemNotFound', 'message' => 'The specified item does not exist.', 'http_code' => 403, 'description' => 'The specified item does not exist.'],
['code' => 'OperationFail.StoreNotFound', 'message' => 'The specified store does not exist.', 'http_code' => 403, 'description' => 'The specified store does not exist.'],
['code' => 'PermissionError', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'You are not authorized to operate on the specified resource.'],
['code' => 'PlanogramPositionAlreadyExistPub', 'message' => 'The specified planogram position already exists.', 'http_code' => 418, 'description' => 'The lock is not acquired.'],
['code' => 'PlanogramShelfAlreadyExistPub', 'message' => 'The specified planogram shelf already exists.', 'http_code' => 418, 'description' => 'The specified planogram shelf already exists.'],
['code' => 'PlatformError', 'message' => 'An error occurred while processing your API request on the platform.', 'http_code' => 500, 'description' => 'An error occurred while processing your API request on the platform.'],
['code' => 'PlatformFailActivateAp', 'message' => 'Failed to activate the specified access point.', 'http_code' => 406, 'description' => 'Failed to activate the specified access point.'],
['code' => 'PlatformFailBatchInsertItem', 'message' => 'Failed to insert multiple items.', 'http_code' => 406, 'description' => 'Failed to insert multiple items.'],
['code' => 'PlatformFailBindAp', 'message' => 'Failed to bind the specified access point.', 'http_code' => 406, 'description' => 'Failed to bind the specified access point.'],
['code' => 'PlatformFailBindEslDevice', 'message' => 'Failed to bind the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to bind the specified ESL device.'],
['code' => 'PlatformFailCreateCompany', 'message' => 'Failed to create a company.', 'http_code' => 406, 'description' => 'Failed to create a company.'],
['code' => 'PlatformFailCreateStore', 'message' => 'Failed to create a store.', 'http_code' => 406, 'description' => 'Failed to create a store.'],
['code' => 'PlatformFailDeleteEslDevice', 'message' => 'Failed to delete the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to delete the specified ESL device.'],
['code' => 'PlatformFailGetEslDevice', 'message' => 'Failed to query the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to query the specified ESL device.'],
['code' => 'PlatformFailInsertItem', 'message' => 'Failed to insert an item.', 'http_code' => 406, 'description' => 'Failed to insert an item.'],
['code' => 'PlatformFailSearchAp', 'message' => 'Failed to query the specified access point.', 'http_code' => 406, 'description' => 'Failed to query the specified access point.'],
['code' => 'PlatformFailUnbindAp', 'message' => 'Failed to unbind the specified access point.', 'http_code' => 406, 'description' => 'Failed to unbind the specified access point.'],
['code' => 'PlatformFailUnbindEslDevice', 'message' => 'Failed to unbind the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to unbind the specified ESL device.'],
['code' => 'PlatformResponseError', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => 'An error occurred while processing your request.'],
['code' => 'PlatformResponseErrorPub.%s', 'message' => 'An error %s occurred while processing your request.', 'http_code' => 416, 'description' => 'An error %s occurred while processing your request.'],
['code' => 'PlatformResponseErrorPub.ActivateAp', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => 'An error occurred while processing the request.'],
['code' => 'PlatformResponseErrorPub.BindEslDevice', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => 'An error occurred while processing the request.'],
['code' => 'PlatformResponseNone', 'message' => 'Failed to respond to your request.', 'http_code' => 406, 'description' => 'Failed to respond to your request.'],
['code' => 'PlatformResponseNonePub', 'message' => 'Failed to respond to your request.', 'http_code' => 416, 'description' => 'Failed to respond to your request.'],
['code' => 'PlatformResponseParserError', 'message' => 'Failed to parse the response to your request.', 'http_code' => 406, 'description' => 'Failed to parse the response to your request.'],
['code' => 'PlatformResponseParserErrorPub', 'message' => 'Failed to parse the response to your request.', 'http_code' => 416, 'description' => 'Failed to parse the response to your request.'],
['code' => 'PublicMaterial', 'message' => 'The public material cannot be operated.', 'http_code' => 418, 'description' => 'The public material can\'t be operated.'],
['code' => 'PublicMaterial', 'message' => 'The public material cannott be operated.', 'http_code' => 418, 'description' => 'The public material cannott be operated.'],
['code' => 'RailNotBelongStorePub', 'message' => 'The specified rail is being used by another store.', 'http_code' => 418, 'description' => 'The specified rail is being used by another store.'],
['code' => 'RamAuthFailed', 'message' => 'Failed to authenticate the specified RAM user.', 'http_code' => 405, 'description' => 'Failed to authenticate the specified RAM user.'],
['code' => 'RamAuthFailedPub', 'message' => 'Failed to authenticate the specified RAM user.', 'http_code' => 418, 'description' => 'Failed to authenticate the specified RAM user.'],
['code' => 'RamSettingError', 'message' => 'Failed to process your RAM settings.', 'http_code' => 405, 'description' => 'Failed to process your RAM settings.'],
['code' => 'RamSettingErrorPub', 'message' => 'Failed to process your RAM settings.', 'http_code' => 418, 'description' => 'Failed to process your RAM settings.'],
['code' => 'ResourcePermissionError', 'message' => 'You are not authorized to operate on the specified resource %s.', 'http_code' => 401, 'description' => 'You are not authorized to operate on the specified resource %s.'],
['code' => 'ResourcePermissionErrorPub', 'message' => 'You are not authorized to manage the specified resource %s.', 'http_code' => 411, 'description' => 'You are not authorized to operate on the specified resource %s.'],
['code' => 'ReviewImageError', 'message' => 'Failed to review image.', 'http_code' => 418, 'description' => 'Failed to preview the image.'],
['code' => 'SendPictureToEslErrorPub', 'message' => 'Failed to send picture to ESL device.', 'http_code' => 418, 'description' => 'Failed to send picture to ESL device.'],
['code' => 'ServerLocationNotConfirmedErrorPub', 'message' => 'The server location is not confirmed.', 'http_code' => 418, 'description' => 'The server location is not confirmed.'],
['code' => 'SettingError', 'message' => 'The specified configurations are invalid.', 'http_code' => 502, 'description' => 'The specified configurations are invalid.'],
['code' => 'ShelfNumberLimitPub', 'message' => 'The number of shelves under the store exceeds the limit.', 'http_code' => 418, 'description' => 'The number of shelves under the store exceeds the limit.'],
['code' => 'StoreBelongOther', 'message' => 'The specified store %s has been assigned to another store administrator.', 'http_code' => 409, 'description' => 'The specified store %s has been assigned to another store administrator.'],
['code' => 'StoreBelongOtherPub', 'message' => 'The specified store %s has been assigned to another store administrator.', 'http_code' => 419, 'description' => 'The specified store %s has been assigned to another store administrator.'],
['code' => 'StoreError', 'message' => 'An error occurred while processing your request related to stores.', 'http_code' => 507, 'description' => 'An error occurred while processing your request related to stores.'],
['code' => 'StoreNumberLimitPub', 'message' => 'The number of stores exceeds the limit.', 'http_code' => 418, 'description' => 'The number of stores exceeds the limit.'],
['code' => 'StoreNumLimit', 'message' => 'The maximum number of stores is %s.', 'http_code' => 410, 'description' => 'The maximum number of stores is %s.'],
['code' => 'StoreOutsideCompany', 'message' => 'The specified store under the company does not exist.', 'http_code' => 405, 'description' => 'The specified store under the company does not exist.'],
['code' => 'StoreOutsideCompanyPub', 'message' => 'The specified store for the company does not exist.', 'http_code' => 418, 'description' => 'The specified store under the company does not exist.'],
['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 500, 'description' => 'A system error occurred while processing your request.'],
['code' => 'TemplateGroupHasBindToContainer', 'message' => 'The TemplateGroup has been bound to the Container.', 'http_code' => 418, 'description' => ''],
['code' => 'TestLabelError', 'message' => 'You are not authorized to use the public beta version.', 'http_code' => 503, 'description' => 'You are not authorized to use the public beta version.'],
['code' => 'UnbindingStoreEslErrorPub', 'message' => 'In Unbinding, please wait', 'http_code' => 418, 'description' => 'The ESL device for your store is being unbound.'],
['code' => 'UnexpectedError', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => 'An unknown error occurred.'],
['code' => 'UnexpectedErrorPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => 'An unknown error occurred.'],
['code' => 'UnknownError', 'message' => 'An error occurred while processing your request.', 'http_code' => 501, 'description' => 'An error occurred while processing your request.'],
['code' => 'UserAlreadyExist', 'message' => 'The specified user already exists.', 'http_code' => 405, 'description' => 'The user already exists.'],
['code' => 'UserAlreadyExistPub', 'message' => 'The specified user already exists.', 'http_code' => 418, 'description' => 'User already exists'],
['code' => 'UserAssignGuest', 'message' => 'Users cannot be assigned as guests.', 'http_code' => 405, 'description' => 'Users cannot be assigned as guests.'],
['code' => 'UserAssignGuestPub', 'message' => 'Users cannot be assigned as guests.', 'http_code' => 418, 'description' => 'Users cannot be assigned as guests.'],
['code' => 'UserCompanyRootExist', 'message' => 'The specified company root administrator already exists.', 'http_code' => 405, 'description' => 'The specified company root administrator already exists.'],
['code' => 'UserCompanyRootExistPub', 'message' => 'The specified company root administrator already exists.', 'http_code' => 418, 'description' => 'The specified company root administrator already exists.'],
['code' => 'UserDeleteNotGuest', 'message' => 'Only guests can be deleted.', 'http_code' => 405, 'description' => 'Only guests can be deleted.'],
['code' => 'UserDeleteNotGuestPub', 'message' => 'Only guests can be deleted.', 'http_code' => 418, 'description' => 'Only guests can be deleted.'],
['code' => 'UserError', 'message' => 'An error occurred while processing your request.', 'http_code' => 504, 'description' => 'An error occurred while processing your request.'],
['code' => 'UserInStore', 'message' => 'The store contains a user.', 'http_code' => 405, 'description' => 'The store contains a user.'],
['code' => 'UserInStorePub', 'message' => 'The store contains a user.', 'http_code' => 418, 'description' => 'The store contains a user.'],
['code' => 'UserOutsideCompany', 'message' => 'The operator and the specified user do not belong to the same company.', 'http_code' => 405, 'description' => 'The operator and the specified user do not belong to the same company.'],
['code' => 'UserOutsideCompanyPub', 'message' => 'The operator and the specified user do not belong to the same company.', 'http_code' => 418, 'description' => 'The operator and the specified user do not belong to the same company.'],
['code' => 'UserStoreCodeAlreadyExistPub', 'message' => 'The specified userStoreCode already exists.', 'http_code' => 418, 'description' => 'The specified userStoreCode already exists.'],
['code' => 'UserTypePermissionError', 'message' => 'You are not authorized to operate on the specified user type %s.', 'http_code' => 401, 'description' => 'You are not authorized to operate on the specified user type %s.'],
['code' => 'UserTypePermissionErrorPub', 'message' => 'You are not authorized to manage the specified user type %s.', 'http_code' => 411, 'description' => 'You are not authorized to operate on the specified user type %s.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'ActivateApDevice'],
['description' => 'Error codes changed', 'api' => 'AddApDevice'],
['description' => 'Error codes changed', 'api' => 'AddUser'],
['description' => 'Error codes changed', 'api' => 'AssignUser'],
['description' => 'Error codes changed', 'api' => 'DeleteApDevice'],
],
'createdAt' => '2024-04-26T06:18:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed, Request parameters changed', 'api' => 'AddCompanyTemplate'],
['description' => 'Error codes changed, Request parameters changed', 'api' => 'BindEslDevice'],
['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeBinders'],
['description' => 'Response parameters changed', 'api' => 'DescribeEslDevices'],
['description' => 'Response parameters changed', 'api' => 'DescribeTemplateByModel'],
['description' => 'OpenAPI offline', 'api' => 'QueryTemplateListByGroupId'],
['description' => 'Request parameters changed, Error codes changed', 'api' => 'UnbindEslDevice'],
],
'createdAt' => '2022-07-18T13:15:44.000Z',
'description' => '多媒体一屏多价功能支持',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'BatchInsertItems'],
['description' => 'Response parameters changed', 'api' => 'DescribeItems'],
],
'createdAt' => '2022-07-18T13:14:34.000Z',
'description' => '出清模板支持',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'AddMaterial'],
],
'createdAt' => '2022-05-30T08:48:26.000Z',
'description' => '云价签1.2.0接口版本发布',
],
[
'apis' => [
['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'DescribeEslDevices'],
],
'createdAt' => '2022-03-30T09:08:37.000Z',
'description' => '-增加电子价签模板可视化功能.',
],
],
];
|