oneentry 1.0.63 → 1.0.64
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +735 -164
- package/dist/blocks/blocksApi.d.ts +7 -1
- package/dist/blocks/blocksApi.js +9 -0
- package/dist/blocks/blocksInterfaces.d.ts +8 -1
- package/dist/formsData/formsDataInterfaces.d.ts +1 -3
- package/dist/orders/ordersApi.d.ts +49 -10
- package/dist/orders/ordersApi.js +61 -13
- package/dist/orders/ordersInterfaces.d.ts +36 -1
- package/dist/products/productsInterfaces.d.ts +9 -0
- package/dist/templates/templatesApi.d.ts +8 -0
- package/dist/templates/templatesApi.js +11 -0
- package/dist/templates/templatesInterfaces.d.ts +4 -3
- package/dist/templates-preview/templatesPreviewInterfaces.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,19 +27,23 @@ import { defineOneEntry } from 'oneentry'
|
|
|
27
27
|
const {
|
|
28
28
|
Admins,
|
|
29
29
|
AttributesSets,
|
|
30
|
+
AuthProvider,
|
|
30
31
|
Blocks,
|
|
32
|
+
Events,
|
|
31
33
|
Forms,
|
|
32
34
|
FormData,
|
|
33
35
|
FileUploading,
|
|
34
36
|
GeneralTypes,
|
|
35
37
|
Locales,
|
|
36
38
|
Menus,
|
|
39
|
+
Orders,
|
|
37
40
|
Pages,
|
|
38
41
|
Products,
|
|
39
42
|
ProductStatuses,
|
|
40
43
|
System,
|
|
41
44
|
Templates,
|
|
42
|
-
TemplatePreviews
|
|
45
|
+
TemplatePreviews,
|
|
46
|
+
Users
|
|
43
47
|
} = defineOneEntry('your-url');
|
|
44
48
|
```
|
|
45
49
|
|
|
@@ -75,7 +79,9 @@ const api = defineOneEntry('your-url', {token: 'my-token', langCode:'my-langCode
|
|
|
75
79
|
Now you can use the following links to jump to specific entries:
|
|
76
80
|
- [Admins](#admins)
|
|
77
81
|
- [AttributesSets](#attributessets)
|
|
82
|
+
- [AuthProvider](#authprovider)
|
|
78
83
|
- [Blocks](#blocks)
|
|
84
|
+
- [Events](#events)
|
|
79
85
|
- [Forms](#forms)
|
|
80
86
|
- [FormData](#formdata)
|
|
81
87
|
- [FileUploading](#fileuploading)
|
|
@@ -90,6 +96,7 @@ Now you can use the following links to jump to specific entries:
|
|
|
90
96
|
- [System](#system)
|
|
91
97
|
- [Templates](#templates)
|
|
92
98
|
- [TemplatePreviews](#templatepreviews)
|
|
99
|
+
- [Users](#users)
|
|
93
100
|
|
|
94
101
|
|
|
95
102
|
## <h2 id="admins"> Admins </h2>
|
|
@@ -329,7 +336,7 @@ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extende
|
|
|
329
336
|
---
|
|
330
337
|
|
|
331
338
|
|
|
332
|
-
## <h2 id="
|
|
339
|
+
## <h2 id="authprovider"> User Auth Provider </h2>
|
|
333
340
|
|
|
334
341
|
```js
|
|
335
342
|
const { AuthProvider } = defineOneEntry('your-url');
|
|
@@ -1035,7 +1042,30 @@ Example return:
|
|
|
1035
1042
|
]
|
|
1036
1043
|
```
|
|
1037
1044
|
|
|
1038
|
-
|
|
1045
|
+
### Blocks.searchBlock(name, langCode)
|
|
1046
|
+
|
|
1047
|
+
```js
|
|
1048
|
+
const value = await Blocks.searchBlock('my-marker', 'en_US')
|
|
1049
|
+
```
|
|
1050
|
+
|
|
1051
|
+
> Quick search for block objects with limited output.
|
|
1052
|
+
|
|
1053
|
+
Example return:
|
|
1054
|
+
|
|
1055
|
+
```json
|
|
1056
|
+
[
|
|
1057
|
+
{
|
|
1058
|
+
"id": 1,
|
|
1059
|
+
"name": "my block",
|
|
1060
|
+
"identifier": "my-block"
|
|
1061
|
+
}
|
|
1062
|
+
]
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
---
|
|
1067
|
+
|
|
1068
|
+
## <h2 id="events"> Events </h2>
|
|
1039
1069
|
|
|
1040
1070
|
```js
|
|
1041
1071
|
const { Events } = defineOneEntry('your-url');
|
|
@@ -1836,7 +1866,7 @@ const { Orders } = defineOneEntry('your-url');
|
|
|
1836
1866
|
### Orders.getOrderByMarker(marker, langCode)
|
|
1837
1867
|
|
|
1838
1868
|
```js
|
|
1839
|
-
const value = await
|
|
1869
|
+
const value = await Orders.getOrderByMarker('my-order', 'en_US')
|
|
1840
1870
|
```
|
|
1841
1871
|
|
|
1842
1872
|
> This method retrieves one order storage object by marker.
|
|
@@ -1895,8 +1925,7 @@ example: [{ "identifier": "p1" }] <br>
|
|
|
1895
1925
|
"formIdentifier": "order_form",
|
|
1896
1926
|
"paymentAccountIdentifier": "stripe",
|
|
1897
1927
|
"currency": "USD",
|
|
1898
|
-
"formData":
|
|
1899
|
-
"en_US": [
|
|
1928
|
+
"formData": [
|
|
1900
1929
|
{
|
|
1901
1930
|
"marker": "name_order",
|
|
1902
1931
|
"value": "Alex"
|
|
@@ -1909,8 +1938,7 @@ example: [{ "identifier": "p1" }] <br>
|
|
|
1909
1938
|
"marker": "email_order",
|
|
1910
1939
|
"value": "example@oneentry.cloud"
|
|
1911
1940
|
}
|
|
1912
|
-
|
|
1913
|
-
},
|
|
1941
|
+
],
|
|
1914
1942
|
"products": [
|
|
1915
1943
|
{
|
|
1916
1944
|
"productId": 444,
|
|
@@ -1925,7 +1953,7 @@ example: [{ "identifier": "p1" }] <br>
|
|
|
1925
1953
|
]
|
|
1926
1954
|
}
|
|
1927
1955
|
|
|
1928
|
-
const value = await
|
|
1956
|
+
const value = await Orders.createOrder('my-order', body)
|
|
1929
1957
|
```
|
|
1930
1958
|
|
|
1931
1959
|
> This method retrieves one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
@@ -2016,6 +2044,292 @@ example: payment-1 <br>
|
|
|
2016
2044
|
example: { "title": "Account 1" } <br>
|
|
2017
2045
|
</details>
|
|
2018
2046
|
|
|
2047
|
+
|
|
2048
|
+
### Orders.updateOrderByMarkerAndId(marker, data, langCode)
|
|
2049
|
+
|
|
2050
|
+
```js
|
|
2051
|
+
const body = {
|
|
2052
|
+
"formIdentifier": "order_form",
|
|
2053
|
+
"paymentAccountIdentifier": "stripe",
|
|
2054
|
+
"currency": "USD",
|
|
2055
|
+
"formData": [
|
|
2056
|
+
{
|
|
2057
|
+
"marker": "name_order",
|
|
2058
|
+
"value": "Alex"
|
|
2059
|
+
},
|
|
2060
|
+
{
|
|
2061
|
+
"marker": "phone_order",
|
|
2062
|
+
"value": "+19999999999"
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"marker": "email_order",
|
|
2066
|
+
"value": "example@oneentry.cloud"
|
|
2067
|
+
}
|
|
2068
|
+
],
|
|
2069
|
+
"products": [
|
|
2070
|
+
{
|
|
2071
|
+
"productId": 444,
|
|
2072
|
+
"quantity": 1,
|
|
2073
|
+
"price": "0.1"
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
"productId": 446,
|
|
2077
|
+
"quantity": 3,
|
|
2078
|
+
"price": "123"
|
|
2079
|
+
}
|
|
2080
|
+
]
|
|
2081
|
+
}
|
|
2082
|
+
|
|
2083
|
+
const value = await Orders.updateOrderByMarkerAndId('my-order', body)
|
|
2084
|
+
```
|
|
2085
|
+
|
|
2086
|
+
> This method update one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
2087
|
+
|
|
2088
|
+
Example return:
|
|
2089
|
+
```json
|
|
2090
|
+
{
|
|
2091
|
+
"id": 17,
|
|
2092
|
+
"statusIdentifier": "inprogress",
|
|
2093
|
+
"formIdentifier": "order-form",
|
|
2094
|
+
"paymentIdentifier": "payment-1",
|
|
2095
|
+
"formData": [
|
|
2096
|
+
{
|
|
2097
|
+
"marker": "name_1",
|
|
2098
|
+
"value": "Name"
|
|
2099
|
+
}
|
|
2100
|
+
],
|
|
2101
|
+
"products": [
|
|
2102
|
+
{
|
|
2103
|
+
"id": 1,
|
|
2104
|
+
"title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
|
|
2105
|
+
"sku": null,
|
|
2106
|
+
"price": "1.00",
|
|
2107
|
+
"quantity": 10,
|
|
2108
|
+
"previewImage": [
|
|
2109
|
+
{
|
|
2110
|
+
"filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
|
|
2111
|
+
"downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
|
|
2112
|
+
"size": 296391,
|
|
2113
|
+
"previewLink": ""
|
|
2114
|
+
}
|
|
2115
|
+
]
|
|
2116
|
+
}
|
|
2117
|
+
],
|
|
2118
|
+
"totalSum": "12.00",
|
|
2119
|
+
"currency": "USD",
|
|
2120
|
+
"createdDate": "2023-01-01 12:12",
|
|
2121
|
+
"paymentAccountIdentifier": "payment-1",
|
|
2122
|
+
"paymentAccountLocalizeInfos": {
|
|
2123
|
+
"title": "Account 1"
|
|
2124
|
+
}
|
|
2125
|
+
}
|
|
2126
|
+
```
|
|
2127
|
+
<details>
|
|
2128
|
+
<summary>Schema</summary>
|
|
2129
|
+
|
|
2130
|
+
**statusIdentifier:** string <br>
|
|
2131
|
+
*text identifier of the order status* <br>
|
|
2132
|
+
example: inprogress <br>
|
|
2133
|
+
|
|
2134
|
+
**formIdentifier:** string <br>
|
|
2135
|
+
*text identifier of the form status* <br>
|
|
2136
|
+
example: order-form <br>
|
|
2137
|
+
|
|
2138
|
+
**paymentIdentifier** string <br>
|
|
2139
|
+
*text identifier of the order payment* <br>
|
|
2140
|
+
example: payment-1 <br>
|
|
2141
|
+
|
|
2142
|
+
**formData** FormDataType <br>
|
|
2143
|
+
*data submitted by the form linked to the order store* <br>
|
|
2144
|
+
example: [{ "marker": "name_1", "value": "Name" } ] <br>
|
|
2145
|
+
|
|
2146
|
+
**products** Record<string, string | any>[] <br>
|
|
2147
|
+
*array of products added to order* <br>
|
|
2148
|
+
|
|
2149
|
+
**totalSum** string <br>
|
|
2150
|
+
*total order amount* <br>
|
|
2151
|
+
example: 12.00 <br>
|
|
2152
|
+
|
|
2153
|
+
**currency** string <br>
|
|
2154
|
+
*currency used to pay for the order* <br>
|
|
2155
|
+
example: USD <br>
|
|
2156
|
+
|
|
2157
|
+
**createdDate** string <br>
|
|
2158
|
+
*date when the order was created* <br>
|
|
2159
|
+
example: 2023-01-01 12:12 <br>
|
|
2160
|
+
|
|
2161
|
+
**price** number <br>
|
|
2162
|
+
*price of the product per unit (at the time of ordering)* <br>
|
|
2163
|
+
example: 20.00 <br>
|
|
2164
|
+
|
|
2165
|
+
**paymentAccountIdentifier** string <br>
|
|
2166
|
+
*textual identifier for the order payment* <br>
|
|
2167
|
+
example: payment-1 <br>
|
|
2168
|
+
|
|
2169
|
+
**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
|
|
2170
|
+
*payment account name considering localization* <br>
|
|
2171
|
+
example: { "title": "Account 1" } <br>
|
|
2172
|
+
</details>
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
### Orders.getAllOrders(langCode, limit, offset)
|
|
2176
|
+
|
|
2177
|
+
```js
|
|
2178
|
+
const value = await Orders.getAllOrders()
|
|
2179
|
+
```
|
|
2180
|
+
|
|
2181
|
+
> This method getting all the order storage objects. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
2182
|
+
|
|
2183
|
+
Example return:
|
|
2184
|
+
```json
|
|
2185
|
+
[
|
|
2186
|
+
{
|
|
2187
|
+
"id": 1764,
|
|
2188
|
+
"localizeInfos": {
|
|
2189
|
+
"title": "Order 1"
|
|
2190
|
+
},
|
|
2191
|
+
"identifier": "catalog",
|
|
2192
|
+
"generalTypeId": 4,
|
|
2193
|
+
"formIdentifier": "catalog-form",
|
|
2194
|
+
"paymentAccountIdentifiers": [
|
|
2195
|
+
{
|
|
2196
|
+
"identifier": "p1"
|
|
2197
|
+
}
|
|
2198
|
+
]
|
|
2199
|
+
}
|
|
2200
|
+
]
|
|
2201
|
+
```
|
|
2202
|
+
<details>
|
|
2203
|
+
<summary>Schema</summary>
|
|
2204
|
+
|
|
2205
|
+
**id:** number <br>
|
|
2206
|
+
*object identifier* <br>
|
|
2207
|
+
example: 1764 <br>
|
|
2208
|
+
|
|
2209
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2210
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2211
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
2212
|
+
|
|
2213
|
+
**identifier** string <br>
|
|
2214
|
+
*textual identifier for the record field* <br>
|
|
2215
|
+
example: catalog <br>
|
|
2216
|
+
|
|
2217
|
+
**generalTypeId** number <br>
|
|
2218
|
+
*type identifier* <br>
|
|
2219
|
+
example: 4 <br>
|
|
2220
|
+
|
|
2221
|
+
**formIdentifier** string <br>
|
|
2222
|
+
*textual identifier for the form used by the order storage* <br>
|
|
2223
|
+
example: catalog-form <br>
|
|
2224
|
+
|
|
2225
|
+
**paymentAccountIdentifiers** Array<{identifier:string} <br>
|
|
2226
|
+
*array of textual identifiers of payment accounts used by the order storage* <br>
|
|
2227
|
+
example: [{ "identifier": "p1" }] <br>
|
|
2228
|
+
|
|
2229
|
+
</details>
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
### Orders.getAllOrdersByMarker(marker, langCode)
|
|
2233
|
+
|
|
2234
|
+
```js
|
|
2235
|
+
const value = await Orders.getAllOrdersByMarker('my-order')
|
|
2236
|
+
```
|
|
2237
|
+
|
|
2238
|
+
> This method getting all order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
2239
|
+
|
|
2240
|
+
Example return:
|
|
2241
|
+
```json
|
|
2242
|
+
{
|
|
2243
|
+
"id": 17,
|
|
2244
|
+
"statusIdentifier": "inprogress",
|
|
2245
|
+
"formIdentifier": "order-form",
|
|
2246
|
+
"paymentIdentifier": "payment-1",
|
|
2247
|
+
"formData": [
|
|
2248
|
+
{
|
|
2249
|
+
"marker": "name_1",
|
|
2250
|
+
"value": "Name"
|
|
2251
|
+
}
|
|
2252
|
+
],
|
|
2253
|
+
"products": [
|
|
2254
|
+
{
|
|
2255
|
+
"id": 1,
|
|
2256
|
+
"title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
|
|
2257
|
+
"sku": null,
|
|
2258
|
+
"price": "1.00",
|
|
2259
|
+
"quantity": 10,
|
|
2260
|
+
"previewImage": [
|
|
2261
|
+
{
|
|
2262
|
+
"filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
|
|
2263
|
+
"downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
|
|
2264
|
+
"size": 296391,
|
|
2265
|
+
"previewLink": ""
|
|
2266
|
+
}
|
|
2267
|
+
]
|
|
2268
|
+
}
|
|
2269
|
+
],
|
|
2270
|
+
"totalSum": "12.00",
|
|
2271
|
+
"currency": "USD",
|
|
2272
|
+
"createdDate": "2023-01-01 12:12",
|
|
2273
|
+
"price": 20,
|
|
2274
|
+
"paymentAccountIdentifier": "payment-1",
|
|
2275
|
+
"paymentAccountLocalizeInfos": {
|
|
2276
|
+
"title": "Account 1"
|
|
2277
|
+
},
|
|
2278
|
+
"isHistory": true
|
|
2279
|
+
}
|
|
2280
|
+
```
|
|
2281
|
+
<details>
|
|
2282
|
+
<summary>Schema</summary>
|
|
2283
|
+
|
|
2284
|
+
**statusIdentifier:** string <br>
|
|
2285
|
+
*text identifier of the order status* <br>
|
|
2286
|
+
example: inprogress <br>
|
|
2287
|
+
|
|
2288
|
+
**formIdentifier:** string <br>
|
|
2289
|
+
*text identifier of the form status* <br>
|
|
2290
|
+
example: order-form <br>
|
|
2291
|
+
|
|
2292
|
+
**paymentIdentifier** string <br>
|
|
2293
|
+
*text identifier of the order payment* <br>
|
|
2294
|
+
example: payment-1 <br>
|
|
2295
|
+
|
|
2296
|
+
**formData** FormDataType <br>
|
|
2297
|
+
*data submitted by the form linked to the order store* <br>
|
|
2298
|
+
example: [{ "marker": "name_1", "value": "Name" } ] <br>
|
|
2299
|
+
|
|
2300
|
+
**products** Record<string, string | any>[] <br>
|
|
2301
|
+
*array of products added to order* <br>
|
|
2302
|
+
|
|
2303
|
+
**totalSum** string <br>
|
|
2304
|
+
*total order amount* <br>
|
|
2305
|
+
example: 12.00 <br>
|
|
2306
|
+
|
|
2307
|
+
**currency** string <br>
|
|
2308
|
+
*currency used to pay for the order* <br>
|
|
2309
|
+
example: USD <br>
|
|
2310
|
+
|
|
2311
|
+
**createdDate** string <br>
|
|
2312
|
+
*date when the order was created* <br>
|
|
2313
|
+
example: 2023-01-01 12:12 <br>
|
|
2314
|
+
|
|
2315
|
+
**price** number <br>
|
|
2316
|
+
*price of the product per unit (at the time of ordering)* <br>
|
|
2317
|
+
example: 20.00 <br>
|
|
2318
|
+
|
|
2319
|
+
**paymentAccountIdentifier** string <br>
|
|
2320
|
+
*textual identifier for the order payment* <br>
|
|
2321
|
+
example: payment-1 <br>
|
|
2322
|
+
|
|
2323
|
+
**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
|
|
2324
|
+
*payment account name considering localization* <br>
|
|
2325
|
+
example: { "title": "Account 1" } <br>
|
|
2326
|
+
|
|
2327
|
+
**isHistory** boolean <br>
|
|
2328
|
+
*indicates that the order has been saved in the order history* <br>
|
|
2329
|
+
example: true <br>
|
|
2330
|
+
</details>
|
|
2331
|
+
|
|
2332
|
+
|
|
2019
2333
|
---
|
|
2020
2334
|
|
|
2021
2335
|
|
|
@@ -3554,32 +3868,53 @@ Example return:
|
|
|
3554
3868
|
|
|
3555
3869
|
```json
|
|
3556
3870
|
[
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
"
|
|
3574
|
-
|
|
3575
|
-
|
|
3871
|
+
{
|
|
3872
|
+
"id": 1764,
|
|
3873
|
+
"localizeInfos": {
|
|
3874
|
+
"title": "Product"
|
|
3875
|
+
},
|
|
3876
|
+
"isVisible": true,
|
|
3877
|
+
"statusId": 1,
|
|
3878
|
+
"relatedIds": [
|
|
3879
|
+
1,
|
|
3880
|
+
2,
|
|
3881
|
+
3
|
|
3882
|
+
],
|
|
3883
|
+
"attributeSetId": 7,
|
|
3884
|
+
"isSync": true,
|
|
3885
|
+
"price": 0,
|
|
3886
|
+
"additional": {
|
|
3887
|
+
"prices": {
|
|
3888
|
+
"min": 0,
|
|
3889
|
+
"max": 100
|
|
3890
|
+
}
|
|
3891
|
+
},
|
|
3892
|
+
"blocks": [
|
|
3893
|
+
null
|
|
3894
|
+
],
|
|
3895
|
+
"sku": "0-123",
|
|
3896
|
+
"productPages": [
|
|
3897
|
+
{
|
|
3898
|
+
"id": 8997,
|
|
3899
|
+
"pageId": 1176,
|
|
3900
|
+
"productId": 8872
|
|
3901
|
+
}
|
|
3902
|
+
],
|
|
3903
|
+
"statusLocalizeInfos": {
|
|
3904
|
+
"title": "Product"
|
|
3905
|
+
},
|
|
3906
|
+
"templateIdentifier": "my-template",
|
|
3907
|
+
"shortDescTemplateIdentifier": "my-template-short",
|
|
3908
|
+
"attributeValues": {
|
|
3576
3909
|
"marker": {
|
|
3577
3910
|
"value": "",
|
|
3578
|
-
"type": "string"
|
|
3579
|
-
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
}
|
|
3911
|
+
"type": "string",
|
|
3912
|
+
"position": 1,
|
|
3913
|
+
"isProductPreview": false
|
|
3914
|
+
}
|
|
3915
|
+
},
|
|
3916
|
+
"position": 1
|
|
3917
|
+
}
|
|
3583
3918
|
]
|
|
3584
3919
|
```
|
|
3585
3920
|
|
|
@@ -3590,6 +3925,14 @@ Example return:
|
|
|
3590
3925
|
*object identifier* <br>
|
|
3591
3926
|
example: 1764 <br>
|
|
3592
3927
|
|
|
3928
|
+
**additional:** Record<string, any> <br>
|
|
3929
|
+
*additional value from the index* <br>
|
|
3930
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
3931
|
+
|
|
3932
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
3933
|
+
*json description of the item status object, taking into account the language* <br>
|
|
3934
|
+
example: { "title": "Product" <br>
|
|
3935
|
+
|
|
3593
3936
|
**localizeInfos:** Record<string, any> <br>
|
|
3594
3937
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3595
3938
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -3657,33 +4000,53 @@ Example return:
|
|
|
3657
4000
|
|
|
3658
4001
|
```json
|
|
3659
4002
|
[
|
|
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
|
-
|
|
4003
|
+
{
|
|
4004
|
+
"id": 1764,
|
|
4005
|
+
"localizeInfos": {
|
|
4006
|
+
"title": "Product"
|
|
4007
|
+
},
|
|
4008
|
+
"isVisible": true,
|
|
4009
|
+
"statusId": 1,
|
|
4010
|
+
"relatedIds": [
|
|
4011
|
+
1,
|
|
4012
|
+
2,
|
|
4013
|
+
3
|
|
4014
|
+
],
|
|
4015
|
+
"attributeSetId": 7,
|
|
4016
|
+
"isSync": true,
|
|
4017
|
+
"price": 0,
|
|
4018
|
+
"additional": {
|
|
4019
|
+
"prices": {
|
|
4020
|
+
"min": 0,
|
|
4021
|
+
"max": 100
|
|
4022
|
+
}
|
|
4023
|
+
},
|
|
4024
|
+
"blocks": [
|
|
4025
|
+
null
|
|
4026
|
+
],
|
|
4027
|
+
"sku": "0-123",
|
|
4028
|
+
"productPages": [
|
|
4029
|
+
{
|
|
4030
|
+
"id": 8997,
|
|
4031
|
+
"pageId": 1176,
|
|
4032
|
+
"productId": 8872
|
|
4033
|
+
}
|
|
4034
|
+
],
|
|
4035
|
+
"statusLocalizeInfos": {
|
|
4036
|
+
"title": "Product"
|
|
4037
|
+
},
|
|
4038
|
+
"templateIdentifier": "my-template",
|
|
4039
|
+
"shortDescTemplateIdentifier": "my-template-short",
|
|
4040
|
+
"attributeValues": {
|
|
4041
|
+
"marker": {
|
|
4042
|
+
"value": "",
|
|
4043
|
+
"type": "string",
|
|
4044
|
+
"position": 1,
|
|
4045
|
+
"isProductPreview": false
|
|
4046
|
+
}
|
|
4047
|
+
},
|
|
4048
|
+
"position": 1
|
|
4049
|
+
}
|
|
3687
4050
|
]
|
|
3688
4051
|
```
|
|
3689
4052
|
<details>
|
|
@@ -3693,6 +4056,14 @@ Example return:
|
|
|
3693
4056
|
*object identifier* <br>
|
|
3694
4057
|
example: 1764 <br>
|
|
3695
4058
|
|
|
4059
|
+
**additional:** Record<string, any> <br>
|
|
4060
|
+
*additional value from the index* <br>
|
|
4061
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4062
|
+
|
|
4063
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4064
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4065
|
+
example: { "title": "Product" <br>
|
|
4066
|
+
|
|
3696
4067
|
**localizeInfos:** Record<string, any> <br>
|
|
3697
4068
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3698
4069
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -3775,6 +4146,19 @@ Example return:
|
|
|
3775
4146
|
2,
|
|
3776
4147
|
3
|
|
3777
4148
|
],
|
|
4149
|
+
"attributeSetId": 7,
|
|
4150
|
+
"isSync": true,
|
|
4151
|
+
"price": 0,
|
|
4152
|
+
"additional": {
|
|
4153
|
+
"prices": {
|
|
4154
|
+
"min": 0,
|
|
4155
|
+
"max": 100
|
|
4156
|
+
}
|
|
4157
|
+
},
|
|
4158
|
+
"blocks": [
|
|
4159
|
+
null
|
|
4160
|
+
],
|
|
4161
|
+
"sku": "0-123",
|
|
3778
4162
|
"productPages": [
|
|
3779
4163
|
{
|
|
3780
4164
|
"id": 8997,
|
|
@@ -3782,18 +4166,17 @@ Example return:
|
|
|
3782
4166
|
"productId": 8872
|
|
3783
4167
|
}
|
|
3784
4168
|
],
|
|
3785
|
-
"
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
"isSync": 0,
|
|
3789
|
-
"price": 0,
|
|
4169
|
+
"statusLocalizeInfos": {
|
|
4170
|
+
"title": "Product"
|
|
4171
|
+
},
|
|
3790
4172
|
"templateIdentifier": "my-template",
|
|
3791
4173
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
3792
|
-
"sku": "0-123",
|
|
3793
4174
|
"attributeValues": {
|
|
3794
4175
|
"marker": {
|
|
3795
4176
|
"value": "",
|
|
3796
|
-
"type": "string"
|
|
4177
|
+
"type": "string",
|
|
4178
|
+
"position": 1,
|
|
4179
|
+
"isProductPreview": false
|
|
3797
4180
|
}
|
|
3798
4181
|
},
|
|
3799
4182
|
"position": 1
|
|
@@ -3806,6 +4189,14 @@ Example return:
|
|
|
3806
4189
|
*object identifier* <br>
|
|
3807
4190
|
example: 1764 <br>
|
|
3808
4191
|
|
|
4192
|
+
**additional:** Record<string, any> <br>
|
|
4193
|
+
*additional value from the index* <br>
|
|
4194
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4195
|
+
|
|
4196
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4197
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4198
|
+
example: { "title": "Product" <br>
|
|
4199
|
+
|
|
3809
4200
|
**localizeInfos:** Record<string, any> <br>
|
|
3810
4201
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3811
4202
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -3887,6 +4278,19 @@ Example return:
|
|
|
3887
4278
|
2,
|
|
3888
4279
|
3
|
|
3889
4280
|
],
|
|
4281
|
+
"attributeSetId": 7,
|
|
4282
|
+
"isSync": true,
|
|
4283
|
+
"price": 0,
|
|
4284
|
+
"additional": {
|
|
4285
|
+
"prices": {
|
|
4286
|
+
"min": 0,
|
|
4287
|
+
"max": 100
|
|
4288
|
+
}
|
|
4289
|
+
},
|
|
4290
|
+
"blocks": [
|
|
4291
|
+
null
|
|
4292
|
+
],
|
|
4293
|
+
"sku": "0-123",
|
|
3890
4294
|
"productPages": [
|
|
3891
4295
|
{
|
|
3892
4296
|
"id": 8997,
|
|
@@ -3894,18 +4298,17 @@ Example return:
|
|
|
3894
4298
|
"productId": 8872
|
|
3895
4299
|
}
|
|
3896
4300
|
],
|
|
3897
|
-
"
|
|
3898
|
-
|
|
3899
|
-
|
|
3900
|
-
"isSync": 0,
|
|
3901
|
-
"price": 0,
|
|
4301
|
+
"statusLocalizeInfos": {
|
|
4302
|
+
"title": "Product"
|
|
4303
|
+
},
|
|
3902
4304
|
"templateIdentifier": "my-template",
|
|
3903
4305
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
3904
|
-
"sku": "0-123",
|
|
3905
4306
|
"attributeValues": {
|
|
3906
4307
|
"marker": {
|
|
3907
4308
|
"value": "",
|
|
3908
|
-
"type": "string"
|
|
4309
|
+
"type": "string",
|
|
4310
|
+
"position": 1,
|
|
4311
|
+
"isProductPreview": false
|
|
3909
4312
|
}
|
|
3910
4313
|
},
|
|
3911
4314
|
"position": 1
|
|
@@ -3918,6 +4321,15 @@ Example return:
|
|
|
3918
4321
|
*object identifier* <br>
|
|
3919
4322
|
example: 1764 <br>
|
|
3920
4323
|
|
|
4324
|
+
**additional:** Record<string, any> <br>
|
|
4325
|
+
*additional value from the index* <br>
|
|
4326
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4327
|
+
|
|
4328
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4329
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4330
|
+
example: { "title": "Product" <br>
|
|
4331
|
+
|
|
4332
|
+
|
|
3921
4333
|
**localizeInfos:** Record<string, any> <br>
|
|
3922
4334
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3923
4335
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -4000,16 +4412,36 @@ Example return:
|
|
|
4000
4412
|
3
|
|
4001
4413
|
],
|
|
4002
4414
|
"attributeSetId": 7,
|
|
4003
|
-
"blocks": ["product_block"],
|
|
4004
4415
|
"isSync": true,
|
|
4005
4416
|
"price": 0,
|
|
4417
|
+
"additional": {
|
|
4418
|
+
"prices": {
|
|
4419
|
+
"min": 0,
|
|
4420
|
+
"max": 100
|
|
4421
|
+
}
|
|
4422
|
+
},
|
|
4423
|
+
"blocks": [
|
|
4424
|
+
null
|
|
4425
|
+
],
|
|
4426
|
+
"sku": "0-123",
|
|
4427
|
+
"productPages": [
|
|
4428
|
+
{
|
|
4429
|
+
"id": 8997,
|
|
4430
|
+
"pageId": 1176,
|
|
4431
|
+
"productId": 8872
|
|
4432
|
+
}
|
|
4433
|
+
],
|
|
4434
|
+
"statusLocalizeInfos": {
|
|
4435
|
+
"title": "Product"
|
|
4436
|
+
},
|
|
4006
4437
|
"templateIdentifier": "my-template",
|
|
4007
4438
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
4008
|
-
"sku": "0-123",
|
|
4009
4439
|
"attributeValues": {
|
|
4010
4440
|
"marker": {
|
|
4011
4441
|
"value": "",
|
|
4012
|
-
"type": "string"
|
|
4442
|
+
"type": "string",
|
|
4443
|
+
"position": 1,
|
|
4444
|
+
"isProductPreview": false
|
|
4013
4445
|
}
|
|
4014
4446
|
},
|
|
4015
4447
|
"position": 1
|
|
@@ -4022,6 +4454,14 @@ Example return:
|
|
|
4022
4454
|
*object identifier* <br>
|
|
4023
4455
|
example: 1764 <br>
|
|
4024
4456
|
|
|
4457
|
+
**additional:** Record<string, any> <br>
|
|
4458
|
+
*additional value from the index* <br>
|
|
4459
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4460
|
+
|
|
4461
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4462
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4463
|
+
example: { "title": "Product" <br>
|
|
4464
|
+
|
|
4025
4465
|
**localizeInfos:** Record<string, any> <br>
|
|
4026
4466
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
4027
4467
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -4104,16 +4544,36 @@ Example return:
|
|
|
4104
4544
|
3
|
|
4105
4545
|
],
|
|
4106
4546
|
"attributeSetId": 7,
|
|
4107
|
-
"blocks": ["product_block"],
|
|
4108
4547
|
"isSync": true,
|
|
4109
4548
|
"price": 0,
|
|
4549
|
+
"additional": {
|
|
4550
|
+
"prices": {
|
|
4551
|
+
"min": 0,
|
|
4552
|
+
"max": 100
|
|
4553
|
+
}
|
|
4554
|
+
},
|
|
4555
|
+
"blocks": [
|
|
4556
|
+
null
|
|
4557
|
+
],
|
|
4558
|
+
"sku": "0-123",
|
|
4559
|
+
"productPages": [
|
|
4560
|
+
{
|
|
4561
|
+
"id": 8997,
|
|
4562
|
+
"pageId": 1176,
|
|
4563
|
+
"productId": 8872
|
|
4564
|
+
}
|
|
4565
|
+
],
|
|
4566
|
+
"statusLocalizeInfos": {
|
|
4567
|
+
"title": "Product"
|
|
4568
|
+
},
|
|
4110
4569
|
"templateIdentifier": "my-template",
|
|
4111
4570
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
4112
|
-
"sku": "0-123",
|
|
4113
4571
|
"attributeValues": {
|
|
4114
4572
|
"marker": {
|
|
4115
4573
|
"value": "",
|
|
4116
|
-
"type": "string"
|
|
4574
|
+
"type": "string",
|
|
4575
|
+
"position": 1,
|
|
4576
|
+
"isProductPreview": false
|
|
4117
4577
|
}
|
|
4118
4578
|
},
|
|
4119
4579
|
"position": 1
|
|
@@ -4126,6 +4586,14 @@ Example return:
|
|
|
4126
4586
|
*object identifier* <br>
|
|
4127
4587
|
example: 1764 <br>
|
|
4128
4588
|
|
|
4589
|
+
**additional:** Record<string, any> <br>
|
|
4590
|
+
*additional value from the index* <br>
|
|
4591
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4592
|
+
|
|
4593
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4594
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4595
|
+
example: { "title": "Product" <br>
|
|
4596
|
+
|
|
4129
4597
|
**localizeInfos:** Record<string, any> <br>
|
|
4130
4598
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
4131
4599
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -4233,6 +4701,19 @@ Example return:
|
|
|
4233
4701
|
2,
|
|
4234
4702
|
3
|
|
4235
4703
|
],
|
|
4704
|
+
"attributeSetId": 7,
|
|
4705
|
+
"isSync": true,
|
|
4706
|
+
"price": 0,
|
|
4707
|
+
"additional": {
|
|
4708
|
+
"prices": {
|
|
4709
|
+
"min": 0,
|
|
4710
|
+
"max": 100
|
|
4711
|
+
}
|
|
4712
|
+
},
|
|
4713
|
+
"blocks": [
|
|
4714
|
+
null
|
|
4715
|
+
],
|
|
4716
|
+
"sku": "0-123",
|
|
4236
4717
|
"productPages": [
|
|
4237
4718
|
{
|
|
4238
4719
|
"id": 8997,
|
|
@@ -4240,18 +4721,17 @@ Example return:
|
|
|
4240
4721
|
"productId": 8872
|
|
4241
4722
|
}
|
|
4242
4723
|
],
|
|
4243
|
-
"
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
"isSync": 0,
|
|
4247
|
-
"price": 0,
|
|
4724
|
+
"statusLocalizeInfos": {
|
|
4725
|
+
"title": "Product"
|
|
4726
|
+
},
|
|
4248
4727
|
"templateIdentifier": "my-template",
|
|
4249
4728
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
4250
|
-
"sku": "0-123",
|
|
4251
4729
|
"attributeValues": {
|
|
4252
4730
|
"marker": {
|
|
4253
4731
|
"value": "",
|
|
4254
|
-
"type": "string"
|
|
4732
|
+
"type": "string",
|
|
4733
|
+
"position": 1,
|
|
4734
|
+
"isProductPreview": false
|
|
4255
4735
|
}
|
|
4256
4736
|
},
|
|
4257
4737
|
"position": 1
|
|
@@ -4264,6 +4744,14 @@ Example return:
|
|
|
4264
4744
|
*object identifier* <br>
|
|
4265
4745
|
example: 1764 <br>
|
|
4266
4746
|
|
|
4747
|
+
**additional:** Record<string, any> <br>
|
|
4748
|
+
*additional value from the index* <br>
|
|
4749
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4750
|
+
|
|
4751
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4752
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4753
|
+
example: { "title": "Product" <br>
|
|
4754
|
+
|
|
4267
4755
|
**localizeInfos:** Record<string, any> <br>
|
|
4268
4756
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
4269
4757
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -4335,40 +4823,52 @@ Example return:
|
|
|
4335
4823
|
```json
|
|
4336
4824
|
[
|
|
4337
4825
|
{
|
|
4338
|
-
|
|
4339
|
-
|
|
4340
|
-
|
|
4341
|
-
|
|
4342
|
-
|
|
4343
|
-
|
|
4344
|
-
|
|
4345
|
-
|
|
4346
|
-
|
|
4347
|
-
|
|
4348
|
-
|
|
4349
|
-
|
|
4350
|
-
|
|
4351
|
-
|
|
4352
|
-
|
|
4353
|
-
"
|
|
4354
|
-
|
|
4355
|
-
|
|
4356
|
-
|
|
4357
|
-
|
|
4358
|
-
|
|
4359
|
-
|
|
4360
|
-
|
|
4361
|
-
"templateIdentifier": "my-template",
|
|
4362
|
-
"shortDescTemplateIdentifier": "my-template-short",
|
|
4826
|
+
"id": 1764,
|
|
4827
|
+
"localizeInfos": {
|
|
4828
|
+
"title": "Product"
|
|
4829
|
+
},
|
|
4830
|
+
"isVisible": true,
|
|
4831
|
+
"statusId": 1,
|
|
4832
|
+
"relatedIds": [
|
|
4833
|
+
1,
|
|
4834
|
+
2,
|
|
4835
|
+
3
|
|
4836
|
+
],
|
|
4837
|
+
"attributeSetId": 7,
|
|
4838
|
+
"isSync": true,
|
|
4839
|
+
"price": 0,
|
|
4840
|
+
"additional": {
|
|
4841
|
+
"prices": {
|
|
4842
|
+
"min": 0,
|
|
4843
|
+
"max": 100
|
|
4844
|
+
}
|
|
4845
|
+
},
|
|
4846
|
+
"blocks": [
|
|
4847
|
+
null
|
|
4848
|
+
],
|
|
4363
4849
|
"sku": "0-123",
|
|
4850
|
+
"productPages": [
|
|
4851
|
+
{
|
|
4852
|
+
"id": 8997,
|
|
4853
|
+
"pageId": 1176,
|
|
4854
|
+
"productId": 8872
|
|
4855
|
+
}
|
|
4856
|
+
],
|
|
4857
|
+
"statusLocalizeInfos": {
|
|
4858
|
+
"title": "Product"
|
|
4859
|
+
},
|
|
4860
|
+
"templateIdentifier": "my-template",
|
|
4861
|
+
"shortDescTemplateIdentifier": "my-template-short",
|
|
4364
4862
|
"attributeValues": {
|
|
4365
|
-
|
|
4366
|
-
|
|
4367
|
-
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
|
|
4371
|
-
}
|
|
4863
|
+
"marker": {
|
|
4864
|
+
"value": "",
|
|
4865
|
+
"type": "string",
|
|
4866
|
+
"position": 1,
|
|
4867
|
+
"isProductPreview": false
|
|
4868
|
+
}
|
|
4869
|
+
},
|
|
4870
|
+
"position": 1
|
|
4871
|
+
}
|
|
4372
4872
|
]
|
|
4373
4873
|
```
|
|
4374
4874
|
<details>
|
|
@@ -4378,6 +4878,14 @@ Example return:
|
|
|
4378
4878
|
*object identifier* <br>
|
|
4379
4879
|
example: 1764 <br>
|
|
4380
4880
|
|
|
4881
|
+
**additional:** Record<string, any> <br>
|
|
4882
|
+
*additional value from the index* <br>
|
|
4883
|
+
example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
|
|
4884
|
+
|
|
4885
|
+
**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
4886
|
+
*json description of the item status object, taking into account the language* <br>
|
|
4887
|
+
example: { "title": "Product" <br>
|
|
4888
|
+
|
|
4381
4889
|
**localizeInfos:** Record<string, any> <br>
|
|
4382
4890
|
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
4383
4891
|
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
@@ -4634,22 +5142,20 @@ Example return:
|
|
|
4634
5142
|
|
|
4635
5143
|
```json
|
|
4636
5144
|
[
|
|
4637
|
-
|
|
4638
|
-
|
|
4639
|
-
|
|
4640
|
-
|
|
4641
|
-
|
|
4642
|
-
|
|
4643
|
-
|
|
4644
|
-
|
|
4645
|
-
|
|
4646
|
-
|
|
4647
|
-
|
|
4648
|
-
|
|
4649
|
-
|
|
4650
|
-
|
|
4651
|
-
"positionId": 12,
|
|
4652
|
-
"generalTypeName": "forProductPreview"
|
|
5145
|
+
{
|
|
5146
|
+
"id": 1764,
|
|
5147
|
+
"updatedDate": "2024-05-25T23:50:35.154Z",
|
|
5148
|
+
"version": 10,
|
|
5149
|
+
"identifier": "marker",
|
|
5150
|
+
"generalType": {
|
|
5151
|
+
"id": 4,
|
|
5152
|
+
"type": "forCatalogPages"
|
|
5153
|
+
},
|
|
5154
|
+
"generalTypeId": 4,
|
|
5155
|
+
"title": "Page template",
|
|
5156
|
+
"position": 0,
|
|
5157
|
+
"positionId": 12,
|
|
5158
|
+
"generalTypeName": "forProductPreview"
|
|
4653
5159
|
}
|
|
4654
5160
|
]
|
|
4655
5161
|
```
|
|
@@ -4679,9 +5185,9 @@ example: OrderedMap { "id": 4, "type": "forCatalogPages" } <br>
|
|
|
4679
5185
|
*type identifier* <br>
|
|
4680
5186
|
example: 4 <br>
|
|
4681
5187
|
|
|
4682
|
-
**
|
|
4683
|
-
*
|
|
4684
|
-
example:
|
|
5188
|
+
**title:** string<br>
|
|
5189
|
+
*template name* <br>
|
|
5190
|
+
example: page template <br>
|
|
4685
5191
|
|
|
4686
5192
|
**position** object <br>
|
|
4687
5193
|
*position number* <br>
|
|
@@ -4712,7 +5218,7 @@ Example return:
|
|
|
4712
5218
|
[
|
|
4713
5219
|
{
|
|
4714
5220
|
"id": 1764,
|
|
4715
|
-
"updatedDate": "
|
|
5221
|
+
"updatedDate": "2024-05-25T23:50:35.154Z",
|
|
4716
5222
|
"version": 10,
|
|
4717
5223
|
"identifier": "marker",
|
|
4718
5224
|
"generalType": {
|
|
@@ -4720,9 +5226,7 @@ Example return:
|
|
|
4720
5226
|
"type": "forCatalogPages"
|
|
4721
5227
|
},
|
|
4722
5228
|
"generalTypeId": 4,
|
|
4723
|
-
"
|
|
4724
|
-
"title": "Page template"
|
|
4725
|
-
},
|
|
5229
|
+
"title": "Page template",
|
|
4726
5230
|
"position": 0,
|
|
4727
5231
|
"positionId": 12,
|
|
4728
5232
|
"generalTypeName": "forProductPreview"
|
|
@@ -4755,14 +5259,87 @@ example: OrderedMap { "id": 4, "type": "forCatalogPages" } <br>
|
|
|
4755
5259
|
*type identifier* <br>
|
|
4756
5260
|
example: 4 <br>
|
|
4757
5261
|
|
|
4758
|
-
**
|
|
4759
|
-
*
|
|
4760
|
-
example:
|
|
5262
|
+
**title:** string<br>
|
|
5263
|
+
*template name* <br>
|
|
5264
|
+
example: page template <br>
|
|
4761
5265
|
|
|
4762
5266
|
**position** object <br>
|
|
4763
5267
|
*position number* <br>
|
|
4764
5268
|
example: 0 <br>
|
|
4765
5269
|
|
|
5270
|
+
**positionId:** number <br>
|
|
5271
|
+
*position object identifier* <br>
|
|
5272
|
+
example: 12 <br>
|
|
5273
|
+
|
|
5274
|
+
**generalTypeName** string <br>
|
|
5275
|
+
*example: forProductPreview* <br>
|
|
5276
|
+
general type name <br>
|
|
5277
|
+
|
|
5278
|
+
</details>
|
|
5279
|
+
|
|
5280
|
+
|
|
5281
|
+
### Templates.getTemplateById(id)
|
|
5282
|
+
|
|
5283
|
+
```js
|
|
5284
|
+
const value = await Templates.getTemplateById(1)
|
|
5285
|
+
```
|
|
5286
|
+
|
|
5287
|
+
> This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a template object.
|
|
5288
|
+
|
|
5289
|
+
Example return:
|
|
5290
|
+
|
|
5291
|
+
```json
|
|
5292
|
+
[
|
|
5293
|
+
{
|
|
5294
|
+
"id": 1764,
|
|
5295
|
+
"updatedDate": "2024-05-25T23:50:35.154Z",
|
|
5296
|
+
"version": 10,
|
|
5297
|
+
"identifier": "marker",
|
|
5298
|
+
"generalType": {
|
|
5299
|
+
"id": 4,
|
|
5300
|
+
"type": "forCatalogPages"
|
|
5301
|
+
},
|
|
5302
|
+
"generalTypeId": 4,
|
|
5303
|
+
"title": "Page template",
|
|
5304
|
+
"position": 0,
|
|
5305
|
+
"positionId": 12,
|
|
5306
|
+
"generalTypeName": "forProductPreview"
|
|
5307
|
+
}
|
|
5308
|
+
]
|
|
5309
|
+
```
|
|
5310
|
+
<details>
|
|
5311
|
+
<summary>Schema</summary>
|
|
5312
|
+
|
|
5313
|
+
**id:** number <br>
|
|
5314
|
+
*object identifier* <br>
|
|
5315
|
+
example: 1764 <br>
|
|
5316
|
+
|
|
5317
|
+
**updatedDate:** string($date-time) <br>
|
|
5318
|
+
*object's date of modification* <br>
|
|
5319
|
+
|
|
5320
|
+
**version** number <br>
|
|
5321
|
+
*object's version number of modification* <br>
|
|
5322
|
+
example: 10 <br>
|
|
5323
|
+
|
|
5324
|
+
**identifier:** string <br>
|
|
5325
|
+
*textual identifier for a field in the record* <br>
|
|
5326
|
+
example: catalog <br>
|
|
5327
|
+
|
|
5328
|
+
**generalType:**: object <br>
|
|
5329
|
+
*object type* <br>
|
|
5330
|
+
example: OrderedMap { "id": 4, "type": "forCatalogPages" } <br>
|
|
5331
|
+
|
|
5332
|
+
**generalTypeId:** number <br>
|
|
5333
|
+
*type identifier* <br>
|
|
5334
|
+
example: 4 <br>
|
|
5335
|
+
|
|
5336
|
+
**title:** string<br>
|
|
5337
|
+
*template name* <br>
|
|
5338
|
+
example: page template <br>
|
|
5339
|
+
|
|
5340
|
+
**position** object <br>
|
|
5341
|
+
*position number* <br>
|
|
5342
|
+
example: 0 <br>
|
|
4766
5343
|
|
|
4767
5344
|
**positionId:** number <br>
|
|
4768
5345
|
*position object identifier* <br>
|
|
@@ -4823,9 +5400,7 @@ Example return:
|
|
|
4823
5400
|
"alignmentType": "center"
|
|
4824
5401
|
}
|
|
4825
5402
|
},
|
|
4826
|
-
"
|
|
4827
|
-
"title": "Page Template"
|
|
4828
|
-
},
|
|
5403
|
+
"title": "Page Template",
|
|
4829
5404
|
"position": 0
|
|
4830
5405
|
}
|
|
4831
5406
|
]
|
|
@@ -4852,9 +5427,9 @@ example: catalog <br>
|
|
|
4852
5427
|
*template proportion parameters* <br>
|
|
4853
5428
|
example: OrderedMap { "horizontal": OrderedMap { "height": 200, "weight": 10, "marker": "horizontal", "title": "Horizontal", "alignmentType": "left" }, "vertical": OrderedMap { "height": 10, "weight": 200, "marker": "vertical", "title": "Vertical", "alignmentType": "left" }, "square": OrderedMap { "marker": "square", "title": "Square", "slide": 3, "alignmentType": "center" } } <br>
|
|
4854
5429
|
|
|
4855
|
-
**
|
|
4856
|
-
*
|
|
4857
|
-
example:
|
|
5430
|
+
**title:** string<br>
|
|
5431
|
+
*template name* <br>
|
|
5432
|
+
example: page template <br>
|
|
4858
5433
|
|
|
4859
5434
|
**position** object <br>
|
|
4860
5435
|
*position number* <br>
|
|
@@ -4906,9 +5481,7 @@ Example return:
|
|
|
4906
5481
|
"alignmentType": "center"
|
|
4907
5482
|
}
|
|
4908
5483
|
},
|
|
4909
|
-
"
|
|
4910
|
-
"title": "Page Template"
|
|
4911
|
-
},
|
|
5484
|
+
"title": "Page Template",
|
|
4912
5485
|
"position": 0
|
|
4913
5486
|
}
|
|
4914
5487
|
```
|
|
@@ -4934,9 +5507,9 @@ example: catalog <br>
|
|
|
4934
5507
|
*template proportion parameters* <br>
|
|
4935
5508
|
example: OrderedMap { "horizontal": OrderedMap { "height": 200, "weight": 10, "marker": "horizontal", "title": "Horizontal", "alignmentType": "left" }, "vertical": OrderedMap { "height": 10, "weight": 200, "marker": "vertical", "title": "Vertical", "alignmentType": "left" }, "square": OrderedMap { "marker": "square", "title": "Square", "slide": 3, "alignmentType": "center" } } <br>
|
|
4936
5509
|
|
|
4937
|
-
**
|
|
4938
|
-
*
|
|
4939
|
-
example:
|
|
5510
|
+
**title:** string<br>
|
|
5511
|
+
*template name* <br>
|
|
5512
|
+
example: page template <br>
|
|
4940
5513
|
|
|
4941
5514
|
**position** object <br>
|
|
4942
5515
|
*position number* <br>
|
|
@@ -4987,9 +5560,7 @@ Example return:
|
|
|
4987
5560
|
"alignmentType": "center"
|
|
4988
5561
|
}
|
|
4989
5562
|
},
|
|
4990
|
-
"
|
|
4991
|
-
"title": "Page Template"
|
|
4992
|
-
},
|
|
5563
|
+
"title": "Page Template",
|
|
4993
5564
|
"position": 0
|
|
4994
5565
|
}
|
|
4995
5566
|
```
|
|
@@ -5015,9 +5586,9 @@ example: catalog <br>
|
|
|
5015
5586
|
*template proportion parameters* <br>
|
|
5016
5587
|
example: OrderedMap { "horizontal": OrderedMap { "height": 200, "weight": 10, "marker": "horizontal", "title": "Horizontal", "alignmentType": "left" }, "vertical": OrderedMap { "height": 10, "weight": 200, "marker": "vertical", "title": "Vertical", "alignmentType": "left" }, "square": OrderedMap { "marker": "square", "title": "Square", "slide": 3, "alignmentType": "center" } } <br>
|
|
5017
5588
|
|
|
5018
|
-
**
|
|
5019
|
-
*
|
|
5020
|
-
example:
|
|
5589
|
+
**title:** string<br>
|
|
5590
|
+
*template name* <br>
|
|
5591
|
+
example: page template <br>
|
|
5021
5592
|
|
|
5022
5593
|
**position** object <br>
|
|
5023
5594
|
*position number* <br>
|
|
@@ -5032,7 +5603,7 @@ example: 12 <br>
|
|
|
5032
5603
|
---
|
|
5033
5604
|
|
|
5034
5605
|
|
|
5035
|
-
## <h2 id="
|
|
5606
|
+
## <h2 id="users"> Users </h2>
|
|
5036
5607
|
|
|
5037
5608
|
|
|
5038
5609
|
```js
|