oneentry 1.0.35 → 1.0.38
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 +1966 -395
- package/dist/admins/adminsApi.js +1 -1
- package/dist/attribute-sets/attributeSetsApi.d.ts +2 -2
- package/dist/attribute-sets/attributeSetsApi.js +3 -3
- package/dist/base/oneEntry.js +7 -1
- package/dist/base/utils.d.ts +1 -1
- package/dist/blocks/blocksApi.js +1 -1
- package/dist/forms/formsApi.js +2 -2
- package/dist/formsData/formsDataApi.js +3 -3
- package/dist/index.d.ts +2 -0
- package/dist/index.js +3 -0
- package/dist/markers/markersApi.d.ts +18 -20
- package/dist/markers/markersApi.js +24 -42
- package/dist/markers/markersInterfaces.d.ts +28 -6
- package/dist/markers/markersInterfaces.js +0 -1
- package/dist/menus/menusApi.js +13 -4
- package/dist/menus/menusInterfaces.d.ts +4 -4
- package/dist/pages/pagesApi.d.ts +9 -9
- package/dist/pages/pagesApi.js +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,6 +33,7 @@ const {
|
|
|
33
33
|
FileUploading,
|
|
34
34
|
GeneralTypes,
|
|
35
35
|
Locales,
|
|
36
|
+
Markers,
|
|
36
37
|
Menus,
|
|
37
38
|
Pages,
|
|
38
39
|
Products,
|
|
@@ -59,6 +60,7 @@ You can get a token as follows
|
|
|
59
60
|
5) Log in to the project, go to the settings section and open the token tab
|
|
60
61
|
6) Get and copy the token of your project
|
|
61
62
|
|
|
63
|
+
Also, you can connect a tls certificate to secure your project. In this case, do not transfer the "token" at all.
|
|
62
64
|
[Learn more about security](https://oneentry.ru/instructions.html#START)
|
|
63
65
|
|
|
64
66
|
|
|
@@ -85,9 +87,8 @@ const value = await Admins.getAdminsInfo('en_US', 0, 30)
|
|
|
85
87
|
|
|
86
88
|
> This method retrieves all user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.
|
|
87
89
|
|
|
88
|
-
<details>
|
|
89
90
|
|
|
90
|
-
|
|
91
|
+
Example return:
|
|
91
92
|
|
|
92
93
|
```json
|
|
93
94
|
[
|
|
@@ -97,17 +98,43 @@ const value = await Admins.getAdminsInfo('en_US', 0, 30)
|
|
|
97
98
|
"attributeSetId": 7,
|
|
98
99
|
"isSync": false,
|
|
99
100
|
"attributeValues": {
|
|
100
|
-
"
|
|
101
|
-
"
|
|
102
|
-
|
|
103
|
-
"type": "string"
|
|
104
|
-
}
|
|
101
|
+
"marker": {
|
|
102
|
+
"value": "",
|
|
103
|
+
"type": "string"
|
|
105
104
|
}
|
|
106
105
|
},
|
|
107
106
|
"position": 192
|
|
108
107
|
}
|
|
109
108
|
]
|
|
110
109
|
```
|
|
110
|
+
<details>
|
|
111
|
+
<summary>Schema</summary>
|
|
112
|
+
|
|
113
|
+
**id:** number <br>
|
|
114
|
+
*object identifier*
|
|
115
|
+
example: 1764 <br>
|
|
116
|
+
|
|
117
|
+
**identifier:** string <br>
|
|
118
|
+
*textual identifier for the record field* <br>
|
|
119
|
+
example: admin1 <br>
|
|
120
|
+
default: admin1 <br>
|
|
121
|
+
|
|
122
|
+
**attributeSetId:** number <br>
|
|
123
|
+
*Attribute set identifier* <br>
|
|
124
|
+
example: 7
|
|
125
|
+
|
|
126
|
+
**isSync** boolean <br>
|
|
127
|
+
*Page indexing flag (true or false)* <br>
|
|
128
|
+
example: false
|
|
129
|
+
|
|
130
|
+
**attributeValues:** Record<string, string> <br>
|
|
131
|
+
*Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value)* <br>
|
|
132
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
|
|
133
|
+
|
|
134
|
+
**position:** number <br>
|
|
135
|
+
*Position number (for sorting)* <br>
|
|
136
|
+
example: 192
|
|
137
|
+
|
|
111
138
|
</details>
|
|
112
139
|
|
|
113
140
|
---
|
|
@@ -128,9 +155,8 @@ const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')
|
|
|
128
155
|
|
|
129
156
|
> This method return all attributes with data from the attribute sets.
|
|
130
157
|
|
|
131
|
-
<details>
|
|
132
158
|
|
|
133
|
-
|
|
159
|
+
Example return:
|
|
134
160
|
|
|
135
161
|
|
|
136
162
|
```json
|
|
@@ -169,8 +195,37 @@ const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')
|
|
|
169
195
|
}
|
|
170
196
|
]
|
|
171
197
|
```
|
|
172
|
-
</details>
|
|
173
198
|
|
|
199
|
+
<details>
|
|
200
|
+
<summary>Schema</summary>
|
|
201
|
+
|
|
202
|
+
**type:** string <br>
|
|
203
|
+
*attribute type* <br>
|
|
204
|
+
example: list <br>
|
|
205
|
+
|
|
206
|
+
**marker:** string <br>
|
|
207
|
+
*textual identifier of the attribute (marker)* <br>
|
|
208
|
+
Enum:
|
|
209
|
+
[ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ]
|
|
210
|
+
example: list1
|
|
211
|
+
|
|
212
|
+
**position:** number <br>
|
|
213
|
+
*position number for sorting* <br>
|
|
214
|
+
example: 192 <br>
|
|
215
|
+
|
|
216
|
+
**validators:** Record<string, any> <br>
|
|
217
|
+
*set of validators for validation* <br>
|
|
218
|
+
example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }
|
|
219
|
+
|
|
220
|
+
**localizeInfos:** Record<string, any> <br>
|
|
221
|
+
*localization data for the set (name)* <br>
|
|
222
|
+
example: OrderedMap { "title": "My attribute" } <br>
|
|
223
|
+
|
|
224
|
+
**listTitles** Record<string, any> <br>
|
|
225
|
+
*array of values (with extended data) for list and radioButton attributes* <br>
|
|
226
|
+
example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ]
|
|
227
|
+
|
|
228
|
+
</details>
|
|
174
229
|
|
|
175
230
|
|
|
176
231
|
### AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)
|
|
@@ -181,9 +236,8 @@ const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1
|
|
|
181
236
|
|
|
182
237
|
> This method return a single attribute with data from the attribute sets.
|
|
183
238
|
|
|
184
|
-
<details>
|
|
185
239
|
|
|
186
|
-
|
|
240
|
+
Example return:
|
|
187
241
|
|
|
188
242
|
```json
|
|
189
243
|
{
|
|
@@ -219,13 +273,41 @@ const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1
|
|
|
219
273
|
]
|
|
220
274
|
}
|
|
221
275
|
```
|
|
276
|
+
<details>
|
|
277
|
+
<summary>Schema</summary>
|
|
278
|
+
|
|
279
|
+
**type:** string <br>
|
|
280
|
+
*attribute type* <br>
|
|
281
|
+
example: list <br>
|
|
282
|
+
|
|
283
|
+
**marker:** string <br>
|
|
284
|
+
*textual identifier of the attribute (marker)* <br>
|
|
285
|
+
Enum:
|
|
286
|
+
[ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ]
|
|
287
|
+
example: list1
|
|
288
|
+
|
|
289
|
+
**position:** number <br>
|
|
290
|
+
*position number for sorting* <br>
|
|
291
|
+
example: 192 <br>
|
|
292
|
+
|
|
293
|
+
**validators:** Record<string, any> <br>
|
|
294
|
+
*set of validators for validation* <br>
|
|
295
|
+
example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }
|
|
296
|
+
|
|
297
|
+
**localizeInfos:** Record<string, any> <br>
|
|
298
|
+
*localization data for the set (name)* <br>
|
|
299
|
+
example: OrderedMap { "title": "My attribute" } <br>
|
|
300
|
+
|
|
301
|
+
**listTitles** Record<string, any> <br>
|
|
302
|
+
*array of values (with extended data) for list and radioButton attributes* <br>
|
|
303
|
+
example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ]
|
|
304
|
+
|
|
222
305
|
</details>
|
|
223
306
|
|
|
224
307
|
---
|
|
225
308
|
|
|
226
309
|
|
|
227
310
|
|
|
228
|
-
|
|
229
311
|
## Blocks
|
|
230
312
|
|
|
231
313
|
```js
|
|
@@ -240,18 +322,14 @@ const value = await Blocks.getBlockByMarker('my-marker', 'en_US')
|
|
|
240
322
|
|
|
241
323
|
> This method return one blocks object by marker.
|
|
242
324
|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
<summary>Example return:</summary>
|
|
325
|
+
Example return:
|
|
246
326
|
|
|
247
327
|
```json
|
|
248
328
|
{
|
|
249
329
|
"id": 1764,
|
|
250
330
|
"attributeSetId": 7,
|
|
251
331
|
"localizeInfos": {
|
|
252
|
-
"
|
|
253
|
-
"title": "My block"
|
|
254
|
-
}
|
|
332
|
+
"title": "My block"
|
|
255
333
|
},
|
|
256
334
|
"customSettings": {
|
|
257
335
|
"sliderDelay": 0,
|
|
@@ -273,21 +351,64 @@ const value = await Blocks.getBlockByMarker('my-marker', 'en_US')
|
|
|
273
351
|
"identifier": "catalog",
|
|
274
352
|
"position": 192,
|
|
275
353
|
"attributeValues": {
|
|
276
|
-
"
|
|
277
|
-
"
|
|
278
|
-
|
|
279
|
-
"type": "string"
|
|
280
|
-
}
|
|
354
|
+
"marker": {
|
|
355
|
+
"value": "",
|
|
356
|
+
"type": "string"
|
|
281
357
|
}
|
|
282
358
|
},
|
|
283
359
|
"type": "forNewsPage",
|
|
284
360
|
"templateIdentifier": null
|
|
285
361
|
}
|
|
286
362
|
```
|
|
287
|
-
</details>
|
|
288
363
|
|
|
289
|
-
|
|
364
|
+
<details>
|
|
365
|
+
<summary>Schema</summary>
|
|
366
|
+
|
|
367
|
+
**id:** number <br>
|
|
368
|
+
*object identifier*
|
|
369
|
+
example: 1764 <br>
|
|
370
|
+
|
|
371
|
+
**attributeSetId:** number <br>
|
|
372
|
+
*identifier for the used attribute set* <br>
|
|
373
|
+
example: 7
|
|
374
|
+
|
|
375
|
+
**localizeInfos:** CommonLocalizeInfos <br>
|
|
376
|
+
*block name with localization* <br>
|
|
377
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "My block" } }
|
|
378
|
+
|
|
379
|
+
**customSettings:** BlockCustomSettings <br>
|
|
380
|
+
*custom settings for different block types* <br>
|
|
381
|
+
example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] }
|
|
382
|
+
|
|
383
|
+
**version:** number <br>
|
|
384
|
+
*object version number* <br>
|
|
385
|
+
example: 10
|
|
290
386
|
|
|
387
|
+
**identifier:** string <br>
|
|
388
|
+
*textual identifier for the field record* <br>
|
|
389
|
+
example: catalog <br>
|
|
390
|
+
default: marker
|
|
391
|
+
|
|
392
|
+
**position:** number <br>
|
|
393
|
+
*position number (for sorting)* <br>
|
|
394
|
+
example: 192
|
|
395
|
+
|
|
396
|
+
**attributeValues:** Record<string, string> <br>
|
|
397
|
+
*array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
398
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
399
|
+
|
|
400
|
+
**type:** string <br>
|
|
401
|
+
*block type* <br>
|
|
402
|
+
example: forNewsPage
|
|
403
|
+
|
|
404
|
+
**templateIdentifier:** string <br>
|
|
405
|
+
*template marker used by the block (can be null)* <br>
|
|
406
|
+
Enum:
|
|
407
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
408
|
+
example: null
|
|
409
|
+
|
|
410
|
+
</details>
|
|
411
|
+
---
|
|
291
412
|
|
|
292
413
|
|
|
293
414
|
|
|
@@ -314,9 +435,7 @@ const value = await FileUploading.upload(data, query)
|
|
|
314
435
|
> This method uploads a file to a cloud file storage. Pass to the date the value obtained from input type "file".
|
|
315
436
|
> Data is file object (or array), learn more - [File Object](https://developer.mozilla.org/en-US/docs/Web/API/File)
|
|
316
437
|
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
<summary>Example return:</summary>
|
|
438
|
+
Example return:
|
|
320
439
|
|
|
321
440
|
```json
|
|
322
441
|
[
|
|
@@ -327,8 +446,20 @@ const value = await FileUploading.upload(data, query)
|
|
|
327
446
|
}
|
|
328
447
|
]
|
|
329
448
|
```
|
|
330
|
-
</details>
|
|
331
449
|
|
|
450
|
+
<details>
|
|
451
|
+
<summary>Schema</summary>
|
|
452
|
+
|
|
453
|
+
**filename:** string <br>
|
|
454
|
+
*filename with relative path*
|
|
455
|
+
|
|
456
|
+
**downloadLink:** string <br>
|
|
457
|
+
*link for downloading the file*
|
|
458
|
+
|
|
459
|
+
**size** number <br>
|
|
460
|
+
*size of the file in bytes*
|
|
461
|
+
|
|
462
|
+
</details>
|
|
332
463
|
|
|
333
464
|
### FileUploading.delete(filename, fileQuery)
|
|
334
465
|
|
|
@@ -353,16 +484,13 @@ const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
|
|
|
353
484
|
|
|
354
485
|
> This method return file object by parameters.
|
|
355
486
|
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
<summary>Example return:</summary>
|
|
487
|
+
Example return:
|
|
359
488
|
|
|
360
489
|
```json
|
|
361
490
|
{
|
|
362
491
|
"file": "string"
|
|
363
492
|
}
|
|
364
493
|
```
|
|
365
|
-
</details>
|
|
366
494
|
|
|
367
495
|
---
|
|
368
496
|
|
|
@@ -381,9 +509,7 @@ const value = await Forms.getAllForms('en_US', 0, 30)
|
|
|
381
509
|
|
|
382
510
|
> This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.
|
|
383
511
|
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
<summary>Example return:</summary>
|
|
512
|
+
Example return:
|
|
387
513
|
|
|
388
514
|
```json
|
|
389
515
|
[
|
|
@@ -392,15 +518,13 @@ const value = await Forms.getAllForms('en_US', 0, 30)
|
|
|
392
518
|
"attributeSetId": 0,
|
|
393
519
|
"processingType": "email",
|
|
394
520
|
"localizeInfos": {
|
|
395
|
-
"
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
"script": "0"
|
|
403
|
-
}
|
|
521
|
+
"title": "My Form",
|
|
522
|
+
"titleForSite": "",
|
|
523
|
+
"successMessage": "",
|
|
524
|
+
"unsuccessMessage": "",
|
|
525
|
+
"urlAddress": "",
|
|
526
|
+
"database": "0",
|
|
527
|
+
"script": "0"
|
|
404
528
|
},
|
|
405
529
|
"processingData": "Unknown Type: ProcessingData",
|
|
406
530
|
"version": 10,
|
|
@@ -436,8 +560,47 @@ const value = await Forms.getAllForms('en_US', 0, 30)
|
|
|
436
560
|
}
|
|
437
561
|
]
|
|
438
562
|
```
|
|
439
|
-
|
|
563
|
+
<details>
|
|
564
|
+
<summary>Schema</summary>
|
|
565
|
+
|
|
566
|
+
**id:** number <br>
|
|
567
|
+
*object identifier* <br>
|
|
568
|
+
example: 1764
|
|
569
|
+
|
|
570
|
+
**attributeSetId:** number <br>
|
|
571
|
+
*identifier of the attribute set used* <br>
|
|
572
|
+
|
|
573
|
+
**processingType:** string <br>
|
|
574
|
+
*form processing type* <br>
|
|
575
|
+
example: email
|
|
576
|
+
|
|
577
|
+
**localizeInfos:** FormLocalizeInfos <br>
|
|
578
|
+
*form name with localization* <br>
|
|
579
|
+
Enum:
|
|
580
|
+
[ db, email, script ]
|
|
581
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }
|
|
582
|
+
|
|
583
|
+
**processingData:** ProcessingData <br>
|
|
584
|
+
*form data*
|
|
585
|
+
|
|
586
|
+
**version:** number <br>
|
|
587
|
+
*object version number* <br>
|
|
588
|
+
example: 10
|
|
589
|
+
|
|
590
|
+
**identifier:** string <br>
|
|
591
|
+
*textual identifier for the record field* <br>
|
|
592
|
+
example: catalog
|
|
593
|
+
default: marker
|
|
594
|
+
|
|
595
|
+
**position:** number <br>
|
|
596
|
+
*position number (for sorting)* <br>
|
|
597
|
+
example: 192
|
|
598
|
+
|
|
599
|
+
**attributes:** <br>
|
|
600
|
+
*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
|
|
601
|
+
example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]
|
|
440
602
|
|
|
603
|
+
</details>
|
|
441
604
|
|
|
442
605
|
|
|
443
606
|
### Forms.getFormByMarker(marker, langCode)
|
|
@@ -448,9 +611,7 @@ const value = await Forms.getFormByMarker('My form', 'en_US')
|
|
|
448
611
|
|
|
449
612
|
> This method retrieves a single form object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a FormEntity object.
|
|
450
613
|
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
<summary>Example return:</summary>
|
|
614
|
+
Example return:
|
|
454
615
|
|
|
455
616
|
```json
|
|
456
617
|
{
|
|
@@ -458,15 +619,13 @@ const value = await Forms.getFormByMarker('My form', 'en_US')
|
|
|
458
619
|
"attributeSetId": 0,
|
|
459
620
|
"processingType": "email",
|
|
460
621
|
"localizeInfos": {
|
|
461
|
-
"
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
"script": "0"
|
|
469
|
-
}
|
|
622
|
+
"title": "My Form",
|
|
623
|
+
"titleForSite": "",
|
|
624
|
+
"successMessage": "",
|
|
625
|
+
"unsuccessMessage": "",
|
|
626
|
+
"urlAddress": "",
|
|
627
|
+
"database": "0",
|
|
628
|
+
"script": "0"
|
|
470
629
|
},
|
|
471
630
|
"processingData": "Unknown Type: ProcessingData",
|
|
472
631
|
"version": 10,
|
|
@@ -501,6 +660,46 @@ const value = await Forms.getFormByMarker('My form', 'en_US')
|
|
|
501
660
|
]
|
|
502
661
|
}
|
|
503
662
|
```
|
|
663
|
+
<details>
|
|
664
|
+
<summary>Schema</summary>
|
|
665
|
+
|
|
666
|
+
**id:** number <br>
|
|
667
|
+
*object identifier* <br>
|
|
668
|
+
example: 1764
|
|
669
|
+
|
|
670
|
+
**attributeSetId:** number <br>
|
|
671
|
+
*identifier of the attribute set used* <br>
|
|
672
|
+
|
|
673
|
+
**processingType:** string <br>
|
|
674
|
+
*form processing type* <br>
|
|
675
|
+
example: email
|
|
676
|
+
|
|
677
|
+
**localizeInfos:** FormLocalizeInfos <br>
|
|
678
|
+
*form name with localization* <br>
|
|
679
|
+
Enum:
|
|
680
|
+
[ db, email, script ]
|
|
681
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }
|
|
682
|
+
|
|
683
|
+
**processingData:** ProcessingData <br>
|
|
684
|
+
*form data*
|
|
685
|
+
|
|
686
|
+
**version:** number <br>
|
|
687
|
+
*object version number* <br>
|
|
688
|
+
example: 10
|
|
689
|
+
|
|
690
|
+
**identifier:** string <br>
|
|
691
|
+
*textual identifier for the record field* <br>
|
|
692
|
+
example: catalog
|
|
693
|
+
default: marker
|
|
694
|
+
|
|
695
|
+
**position:** number <br>
|
|
696
|
+
*position number (for sorting)* <br>
|
|
697
|
+
example: 192
|
|
698
|
+
|
|
699
|
+
**attributes:** <br>
|
|
700
|
+
*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
|
|
701
|
+
example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]
|
|
702
|
+
|
|
504
703
|
</details>
|
|
505
704
|
|
|
506
705
|
---
|
|
@@ -519,9 +718,7 @@ const value = await FormData.postFormsData(data)
|
|
|
519
718
|
|
|
520
719
|
> This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormDataDto.
|
|
521
720
|
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
<summary>Example return:</summary>
|
|
721
|
+
Example return:
|
|
525
722
|
|
|
526
723
|
```json
|
|
527
724
|
{
|
|
@@ -529,17 +726,31 @@ const value = await FormData.postFormsData(data)
|
|
|
529
726
|
"formIdentifier": "my-form",
|
|
530
727
|
"time": "2023-02-12 10:56",
|
|
531
728
|
"formData": {
|
|
532
|
-
"
|
|
533
|
-
|
|
534
|
-
"marker": "name_1",
|
|
535
|
-
"value": "Name"
|
|
536
|
-
}
|
|
537
|
-
]
|
|
729
|
+
"marker": "name_1",
|
|
730
|
+
"value": "Name"
|
|
538
731
|
}
|
|
539
732
|
}
|
|
540
733
|
```
|
|
541
|
-
|
|
734
|
+
<details>
|
|
735
|
+
<summary>Schema</summary>
|
|
736
|
+
|
|
737
|
+
**id:** number <br>
|
|
738
|
+
*object identifier* <br>
|
|
739
|
+
example: 1764
|
|
740
|
+
|
|
741
|
+
**formIdentifier:** string <br>
|
|
742
|
+
*Text identifier of the form object (marker)* <br>
|
|
743
|
+
example: my-form
|
|
744
|
+
|
|
745
|
+
**time:** Date <br>
|
|
746
|
+
*Date and time of form modification* <br>
|
|
747
|
+
example: 2023-02-12 10:56
|
|
542
748
|
|
|
749
|
+
**formData:** FormDataLangType <br>
|
|
750
|
+
*Data submitted by the form* <br>
|
|
751
|
+
example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
|
|
752
|
+
|
|
753
|
+
</details>
|
|
543
754
|
|
|
544
755
|
### FormData.getFormsData(langCode, offset, limit)
|
|
545
756
|
|
|
@@ -549,9 +760,7 @@ const value = await FormData.getFormsData('en_US', 0, 30)
|
|
|
549
760
|
|
|
550
761
|
> This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
|
|
551
762
|
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
<summary>Example return:</summary>
|
|
763
|
+
Example return:
|
|
555
764
|
|
|
556
765
|
```json
|
|
557
766
|
{
|
|
@@ -559,18 +768,37 @@ const value = await FormData.getFormsData('en_US', 0, 30)
|
|
|
559
768
|
"formIdentifier": "my-form",
|
|
560
769
|
"time": "2023-02-12 10:56",
|
|
561
770
|
"formData": {
|
|
562
|
-
"
|
|
563
|
-
|
|
564
|
-
"marker": "name_1",
|
|
565
|
-
"value": "Name"
|
|
566
|
-
}
|
|
567
|
-
]
|
|
771
|
+
"marker": "name_1",
|
|
772
|
+
"value": "Name"
|
|
568
773
|
},
|
|
569
774
|
"attributeSetIdentifier": "test-form"
|
|
570
775
|
}
|
|
571
776
|
```
|
|
572
|
-
</details>
|
|
573
777
|
|
|
778
|
+
<details>
|
|
779
|
+
<summary>Schema</summary>
|
|
780
|
+
|
|
781
|
+
**id:** number <br>
|
|
782
|
+
*object identifier* <br>
|
|
783
|
+
example: 1764
|
|
784
|
+
|
|
785
|
+
**formIdentifier:** string <br>
|
|
786
|
+
*Text identifier of the form object (marker)* <br>
|
|
787
|
+
example: my-form
|
|
788
|
+
|
|
789
|
+
**time:** Date <br>
|
|
790
|
+
*Date and time of form modification* <br>
|
|
791
|
+
example: 2023-02-12 10:56
|
|
792
|
+
|
|
793
|
+
**formData:** FormDataLangType <br>
|
|
794
|
+
*Data submitted by the form* <br>
|
|
795
|
+
example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
|
|
796
|
+
|
|
797
|
+
**attributeSetIdentifier:** string
|
|
798
|
+
*text identifier (marker) of the used attribute set*
|
|
799
|
+
example: test-form
|
|
800
|
+
|
|
801
|
+
</details>
|
|
574
802
|
|
|
575
803
|
|
|
576
804
|
### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
|
|
@@ -581,9 +809,7 @@ const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)
|
|
|
581
809
|
|
|
582
810
|
> This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
|
|
583
811
|
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
<summary>Example return:</summary>
|
|
812
|
+
Example return:
|
|
587
813
|
|
|
588
814
|
```json
|
|
589
815
|
{
|
|
@@ -591,16 +817,36 @@ const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)
|
|
|
591
817
|
"formIdentifier": "my-form",
|
|
592
818
|
"time": "2023-02-12 10:56",
|
|
593
819
|
"formData": {
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
"marker": "name_1",
|
|
597
|
-
"value": "Name"
|
|
598
|
-
}
|
|
599
|
-
]
|
|
820
|
+
"marker": "name_1",
|
|
821
|
+
"value": "Name"
|
|
600
822
|
},
|
|
601
823
|
"attributeSetIdentifier": "test-form"
|
|
602
824
|
}
|
|
603
825
|
```
|
|
826
|
+
|
|
827
|
+
<details>
|
|
828
|
+
<summary>Schema</summary>
|
|
829
|
+
|
|
830
|
+
**id:** number <br>
|
|
831
|
+
*object identifier* <br>
|
|
832
|
+
example: 1764
|
|
833
|
+
|
|
834
|
+
**formIdentifier:** string <br>
|
|
835
|
+
*Text identifier of the form object (marker)* <br>
|
|
836
|
+
example: my-form
|
|
837
|
+
|
|
838
|
+
**time:** Date <br>
|
|
839
|
+
*Date and time of form modification* <br>
|
|
840
|
+
example: 2023-02-12 10:56
|
|
841
|
+
|
|
842
|
+
**formData:** FormDataLangType <br>
|
|
843
|
+
*Data submitted by the form* <br>
|
|
844
|
+
example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
|
|
845
|
+
|
|
846
|
+
**attributeSetIdentifier:** string
|
|
847
|
+
*text identifier (marker) of the used attribute set*
|
|
848
|
+
example: test-form
|
|
849
|
+
|
|
604
850
|
</details>
|
|
605
851
|
|
|
606
852
|
---
|
|
@@ -619,9 +865,7 @@ const value = await GeneralTypes.getAllTypes()
|
|
|
619
865
|
|
|
620
866
|
> This method retrieves all objects of type GeneralTypeEntity from the API. It returns a Promise that resolves to an array of GeneralTypeEntity objects.
|
|
621
867
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
<summary>Example return:</summary>
|
|
868
|
+
Example return:
|
|
625
869
|
|
|
626
870
|
```json
|
|
627
871
|
[
|
|
@@ -631,8 +875,20 @@ const value = await GeneralTypes.getAllTypes()
|
|
|
631
875
|
}
|
|
632
876
|
]
|
|
633
877
|
```
|
|
634
|
-
|
|
878
|
+
<details>
|
|
879
|
+
<summary>Schema</summary>
|
|
880
|
+
|
|
881
|
+
**id:** number <br>
|
|
882
|
+
*object identifier* <br>
|
|
883
|
+
example: 1764
|
|
635
884
|
|
|
885
|
+
**type:** string <br>
|
|
886
|
+
*type value* <br>
|
|
887
|
+
example: forNewsPage <br>
|
|
888
|
+
Enum:
|
|
889
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
890
|
+
|
|
891
|
+
</details>
|
|
636
892
|
---
|
|
637
893
|
|
|
638
894
|
|
|
@@ -651,9 +907,7 @@ const value = await Locales.getLocales()
|
|
|
651
907
|
|
|
652
908
|
> This method retrieves all active language localization objects from the API. It returns a Promise that resolves to an array of LocaleEntity objects.
|
|
653
909
|
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
<summary>Example return:</summary>
|
|
910
|
+
Example return:
|
|
657
911
|
|
|
658
912
|
```json
|
|
659
913
|
[
|
|
@@ -669,79 +923,299 @@ const value = await Locales.getLocales()
|
|
|
669
923
|
}
|
|
670
924
|
]
|
|
671
925
|
```
|
|
672
|
-
</details>
|
|
673
926
|
|
|
927
|
+
<details>
|
|
928
|
+
<summary>Schema</summary>
|
|
929
|
+
|
|
930
|
+
**id:** number <br>
|
|
931
|
+
*object identifier* <br>
|
|
932
|
+
example: 1764
|
|
933
|
+
|
|
934
|
+
**shortCode:** string <br>
|
|
935
|
+
*language code (short)* <br>
|
|
936
|
+
example: en
|
|
937
|
+
|
|
938
|
+
**code:** string <br>
|
|
939
|
+
*language code with country code* <br>
|
|
940
|
+
example: en_US
|
|
941
|
+
|
|
942
|
+
**name** string <br>
|
|
943
|
+
*Language name (in English)* <br>
|
|
944
|
+
example: Bengali
|
|
945
|
+
|
|
946
|
+
**nativeName** string <br>
|
|
947
|
+
*Language name (in native language)* <br>
|
|
948
|
+
example: বাংলা
|
|
949
|
+
|
|
950
|
+
**isActive:** boolean <br>
|
|
951
|
+
*Flag of usage* <br>
|
|
952
|
+
example: false
|
|
953
|
+
|
|
954
|
+
**image:** string
|
|
955
|
+
*Graphic image of the language (under development)*
|
|
956
|
+
example: 🇦🇨
|
|
957
|
+
|
|
958
|
+
**position:** {
|
|
959
|
+
description:position number
|
|
960
|
+
}
|
|
961
|
+
</details>
|
|
674
962
|
---
|
|
675
963
|
|
|
676
964
|
|
|
677
965
|
|
|
678
|
-
|
|
966
|
+
|
|
967
|
+
## Markers
|
|
679
968
|
|
|
680
969
|
```js
|
|
681
|
-
const {
|
|
970
|
+
const { Markers } = defineOneEntry('your-url')
|
|
682
971
|
```
|
|
683
972
|
|
|
684
|
-
###
|
|
973
|
+
### Markers.getMarkers(offset, limit)
|
|
685
974
|
|
|
686
975
|
```js
|
|
687
|
-
const value = await
|
|
976
|
+
const value = await Markers.getMarkers(0, 30)
|
|
688
977
|
```
|
|
689
978
|
|
|
690
|
-
>
|
|
979
|
+
>This method return an array of all objects MarkerEntity.
|
|
980
|
+
|
|
981
|
+
Example return:
|
|
982
|
+
|
|
983
|
+
```json
|
|
984
|
+
[
|
|
985
|
+
{
|
|
986
|
+
"id": 17,
|
|
987
|
+
"updatedDate": "2023-12-18T08:53:37.422Z",
|
|
988
|
+
"version": 10,
|
|
989
|
+
"identifier": "catalog",
|
|
990
|
+
"name": "string",
|
|
991
|
+
"marker": "string",
|
|
992
|
+
"localizeInfos": {
|
|
993
|
+
"title": "My marker"
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
]
|
|
997
|
+
```
|
|
691
998
|
|
|
692
999
|
<details>
|
|
1000
|
+
<summary>Schema</summary>
|
|
1001
|
+
|
|
1002
|
+
**id:** number <br>
|
|
1003
|
+
*object identifier* <br>
|
|
1004
|
+
example: 1764
|
|
1005
|
+
|
|
1006
|
+
**updatedDate:** string($date-time) <br>
|
|
1007
|
+
*object modification date* <br>
|
|
1008
|
+
|
|
1009
|
+
**version:** number <br>
|
|
1010
|
+
*version number of the object change* <br>
|
|
1011
|
+
example: 10
|
|
1012
|
+
|
|
1013
|
+
**identifier?:** string <br>
|
|
1014
|
+
*textual identifier for a record field* <br>
|
|
1015
|
+
example: catalog
|
|
1016
|
+
|
|
1017
|
+
**name?:** string <br>
|
|
1018
|
+
*name*
|
|
1019
|
+
|
|
1020
|
+
**marker?:** string <br>
|
|
1021
|
+
*textual identifier*
|
|
1022
|
+
|
|
1023
|
+
**localizeInfos:** CommonLocalizeInfos <br>
|
|
1024
|
+
*localized marker name* <br>
|
|
1025
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
|
|
1026
|
+
</details>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
### Markers.getMarkerById(id)
|
|
1030
|
+
|
|
1031
|
+
```js
|
|
1032
|
+
const value = await Markers.getMarkerById(1)
|
|
1033
|
+
```
|
|
1034
|
+
|
|
1035
|
+
>This method return one object of MarkerEntity by id.
|
|
693
1036
|
|
|
694
|
-
|
|
1037
|
+
Example return:
|
|
695
1038
|
|
|
696
1039
|
```json
|
|
697
1040
|
{
|
|
698
|
-
"id":
|
|
1041
|
+
"id": 17,
|
|
1042
|
+
"updatedDate": "2023-12-18T08:55:22.581Z",
|
|
1043
|
+
"version": 10,
|
|
699
1044
|
"identifier": "catalog",
|
|
1045
|
+
"name": "string",
|
|
1046
|
+
"marker": "string",
|
|
700
1047
|
"localizeInfos": {
|
|
701
|
-
"
|
|
702
|
-
|
|
703
|
-
}
|
|
704
|
-
},
|
|
705
|
-
"pages": [
|
|
706
|
-
{
|
|
707
|
-
"id": 11,
|
|
708
|
-
"pageUrl": "122",
|
|
709
|
-
"localizeInfos": {
|
|
710
|
-
"en_US": {
|
|
711
|
-
"title": "12",
|
|
712
|
-
"content": "",
|
|
713
|
-
"menuTitle": "12"
|
|
714
|
-
}
|
|
715
|
-
},
|
|
716
|
-
"position": 0,
|
|
717
|
-
"parentId": null
|
|
718
|
-
}
|
|
719
|
-
]
|
|
1048
|
+
"title": "My marker"
|
|
1049
|
+
}
|
|
720
1050
|
}
|
|
721
1051
|
```
|
|
722
|
-
</details>
|
|
723
1052
|
|
|
724
|
-
|
|
1053
|
+
<details>
|
|
1054
|
+
<summary>Schema</summary>
|
|
725
1055
|
|
|
1056
|
+
**id:** number <br>
|
|
1057
|
+
*object identifier* <br>
|
|
1058
|
+
example: 1764
|
|
726
1059
|
|
|
1060
|
+
**updatedDate:** string($date-time) <br>
|
|
1061
|
+
*object modification date* <br>
|
|
727
1062
|
|
|
728
|
-
|
|
1063
|
+
**version:** number <br>
|
|
1064
|
+
*version number of the object change* <br>
|
|
1065
|
+
example: 10
|
|
1066
|
+
|
|
1067
|
+
**identifier?:** string <br>
|
|
1068
|
+
*textual identifier for a record field* <br>
|
|
1069
|
+
example: catalog
|
|
1070
|
+
|
|
1071
|
+
**name?:** string <br>
|
|
1072
|
+
*name*
|
|
1073
|
+
|
|
1074
|
+
**marker?:** string <br>
|
|
1075
|
+
*textual identifier*
|
|
1076
|
+
|
|
1077
|
+
**localizeInfos:** CommonLocalizeInfos <br>
|
|
1078
|
+
*localized marker name* <br>
|
|
1079
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
|
|
1080
|
+
</details>
|
|
1081
|
+
|
|
1082
|
+
### Markers.getMarkerByMarker(marker)
|
|
729
1083
|
|
|
730
1084
|
```js
|
|
731
|
-
const
|
|
1085
|
+
const value = await Markers.getMarkerByMarker('my-marker')
|
|
732
1086
|
```
|
|
733
1087
|
|
|
734
|
-
>
|
|
1088
|
+
>This method return one object of MarkerEntity by marker.
|
|
735
1089
|
|
|
736
|
-
Example:
|
|
1090
|
+
Example return:
|
|
737
1091
|
|
|
1092
|
+
```json
|
|
1093
|
+
{
|
|
1094
|
+
"id": 17,
|
|
1095
|
+
"updatedDate": "2023-12-18T08:59:42.006Z",
|
|
1096
|
+
"version": 10,
|
|
1097
|
+
"identifier": "catalog",
|
|
1098
|
+
"name": "string",
|
|
1099
|
+
"marker": "string",
|
|
1100
|
+
"localizeInfos": {
|
|
1101
|
+
"title": "My marker"
|
|
1102
|
+
}
|
|
1103
|
+
}
|
|
738
1104
|
```
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
1105
|
+
|
|
1106
|
+
<details>
|
|
1107
|
+
<summary>Schema</summary>
|
|
1108
|
+
|
|
1109
|
+
**id:** number <br>
|
|
1110
|
+
*object identifier* <br>
|
|
1111
|
+
example: 1764
|
|
1112
|
+
|
|
1113
|
+
**updatedDate:** string($date-time) <br>
|
|
1114
|
+
*object modification date* <br>
|
|
1115
|
+
|
|
1116
|
+
**version:** number <br>
|
|
1117
|
+
*version number of the object change* <br>
|
|
1118
|
+
example: 10
|
|
1119
|
+
|
|
1120
|
+
**identifier?:** string <br>
|
|
1121
|
+
*textual identifier for a record field* <br>
|
|
1122
|
+
example: catalog
|
|
1123
|
+
|
|
1124
|
+
**name?:** string <br>
|
|
1125
|
+
*name*
|
|
1126
|
+
|
|
1127
|
+
**marker?:** string <br>
|
|
1128
|
+
*textual identifier*
|
|
1129
|
+
|
|
1130
|
+
**localizeInfos:** CommonLocalizeInfos <br>
|
|
1131
|
+
*localized marker name* <br>
|
|
1132
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
|
|
1133
|
+
</details>
|
|
1134
|
+
|
|
1135
|
+
---
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
## Menus
|
|
1139
|
+
|
|
1140
|
+
```js
|
|
1141
|
+
const { Menus } = defineOneEntry('your-url')
|
|
1142
|
+
```
|
|
1143
|
+
|
|
1144
|
+
### Menus.getMenusByMarker(marker)
|
|
1145
|
+
|
|
1146
|
+
```js
|
|
1147
|
+
const value = await Menus.getMenusByMarker('my-marker')
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
> This method retrieves a single menu object based on its marker (marker) from the API. It returns a Promise that resolves to a single menu object as a ContentMenuDto object with included pages.
|
|
1151
|
+
|
|
1152
|
+
Example return:
|
|
1153
|
+
|
|
1154
|
+
```json
|
|
1155
|
+
{
|
|
1156
|
+
"id": 1764,
|
|
1157
|
+
"identifier": "catalog",
|
|
1158
|
+
"localizeInfos": {
|
|
1159
|
+
"title": "Main Menu"
|
|
1160
|
+
},
|
|
1161
|
+
"pages": [
|
|
1162
|
+
{
|
|
1163
|
+
"id": 11,
|
|
1164
|
+
"pageUrl": "122",
|
|
1165
|
+
"localizeInfos": {
|
|
1166
|
+
"en_US": {
|
|
1167
|
+
"title": "12",
|
|
1168
|
+
"content": "",
|
|
1169
|
+
"menuTitle": "12"
|
|
1170
|
+
}
|
|
1171
|
+
},
|
|
1172
|
+
"position": 0,
|
|
1173
|
+
"parentId": null
|
|
1174
|
+
}
|
|
1175
|
+
]
|
|
1176
|
+
}
|
|
1177
|
+
```
|
|
1178
|
+
|
|
1179
|
+
<details>
|
|
1180
|
+
<summary>Schema</summary>
|
|
1181
|
+
|
|
1182
|
+
**id:** number <br>
|
|
1183
|
+
*object identifier* <br>
|
|
1184
|
+
example: 1764
|
|
1185
|
+
|
|
1186
|
+
**identifier:** string <br>
|
|
1187
|
+
*textual identifier for a record field* <br>
|
|
1188
|
+
example: catalog
|
|
1189
|
+
|
|
1190
|
+
**localizeInfos** Record<string, any> <br>
|
|
1191
|
+
*json object description of the menu item with the language "en_US" (for example)* <br>
|
|
1192
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Main Menu" } }
|
|
1193
|
+
|
|
1194
|
+
**pages:**
|
|
1195
|
+
*data of the pages included in the menu*
|
|
1196
|
+
example: List [ OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": OrderedMap { "en_US": OrderedMap { "title": "12", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "12" } }, "position": 0, "parentId": null } ]
|
|
1197
|
+
</details>
|
|
1198
|
+
|
|
1199
|
+
---
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
## Pages
|
|
1203
|
+
|
|
1204
|
+
```js
|
|
1205
|
+
const { Pages } = defineOneEntry('your-url')
|
|
1206
|
+
```
|
|
1207
|
+
|
|
1208
|
+
> In some methods, the langcode parameter can be either a string or an array of strings. It depends on which set of values will contain "attributeValues" and "localizeInfos"
|
|
1209
|
+
|
|
1210
|
+
Example:
|
|
1211
|
+
|
|
1212
|
+
```
|
|
1213
|
+
const value = await Pages.getRootPages('en_US')
|
|
1214
|
+
|
|
1215
|
+
"localizeInfos": {
|
|
1216
|
+
{
|
|
1217
|
+
"title": "Catalog",
|
|
1218
|
+
"content": "Content from catalog",
|
|
745
1219
|
"menuTitle": "Catalog"
|
|
746
1220
|
}
|
|
747
1221
|
},
|
|
@@ -796,9 +1270,7 @@ const value = await Pages.getRootPages('en_US')
|
|
|
796
1270
|
|
|
797
1271
|
> This method retrieves all top-level page objects from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
|
|
798
1272
|
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
<summary>Example return:</summary>
|
|
1273
|
+
Example return:
|
|
802
1274
|
|
|
803
1275
|
```json
|
|
804
1276
|
[
|
|
@@ -812,11 +1284,9 @@ const value = await Pages.getRootPages('en_US')
|
|
|
812
1284
|
"pageUrl": "string",
|
|
813
1285
|
"depth": 3,
|
|
814
1286
|
"localizeInfos": {
|
|
815
|
-
"
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
"menuTitle": "Catalog"
|
|
819
|
-
}
|
|
1287
|
+
"title": "Catalog",
|
|
1288
|
+
"content": "Content for catalog",
|
|
1289
|
+
"menuTitle": "Catalog"
|
|
820
1290
|
},
|
|
821
1291
|
"isVisible": true,
|
|
822
1292
|
"products": 0,
|
|
@@ -824,11 +1294,9 @@ const value = await Pages.getRootPages('en_US')
|
|
|
824
1294
|
"isSync": false,
|
|
825
1295
|
"templateIdentifier": "my-template",
|
|
826
1296
|
"attributeValues": {
|
|
827
|
-
"
|
|
828
|
-
"
|
|
829
|
-
|
|
830
|
-
"type": "string"
|
|
831
|
-
}
|
|
1297
|
+
"marker": {
|
|
1298
|
+
"value": "",
|
|
1299
|
+
"type": "string"
|
|
832
1300
|
}
|
|
833
1301
|
},
|
|
834
1302
|
"position": 192,
|
|
@@ -837,8 +1305,81 @@ const value = await Pages.getRootPages('en_US')
|
|
|
837
1305
|
}
|
|
838
1306
|
]
|
|
839
1307
|
```
|
|
840
|
-
</details>
|
|
841
1308
|
|
|
1309
|
+
<details>
|
|
1310
|
+
<summary>Schema</summary>
|
|
1311
|
+
|
|
1312
|
+
**id:** number <br>
|
|
1313
|
+
*object identifier* <br>
|
|
1314
|
+
example: 1764
|
|
1315
|
+
|
|
1316
|
+
**parentId** number <br>
|
|
1317
|
+
*parent page identifier, if null, it is a top-level page* <br>
|
|
1318
|
+
example: null
|
|
1319
|
+
|
|
1320
|
+
**config** Record<string, number> <br>
|
|
1321
|
+
*output settings for catalog pages* <br>
|
|
1322
|
+
example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
|
|
1323
|
+
|
|
1324
|
+
**pageUrl** string <br>
|
|
1325
|
+
*unique page URL*
|
|
1326
|
+
|
|
1327
|
+
**depth** number <br>
|
|
1328
|
+
*page nesting depth relative to parentId* <br>
|
|
1329
|
+
example: 3
|
|
1330
|
+
|
|
1331
|
+
**localizeInfos:** Record<string, any> <br>
|
|
1332
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
1333
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1334
|
+
|
|
1335
|
+
**isVisible:** boolean <br>
|
|
1336
|
+
*Page visibility flag* <br>
|
|
1337
|
+
example: true
|
|
1338
|
+
|
|
1339
|
+
**products** number <br>
|
|
1340
|
+
*Number of products linked to the page* <br>
|
|
1341
|
+
example: 0
|
|
1342
|
+
|
|
1343
|
+
**attributeSetId:** number <br>
|
|
1344
|
+
*attribute set identifier* <br>
|
|
1345
|
+
example: 7
|
|
1346
|
+
|
|
1347
|
+
**forms** <br>
|
|
1348
|
+
*Array of FormEntity object identifier values linked to the page (optional)*
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
**blocks** <br>
|
|
1352
|
+
*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
**isSync:** boolean <br>
|
|
1356
|
+
*indicator of page indexing (true or false)* <br>
|
|
1357
|
+
example: false
|
|
1358
|
+
|
|
1359
|
+
**templateIdentifier:** string <br>
|
|
1360
|
+
*Custom identifier of the linked template* <br>
|
|
1361
|
+
example: my-template
|
|
1362
|
+
|
|
1363
|
+
**attributeValues:** Record<string, string> <br>
|
|
1364
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
1365
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
1366
|
+
|
|
1367
|
+
**position:** number <br>
|
|
1368
|
+
*position number for sorting (optional)* <br>
|
|
1369
|
+
example: 192
|
|
1370
|
+
|
|
1371
|
+
**type:** string <br>
|
|
1372
|
+
*Page type* <br>
|
|
1373
|
+
example: forNewsPage
|
|
1374
|
+
Enum:
|
|
1375
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
**childrenCount:** number <br>
|
|
1379
|
+
*number of nested pages* <br>
|
|
1380
|
+
example: 0
|
|
1381
|
+
|
|
1382
|
+
</details>
|
|
842
1383
|
|
|
843
1384
|
### Pages.getCatalogPages(langCode, limit, offset)
|
|
844
1385
|
|
|
@@ -848,9 +1389,7 @@ const value = await Pages.getCatalogPages('en_US', 0, 30)
|
|
|
848
1389
|
|
|
849
1390
|
> This method retrieves all page objects with product information as an array from the API. It accepts two optional parameters limit and offset for pagination and language code parameter. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.
|
|
850
1391
|
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
<summary>Example return:</summary>
|
|
1392
|
+
Example return:
|
|
854
1393
|
|
|
855
1394
|
```json
|
|
856
1395
|
[
|
|
@@ -864,11 +1403,9 @@ const value = await Pages.getCatalogPages('en_US', 0, 30)
|
|
|
864
1403
|
"pageUrl": "string",
|
|
865
1404
|
"depth": 3,
|
|
866
1405
|
"localizeInfos": {
|
|
867
|
-
"
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
"menuTitle": "Catalog"
|
|
871
|
-
}
|
|
1406
|
+
"title": "Catalog",
|
|
1407
|
+
"content": "Content for catalog",
|
|
1408
|
+
"menuTitle": "Catalog"
|
|
872
1409
|
},
|
|
873
1410
|
"isVisible": true,
|
|
874
1411
|
"products": 0,
|
|
@@ -876,11 +1413,9 @@ const value = await Pages.getCatalogPages('en_US', 0, 30)
|
|
|
876
1413
|
"isSync": false,
|
|
877
1414
|
"templateIdentifier": "my-template",
|
|
878
1415
|
"attributeValues": {
|
|
879
|
-
"
|
|
880
|
-
"
|
|
881
|
-
|
|
882
|
-
"type": "string"
|
|
883
|
-
}
|
|
1416
|
+
"marker": {
|
|
1417
|
+
"value": "",
|
|
1418
|
+
"type": "string"
|
|
884
1419
|
}
|
|
885
1420
|
},
|
|
886
1421
|
"position": 192,
|
|
@@ -889,8 +1424,80 @@ const value = await Pages.getCatalogPages('en_US', 0, 30)
|
|
|
889
1424
|
}
|
|
890
1425
|
]
|
|
891
1426
|
```
|
|
892
|
-
|
|
1427
|
+
<details>
|
|
1428
|
+
<summary>Schema</summary>
|
|
893
1429
|
|
|
1430
|
+
**id:** number <br>
|
|
1431
|
+
*object identifier* <br>
|
|
1432
|
+
example: 1764
|
|
1433
|
+
|
|
1434
|
+
**parentId** number <br>
|
|
1435
|
+
*parent page identifier, if null, it is a top-level page* <br>
|
|
1436
|
+
example: null
|
|
1437
|
+
|
|
1438
|
+
**config** Record<string, number> <br>
|
|
1439
|
+
*output settings for catalog pages* <br>
|
|
1440
|
+
example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
|
|
1441
|
+
|
|
1442
|
+
**pageUrl** string <br>
|
|
1443
|
+
*unique page URL*
|
|
1444
|
+
|
|
1445
|
+
**depth** number <br>
|
|
1446
|
+
*page nesting depth relative to parentId* <br>
|
|
1447
|
+
example: 3
|
|
1448
|
+
|
|
1449
|
+
**localizeInfos:** Record<string, any> <br>
|
|
1450
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
1451
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1452
|
+
|
|
1453
|
+
**isVisible:** boolean <br>
|
|
1454
|
+
*Page visibility flag* <br>
|
|
1455
|
+
example: true
|
|
1456
|
+
|
|
1457
|
+
**products** number <br>
|
|
1458
|
+
*Number of products linked to the page* <br>
|
|
1459
|
+
example: 0
|
|
1460
|
+
|
|
1461
|
+
**attributeSetId:** number <br>
|
|
1462
|
+
*attribute set identifier* <br>
|
|
1463
|
+
example: 7
|
|
1464
|
+
|
|
1465
|
+
**forms** <br>
|
|
1466
|
+
*Array of FormEntity object identifier values linked to the page (optional)*
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
**blocks** <br>
|
|
1470
|
+
*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
**isSync:** boolean <br>
|
|
1474
|
+
*indicator of page indexing (true or false)* <br>
|
|
1475
|
+
example: false
|
|
1476
|
+
|
|
1477
|
+
**templateIdentifier:** string <br>
|
|
1478
|
+
*Custom identifier of the linked template* <br>
|
|
1479
|
+
example: my-template
|
|
1480
|
+
|
|
1481
|
+
**attributeValues:** Record<string, string> <br>
|
|
1482
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
1483
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
1484
|
+
|
|
1485
|
+
**position:** number <br>
|
|
1486
|
+
*position number for sorting (optional)* <br>
|
|
1487
|
+
example: 192
|
|
1488
|
+
|
|
1489
|
+
**type:** string <br>
|
|
1490
|
+
*Page type* <br>
|
|
1491
|
+
example: forNewsPage
|
|
1492
|
+
Enum:
|
|
1493
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
**childrenCount:** number <br>
|
|
1497
|
+
*number of nested pages* <br>
|
|
1498
|
+
example: 0
|
|
1499
|
+
|
|
1500
|
+
</details>
|
|
894
1501
|
|
|
895
1502
|
### Pages.getPages(langCode)
|
|
896
1503
|
|
|
@@ -900,9 +1507,7 @@ const value = await Pages.getPages('en_US')
|
|
|
900
1507
|
|
|
901
1508
|
> This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
|
|
902
1509
|
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
<summary>Example return:</summary>
|
|
1510
|
+
Example return:
|
|
906
1511
|
|
|
907
1512
|
```json
|
|
908
1513
|
[
|
|
@@ -916,11 +1521,9 @@ const value = await Pages.getPages('en_US')
|
|
|
916
1521
|
"pageUrl": "string",
|
|
917
1522
|
"depth": 3,
|
|
918
1523
|
"localizeInfos": {
|
|
919
|
-
"
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
"menuTitle": "Catalog"
|
|
923
|
-
}
|
|
1524
|
+
"title": "Catalog",
|
|
1525
|
+
"content": "Content for catalog",
|
|
1526
|
+
"menuTitle": "Catalog"
|
|
924
1527
|
},
|
|
925
1528
|
"isVisible": true,
|
|
926
1529
|
"products": 0,
|
|
@@ -928,11 +1531,9 @@ const value = await Pages.getPages('en_US')
|
|
|
928
1531
|
"isSync": false,
|
|
929
1532
|
"templateIdentifier": "my-template",
|
|
930
1533
|
"attributeValues": {
|
|
931
|
-
"
|
|
932
|
-
"
|
|
933
|
-
|
|
934
|
-
"type": "string"
|
|
935
|
-
}
|
|
1534
|
+
"marker": {
|
|
1535
|
+
"value": "",
|
|
1536
|
+
"type": "string"
|
|
936
1537
|
}
|
|
937
1538
|
},
|
|
938
1539
|
"position": 192,
|
|
@@ -941,8 +1542,80 @@ const value = await Pages.getPages('en_US')
|
|
|
941
1542
|
}
|
|
942
1543
|
]
|
|
943
1544
|
```
|
|
944
|
-
|
|
1545
|
+
<details>
|
|
1546
|
+
<summary>Schema</summary>
|
|
1547
|
+
|
|
1548
|
+
**id:** number <br>
|
|
1549
|
+
*object identifier* <br>
|
|
1550
|
+
example: 1764
|
|
1551
|
+
|
|
1552
|
+
**parentId** number <br>
|
|
1553
|
+
*parent page identifier, if null, it is a top-level page* <br>
|
|
1554
|
+
example: null
|
|
1555
|
+
|
|
1556
|
+
**config** Record<string, number> <br>
|
|
1557
|
+
*output settings for catalog pages* <br>
|
|
1558
|
+
example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
|
|
1559
|
+
|
|
1560
|
+
**pageUrl** string <br>
|
|
1561
|
+
*unique page URL*
|
|
1562
|
+
|
|
1563
|
+
**depth** number <br>
|
|
1564
|
+
*page nesting depth relative to parentId* <br>
|
|
1565
|
+
example: 3
|
|
1566
|
+
|
|
1567
|
+
**localizeInfos:** Record<string, any> <br>
|
|
1568
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
1569
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1570
|
+
|
|
1571
|
+
**isVisible:** boolean <br>
|
|
1572
|
+
*Page visibility flag* <br>
|
|
1573
|
+
example: true
|
|
1574
|
+
|
|
1575
|
+
**products** number <br>
|
|
1576
|
+
*Number of products linked to the page* <br>
|
|
1577
|
+
example: 0
|
|
1578
|
+
|
|
1579
|
+
**attributeSetId:** number <br>
|
|
1580
|
+
*attribute set identifier* <br>
|
|
1581
|
+
example: 7
|
|
1582
|
+
|
|
1583
|
+
**forms** <br>
|
|
1584
|
+
*Array of FormEntity object identifier values linked to the page (optional)*
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
**blocks** <br>
|
|
1588
|
+
*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
**isSync:** boolean <br>
|
|
1592
|
+
*indicator of page indexing (true or false)* <br>
|
|
1593
|
+
example: false
|
|
1594
|
+
|
|
1595
|
+
**templateIdentifier:** string <br>
|
|
1596
|
+
*Custom identifier of the linked template* <br>
|
|
1597
|
+
example: my-template
|
|
1598
|
+
|
|
1599
|
+
**attributeValues:** Record<string, string> <br>
|
|
1600
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
1601
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
945
1602
|
|
|
1603
|
+
**position:** number <br>
|
|
1604
|
+
*position number for sorting (optional)* <br>
|
|
1605
|
+
example: 192
|
|
1606
|
+
|
|
1607
|
+
**type:** string <br>
|
|
1608
|
+
*Page type* <br>
|
|
1609
|
+
example: forNewsPage
|
|
1610
|
+
Enum:
|
|
1611
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
**childrenCount:** number <br>
|
|
1615
|
+
*number of nested pages* <br>
|
|
1616
|
+
example: 0
|
|
1617
|
+
|
|
1618
|
+
</details>
|
|
946
1619
|
|
|
947
1620
|
### Pages.getPageById(id, langCode)
|
|
948
1621
|
|
|
@@ -952,9 +1625,7 @@ const value = await Pages.getPageById(1, 'en_US')
|
|
|
952
1625
|
|
|
953
1626
|
> This method retrieves a single page object based on its identifier (id) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned. Get required language parameter.
|
|
954
1627
|
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
<summary>Example return:</summary>
|
|
1628
|
+
Example return:
|
|
958
1629
|
|
|
959
1630
|
```json
|
|
960
1631
|
{
|
|
@@ -963,11 +1634,9 @@ const value = await Pages.getPageById(1, 'en_US')
|
|
|
963
1634
|
"pageUrl": "string",
|
|
964
1635
|
"depth": 3,
|
|
965
1636
|
"localizeInfos": {
|
|
966
|
-
"
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
"menuTitle": "Catalog"
|
|
970
|
-
}
|
|
1637
|
+
"title": "Catalog",
|
|
1638
|
+
"content": "Content for catalog",
|
|
1639
|
+
"menuTitle": "Catalog"
|
|
971
1640
|
},
|
|
972
1641
|
"isVisible": true,
|
|
973
1642
|
"position": 192,
|
|
@@ -975,19 +1644,77 @@ const value = await Pages.getPageById(1, 'en_US')
|
|
|
975
1644
|
"templateIdentifier": "my-template",
|
|
976
1645
|
"attributeSetId": 7,
|
|
977
1646
|
"attributeValues": {
|
|
978
|
-
"
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
"value": ""
|
|
982
|
-
}
|
|
1647
|
+
"marker": "description",
|
|
1648
|
+
"type": "string",
|
|
1649
|
+
"value": ""
|
|
983
1650
|
},
|
|
984
1651
|
"isSync": false,
|
|
985
1652
|
"products": 0
|
|
986
1653
|
}
|
|
987
1654
|
```
|
|
988
|
-
|
|
1655
|
+
<details>
|
|
1656
|
+
<summary>Schema</summary>
|
|
1657
|
+
|
|
1658
|
+
**id:** number <br>
|
|
1659
|
+
*object identifier* <br>
|
|
1660
|
+
example: 1764
|
|
1661
|
+
|
|
1662
|
+
**parentId** number <br>
|
|
1663
|
+
*parent page identifier, if null, it is a top-level page* <br>
|
|
1664
|
+
example: null
|
|
1665
|
+
|
|
1666
|
+
**pageUrl** string <br>
|
|
1667
|
+
*unique page URL*
|
|
1668
|
+
|
|
1669
|
+
**depth** number <br>
|
|
1670
|
+
*page nesting depth relative to parentId* <br>
|
|
1671
|
+
example: 3
|
|
1672
|
+
|
|
1673
|
+
**localizeInfos:** Record<string, any> <br>
|
|
1674
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
1675
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1676
|
+
|
|
1677
|
+
**isVisible:** boolean <br>
|
|
1678
|
+
*Page visibility flag* <br>
|
|
1679
|
+
example: true
|
|
1680
|
+
|
|
1681
|
+
**position:** number <br>
|
|
1682
|
+
*position number (for sorting)* <br>
|
|
1683
|
+
example: 192
|
|
1684
|
+
|
|
1685
|
+
**type** string <br>
|
|
1686
|
+
*page type:* <br>
|
|
1687
|
+
example: forNewsPage <br>
|
|
1688
|
+
Enum:
|
|
1689
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
**templateIdentifier:** string <br>
|
|
1693
|
+
*custom identifier of the associated template* <br>
|
|
1694
|
+
example: my-template
|
|
1695
|
+
|
|
1696
|
+
**attributeSetId:** number <br>
|
|
1697
|
+
*attribute set identifier* <br>
|
|
1698
|
+
example: 7
|
|
1699
|
+
|
|
1700
|
+
**forms** <br>
|
|
1701
|
+
*Array of FormEntity object identifier values linked to the page (optional)*
|
|
989
1702
|
|
|
990
1703
|
|
|
1704
|
+
**blocks** <br>
|
|
1705
|
+
*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
**isSync:** boolean <br>
|
|
1709
|
+
*indicator of page indexing (true or false)* <br>
|
|
1710
|
+
example: false
|
|
1711
|
+
|
|
1712
|
+
**products** number <br>
|
|
1713
|
+
*number of products associated with the page* <br>
|
|
1714
|
+
example: 0
|
|
1715
|
+
|
|
1716
|
+
</details>
|
|
1717
|
+
|
|
991
1718
|
### Pages.getPageByUrl(url, langCode)
|
|
992
1719
|
|
|
993
1720
|
```js
|
|
@@ -996,9 +1723,7 @@ const value = await Pages.getPageByUrl('shop', 'en_US')
|
|
|
996
1723
|
|
|
997
1724
|
> This method retrieves a single page object based on its URL (url) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned. Get required language parameter.
|
|
998
1725
|
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
<summary>Example return:</summary>
|
|
1726
|
+
Example return:
|
|
1002
1727
|
|
|
1003
1728
|
```json
|
|
1004
1729
|
{
|
|
@@ -1007,11 +1732,9 @@ const value = await Pages.getPageByUrl('shop', 'en_US')
|
|
|
1007
1732
|
"pageUrl": "string",
|
|
1008
1733
|
"depth": 3,
|
|
1009
1734
|
"localizeInfos": {
|
|
1010
|
-
"
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
"menuTitle": "Catalog"
|
|
1014
|
-
}
|
|
1735
|
+
"title": "Catalog",
|
|
1736
|
+
"content": "Content for catalog",
|
|
1737
|
+
"menuTitle": "Catalog"
|
|
1015
1738
|
},
|
|
1016
1739
|
"isVisible": true,
|
|
1017
1740
|
"position": 192,
|
|
@@ -1019,16 +1742,75 @@ const value = await Pages.getPageByUrl('shop', 'en_US')
|
|
|
1019
1742
|
"templateIdentifier": "my-template",
|
|
1020
1743
|
"attributeSetId": 7,
|
|
1021
1744
|
"attributeValues": {
|
|
1022
|
-
"
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
"value": ""
|
|
1026
|
-
}
|
|
1745
|
+
"marker": "description",
|
|
1746
|
+
"type": "string",
|
|
1747
|
+
"value": ""
|
|
1027
1748
|
},
|
|
1028
1749
|
"isSync": false,
|
|
1029
1750
|
"products": 0
|
|
1030
1751
|
}
|
|
1031
1752
|
```
|
|
1753
|
+
<details>
|
|
1754
|
+
<summary>Schema</summary>
|
|
1755
|
+
|
|
1756
|
+
**id:** number <br>
|
|
1757
|
+
*object identifier* <br>
|
|
1758
|
+
example: 1764
|
|
1759
|
+
|
|
1760
|
+
**parentId** number <br>
|
|
1761
|
+
*parent page identifier, if null, it is a top-level page* <br>
|
|
1762
|
+
example: null
|
|
1763
|
+
|
|
1764
|
+
**pageUrl** string <br>
|
|
1765
|
+
*unique page URL*
|
|
1766
|
+
|
|
1767
|
+
**depth** number <br>
|
|
1768
|
+
*page nesting depth relative to parentId* <br>
|
|
1769
|
+
example: 3
|
|
1770
|
+
|
|
1771
|
+
**localizeInfos:** Record<string, any> <br>
|
|
1772
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
1773
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1774
|
+
|
|
1775
|
+
**isVisible:** boolean <br>
|
|
1776
|
+
*Page visibility flag* <br>
|
|
1777
|
+
example: true
|
|
1778
|
+
|
|
1779
|
+
**position:** number <br>
|
|
1780
|
+
*position number (for sorting)* <br>
|
|
1781
|
+
example: 192
|
|
1782
|
+
|
|
1783
|
+
**type** string <br>
|
|
1784
|
+
*page type:* <br>
|
|
1785
|
+
example: forNewsPage <br>
|
|
1786
|
+
Enum:
|
|
1787
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
**templateIdentifier:** string <br>
|
|
1791
|
+
*custom identifier of the associated template* <br>
|
|
1792
|
+
example: my-template
|
|
1793
|
+
|
|
1794
|
+
**attributeSetId:** number <br>
|
|
1795
|
+
*attribute set identifier* <br>
|
|
1796
|
+
example: 7
|
|
1797
|
+
|
|
1798
|
+
**forms** <br>
|
|
1799
|
+
*Array of FormEntity object identifier values linked to the page (optional)*
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
**blocks** <br>
|
|
1803
|
+
*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
**isSync:** boolean <br>
|
|
1807
|
+
*indicator of page indexing (true or false)* <br>
|
|
1808
|
+
example: false
|
|
1809
|
+
|
|
1810
|
+
**products** number <br>
|
|
1811
|
+
*number of products associated with the page* <br>
|
|
1812
|
+
example: 0
|
|
1813
|
+
|
|
1032
1814
|
</details>
|
|
1033
1815
|
|
|
1034
1816
|
|
|
@@ -1040,41 +1822,122 @@ const value = await Pages.getChildPagesByParentUrl('shop', 'en_US')
|
|
|
1040
1822
|
|
|
1041
1823
|
> Getting child pages with information about products in the form of an array. Returns all created pages as an array of AdminIndexedPageDto objects or an empty array [] (if there is no data) for the selected parent.
|
|
1042
1824
|
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
<summary>Example return:</summary>
|
|
1825
|
+
Example return:
|
|
1046
1826
|
|
|
1047
1827
|
```json
|
|
1048
1828
|
[
|
|
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
|
-
|
|
1829
|
+
{
|
|
1830
|
+
"id": 1764,
|
|
1831
|
+
"parentId": null,
|
|
1832
|
+
"config": {
|
|
1833
|
+
"rowsPerPage": 1,
|
|
1834
|
+
"productsPerRow": 1
|
|
1835
|
+
},
|
|
1836
|
+
"pageUrl": "string",
|
|
1837
|
+
"depth": 3,
|
|
1838
|
+
"localizeInfos": {
|
|
1839
|
+
"title": "Catalog",
|
|
1840
|
+
"plainContent": "Content for catalog",
|
|
1841
|
+
"htmlContent": "<b>Content for catalog</b>",
|
|
1842
|
+
"menuTitle": "Catalog"
|
|
1843
|
+
},
|
|
1844
|
+
"isVisible": true,
|
|
1845
|
+
"products": 0,
|
|
1846
|
+
"attributeSetId": 7,
|
|
1847
|
+
"forms": [
|
|
1848
|
+
null
|
|
1849
|
+
],
|
|
1850
|
+
"blocks": [
|
|
1851
|
+
null
|
|
1852
|
+
],
|
|
1853
|
+
"isSync": false,
|
|
1854
|
+
"templateIdentifier": "my-template",
|
|
1855
|
+
"attributeValues": {
|
|
1856
|
+
"marker": {
|
|
1857
|
+
"value": "",
|
|
1858
|
+
"type": "string"
|
|
1859
|
+
}
|
|
1860
|
+
},
|
|
1861
|
+
"position": 192,
|
|
1862
|
+
"type": "forNewsPage",
|
|
1863
|
+
"childrenCount": 0
|
|
1864
|
+
}
|
|
1076
1865
|
]
|
|
1077
1866
|
```
|
|
1867
|
+
|
|
1868
|
+
<details>
|
|
1869
|
+
<summary>Schema</summary>
|
|
1870
|
+
|
|
1871
|
+
**id:** number <br>
|
|
1872
|
+
*object identifier* <br>
|
|
1873
|
+
example: 1764
|
|
1874
|
+
|
|
1875
|
+
**parentId** number <br>
|
|
1876
|
+
*parent page identifier, if null, it is a top-level page* <br>
|
|
1877
|
+
example: null
|
|
1878
|
+
|
|
1879
|
+
**config** Record<string, number> <br>
|
|
1880
|
+
*output settings for catalog pages* <br>
|
|
1881
|
+
example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
|
|
1882
|
+
|
|
1883
|
+
**pageUrl** string <br>
|
|
1884
|
+
*unique page URL*
|
|
1885
|
+
|
|
1886
|
+
**depth** number <br>
|
|
1887
|
+
*page nesting depth relative to parentId* <br>
|
|
1888
|
+
example: 3
|
|
1889
|
+
|
|
1890
|
+
**localizeInfos:** Record<string, any> <br>
|
|
1891
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
1892
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1893
|
+
|
|
1894
|
+
**isVisible:** boolean <br>
|
|
1895
|
+
*Page visibility flag* <br>
|
|
1896
|
+
example: true
|
|
1897
|
+
|
|
1898
|
+
**products** number <br>
|
|
1899
|
+
*Number of products linked to the page* <br>
|
|
1900
|
+
example: 0
|
|
1901
|
+
|
|
1902
|
+
**attributeSetId:** number <br>
|
|
1903
|
+
*attribute set identifier* <br>
|
|
1904
|
+
example: 7
|
|
1905
|
+
|
|
1906
|
+
**forms** <br>
|
|
1907
|
+
*Array of FormEntity object identifier values linked to the page (optional)*
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
**blocks** <br>
|
|
1911
|
+
*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
**isSync:** boolean <br>
|
|
1915
|
+
*indicator of page indexing (true or false)* <br>
|
|
1916
|
+
example: false
|
|
1917
|
+
|
|
1918
|
+
**templateIdentifier:** string <br>
|
|
1919
|
+
*Custom identifier of the linked template* <br>
|
|
1920
|
+
example: my-template
|
|
1921
|
+
|
|
1922
|
+
**attributeValues:** Record<string, string> <br>
|
|
1923
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
1924
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
1925
|
+
|
|
1926
|
+
**position:** number <br>
|
|
1927
|
+
*position number for sorting (optional)* <br>
|
|
1928
|
+
example: 192
|
|
1929
|
+
|
|
1930
|
+
**type:** string <br>
|
|
1931
|
+
*Page type* <br>
|
|
1932
|
+
example: forNewsPage
|
|
1933
|
+
Enum:
|
|
1934
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
**childrenCount:** number <br>
|
|
1938
|
+
*number of nested pages* <br>
|
|
1939
|
+
example: 0
|
|
1940
|
+
|
|
1078
1941
|
</details>
|
|
1079
1942
|
|
|
1080
1943
|
|
|
@@ -1086,9 +1949,7 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1086
1949
|
|
|
1087
1950
|
> Get PositionBlock objects for a related form by url. Returns an array of PositionBlock objects.
|
|
1088
1951
|
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
<summary>Example return:</summary>
|
|
1952
|
+
Example return:
|
|
1092
1953
|
|
|
1093
1954
|
```json
|
|
1094
1955
|
[
|
|
@@ -1098,9 +1959,7 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1098
1959
|
"identifier": "catalog",
|
|
1099
1960
|
"attributeSetId": 0,
|
|
1100
1961
|
"localizeInfos": {
|
|
1101
|
-
"
|
|
1102
|
-
"title": "My block"
|
|
1103
|
-
}
|
|
1962
|
+
"title": "My block"
|
|
1104
1963
|
},
|
|
1105
1964
|
"customSettings": {
|
|
1106
1965
|
"sliderDelay": 0,
|
|
@@ -1121,11 +1980,9 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1121
1980
|
"position": 0,
|
|
1122
1981
|
"isSync": false,
|
|
1123
1982
|
"attributeValues": {
|
|
1124
|
-
"
|
|
1125
|
-
"
|
|
1126
|
-
|
|
1127
|
-
"type": "string"
|
|
1128
|
-
}
|
|
1983
|
+
"marker": {
|
|
1984
|
+
"value": "",
|
|
1985
|
+
"type": "string"
|
|
1129
1986
|
}
|
|
1130
1987
|
},
|
|
1131
1988
|
"type": "forNewsPage",
|
|
@@ -1133,6 +1990,56 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1133
1990
|
}
|
|
1134
1991
|
]
|
|
1135
1992
|
```
|
|
1993
|
+
|
|
1994
|
+
<details>
|
|
1995
|
+
<summary>Schema</summary>
|
|
1996
|
+
|
|
1997
|
+
**id:** number <br>
|
|
1998
|
+
*object identifier* <br>
|
|
1999
|
+
example: 1764
|
|
2000
|
+
|
|
2001
|
+
**version** number <br>
|
|
2002
|
+
*object version number* <br>
|
|
2003
|
+
example: 10
|
|
2004
|
+
|
|
2005
|
+
**identifier:** string <br>
|
|
2006
|
+
*text identifier for the record field* <br>
|
|
2007
|
+
example: catalog
|
|
2008
|
+
|
|
2009
|
+
**attributeSetId:** number <br>
|
|
2010
|
+
*attribute set identifier* <br>
|
|
2011
|
+
example: 7
|
|
2012
|
+
|
|
2013
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2014
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2015
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2016
|
+
|
|
2017
|
+
**customSettings:** BlockCustomSettings <br>
|
|
2018
|
+
*custom settings for different types of blocks* <br>
|
|
2019
|
+
example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] }
|
|
2020
|
+
|
|
2021
|
+
**isSync:** boolean <br>
|
|
2022
|
+
*indicator of page indexing (true or false)* <br>
|
|
2023
|
+
example: false
|
|
2024
|
+
|
|
2025
|
+
**attributeValues:** Record<string, string> <br>
|
|
2026
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2027
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
2028
|
+
|
|
2029
|
+
**position:** number <br>
|
|
2030
|
+
*position number for sorting (optional)* <br>
|
|
2031
|
+
example: 192
|
|
2032
|
+
|
|
2033
|
+
**type:** string <br>
|
|
2034
|
+
*Page type* <br>
|
|
2035
|
+
example: forNewsPage
|
|
2036
|
+
Enum:
|
|
2037
|
+
[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
|
|
2038
|
+
|
|
2039
|
+
**templateIdentifier:** string <br>
|
|
2040
|
+
*marker of the template used by the block (can be null)* <br>
|
|
2041
|
+
example: null
|
|
2042
|
+
|
|
1136
2043
|
</details>
|
|
1137
2044
|
|
|
1138
2045
|
|
|
@@ -1144,9 +2051,7 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1144
2051
|
|
|
1145
2052
|
> Get PositionForm objects for a related form by url. Returns an array of PositionForm objects.
|
|
1146
2053
|
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
<summary>Example return:</summary>
|
|
2054
|
+
Example return:
|
|
1150
2055
|
|
|
1151
2056
|
```json
|
|
1152
2057
|
[
|
|
@@ -1157,15 +2062,13 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1157
2062
|
"attributeSetId": 0,
|
|
1158
2063
|
"processingType": "email",
|
|
1159
2064
|
"localizeInfos": {
|
|
1160
|
-
"
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
"script": "0"
|
|
1168
|
-
}
|
|
2065
|
+
"title": "My form",
|
|
2066
|
+
"titleForSite": "",
|
|
2067
|
+
"successMessage": "",
|
|
2068
|
+
"unsuccessMessage": "",
|
|
2069
|
+
"urlAddress": "",
|
|
2070
|
+
"database": "0",
|
|
2071
|
+
"script": "0"
|
|
1169
2072
|
},
|
|
1170
2073
|
"processingData": {},
|
|
1171
2074
|
"position": 0,
|
|
@@ -1199,8 +2102,49 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
|
|
|
1199
2102
|
}
|
|
1200
2103
|
]
|
|
1201
2104
|
```
|
|
1202
|
-
</details>
|
|
1203
2105
|
|
|
2106
|
+
<details>
|
|
2107
|
+
<summary>Schema</summary>
|
|
2108
|
+
|
|
2109
|
+
**id:** number <br>
|
|
2110
|
+
*object identifier* <br>
|
|
2111
|
+
example: 1764
|
|
2112
|
+
|
|
2113
|
+
**version** number <br>
|
|
2114
|
+
*object version number* <br>
|
|
2115
|
+
example: 10
|
|
2116
|
+
|
|
2117
|
+
**identifier:** string <br>
|
|
2118
|
+
*text identifier for the record field* <br>
|
|
2119
|
+
example: catalog
|
|
2120
|
+
|
|
2121
|
+
**attributeSetId:** number <br>
|
|
2122
|
+
*attribute set identifier* <br>
|
|
2123
|
+
example: 7
|
|
2124
|
+
|
|
2125
|
+
**processingType:** string <br>
|
|
2126
|
+
*form processing type* <br>
|
|
2127
|
+
example: email
|
|
2128
|
+
Enum:
|
|
2129
|
+
[ db, email, script ]
|
|
2130
|
+
|
|
2131
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2132
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2133
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2134
|
+
|
|
2135
|
+
**processingData:** <br>
|
|
2136
|
+
*form data*
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
**attributes:** Record<string, string> <br>
|
|
2140
|
+
*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
|
|
2141
|
+
example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]
|
|
2142
|
+
|
|
2143
|
+
**position:** number <br>
|
|
2144
|
+
*position number for sorting (optional)* <br>
|
|
2145
|
+
example: 192
|
|
2146
|
+
|
|
2147
|
+
</details>
|
|
1204
2148
|
|
|
1205
2149
|
### Pages.getConfigPageByUrl(url)
|
|
1206
2150
|
|
|
@@ -1210,9 +2154,7 @@ const value = await Pages.getConfigPageByUrl('shop')
|
|
|
1210
2154
|
|
|
1211
2155
|
> This method retrieves the settings for a specific page based on its URL (url). It returns a Promise that resolves to a ConfigPageDto object with page display settings.
|
|
1212
2156
|
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
<summary>Example return:</summary>
|
|
2157
|
+
Example return:
|
|
1216
2158
|
|
|
1217
2159
|
```json
|
|
1218
2160
|
{
|
|
@@ -1220,6 +2162,17 @@ const value = await Pages.getConfigPageByUrl('shop')
|
|
|
1220
2162
|
"productsPerRow": 10
|
|
1221
2163
|
}
|
|
1222
2164
|
```
|
|
2165
|
+
<details>
|
|
2166
|
+
<summary>Schema</summary>
|
|
2167
|
+
|
|
2168
|
+
**rowsPerPage:** number
|
|
2169
|
+
*Number of rows per page*
|
|
2170
|
+
example: 10
|
|
2171
|
+
|
|
2172
|
+
**productsPerRow** number
|
|
2173
|
+
*Number of products per row*
|
|
2174
|
+
example: 10
|
|
2175
|
+
|
|
1223
2176
|
</details>
|
|
1224
2177
|
|
|
1225
2178
|
|
|
@@ -1231,9 +2184,7 @@ const value = await Pages.searchPage('cup', 'en_US')
|
|
|
1231
2184
|
|
|
1232
2185
|
> This method performs a quick search for page objects based on a text query (name). It returns a Promise that resolves to a ContentIndexedPageDto objects or an empty array []. Get required language parameter.
|
|
1233
2186
|
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
<summary>Example return:</summary>
|
|
2187
|
+
Example return:
|
|
1237
2188
|
|
|
1238
2189
|
```json
|
|
1239
2190
|
[
|
|
@@ -1243,11 +2194,9 @@ const value = await Pages.searchPage('cup', 'en_US')
|
|
|
1243
2194
|
"pageUrl": "string",
|
|
1244
2195
|
"depth": 3,
|
|
1245
2196
|
"localizeInfos": {
|
|
1246
|
-
"
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
"menuTitle": "Catalog"
|
|
1250
|
-
}
|
|
2197
|
+
"title": "Catalog",
|
|
2198
|
+
"content": "Content for catalog",
|
|
2199
|
+
"menuTitle": "Catalog"
|
|
1251
2200
|
},
|
|
1252
2201
|
"isVisible": true,
|
|
1253
2202
|
"position": 192,
|
|
@@ -1255,18 +2204,15 @@ const value = await Pages.searchPage('cup', 'en_US')
|
|
|
1255
2204
|
"templateIdentifier": "my-template",
|
|
1256
2205
|
"attributeSetId": 7,
|
|
1257
2206
|
"attributeValues": {
|
|
1258
|
-
"
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
"value": ""
|
|
1262
|
-
}
|
|
2207
|
+
"marker": "description",
|
|
2208
|
+
"type": "string",
|
|
2209
|
+
"value": ""
|
|
1263
2210
|
},
|
|
1264
2211
|
"isSync": false,
|
|
1265
2212
|
"products": 0
|
|
1266
2213
|
}
|
|
1267
2214
|
]
|
|
1268
2215
|
```
|
|
1269
|
-
</details>
|
|
1270
2216
|
|
|
1271
2217
|
---
|
|
1272
2218
|
|
|
@@ -1377,18 +2323,14 @@ const value = await Products.getProducts('en_US', userQuery)
|
|
|
1377
2323
|
|
|
1378
2324
|
> This method searches for product page objects with pagination and filtering based on the provided query parameters (userQuery). It returns a Promise that resolves to a list of products (IProduct[]).
|
|
1379
2325
|
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
<summary>Example return:</summary>
|
|
2326
|
+
Example return:
|
|
1383
2327
|
|
|
1384
2328
|
```json
|
|
1385
2329
|
[
|
|
1386
2330
|
{
|
|
1387
2331
|
"id": 1764,
|
|
1388
2332
|
"localizeInfos": {
|
|
1389
|
-
"
|
|
1390
|
-
"title": "Product"
|
|
1391
|
-
}
|
|
2333
|
+
"title": "Product"
|
|
1392
2334
|
},
|
|
1393
2335
|
"isVisible": true,
|
|
1394
2336
|
"statusId": 1,
|
|
@@ -1403,17 +2345,71 @@ const value = await Products.getProducts('en_US', userQuery)
|
|
|
1403
2345
|
"templateIdentifier": "my-template",
|
|
1404
2346
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
1405
2347
|
"attributeValues": {
|
|
1406
|
-
"
|
|
1407
|
-
"
|
|
1408
|
-
|
|
1409
|
-
"type": "string"
|
|
1410
|
-
}
|
|
2348
|
+
"marker": {
|
|
2349
|
+
"value": "",
|
|
2350
|
+
"type": "string"
|
|
1411
2351
|
}
|
|
1412
2352
|
},
|
|
1413
2353
|
"position": 1
|
|
1414
2354
|
}
|
|
1415
2355
|
]
|
|
1416
2356
|
```
|
|
2357
|
+
|
|
2358
|
+
<details>
|
|
2359
|
+
<summary>Schema</summary>
|
|
2360
|
+
|
|
2361
|
+
**id:** number <br>
|
|
2362
|
+
*object identifier* <br>
|
|
2363
|
+
example: 1764
|
|
2364
|
+
|
|
2365
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2366
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2367
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2368
|
+
|
|
2369
|
+
**isVisible:** boolean <br>
|
|
2370
|
+
*Page visibility flag* <br>
|
|
2371
|
+
example: true
|
|
2372
|
+
|
|
2373
|
+
**position:** number <br>
|
|
2374
|
+
*position number (for sorting)* <br>
|
|
2375
|
+
example: 192
|
|
2376
|
+
|
|
2377
|
+
**templateIdentifier:** string <br>
|
|
2378
|
+
*custom identifier of the associated template* <br>
|
|
2379
|
+
example: my-template
|
|
2380
|
+
|
|
2381
|
+
**attributeSetId:** number <br>
|
|
2382
|
+
*attribute set identifier* <br>
|
|
2383
|
+
example: 7
|
|
2384
|
+
|
|
2385
|
+
**isSync:** boolean <br>
|
|
2386
|
+
*indicator of page indexing (true or false)* <br>
|
|
2387
|
+
example: false
|
|
2388
|
+
|
|
2389
|
+
**attributeValues:** Record<string, string> <br>
|
|
2390
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2391
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
2392
|
+
|
|
2393
|
+
**statusId:** number <br>
|
|
2394
|
+
*status identifiers of the product page (can be null)* <br>
|
|
2395
|
+
example: 1
|
|
2396
|
+
|
|
2397
|
+
**relatedIds:** array <br>
|
|
2398
|
+
*identifiers of related product pages* <br>
|
|
2399
|
+
example: List [ 1, 2, 3 ]
|
|
2400
|
+
|
|
2401
|
+
**price:** number <br>
|
|
2402
|
+
*price value of the product page taken from the index* <br>
|
|
2403
|
+
example: 0
|
|
2404
|
+
|
|
2405
|
+
**templateIdentifier** string
|
|
2406
|
+
*custom identifier of the associated template*
|
|
2407
|
+
example: my-template
|
|
2408
|
+
|
|
2409
|
+
**shortDescTemplateIdentifier** string <br>
|
|
2410
|
+
*custom identifier of the associated template for short description* <br>
|
|
2411
|
+
example: my-template-short
|
|
2412
|
+
|
|
1417
2413
|
</details>
|
|
1418
2414
|
|
|
1419
2415
|
|
|
@@ -1425,18 +2421,14 @@ const value = await Products.getProductsEmptyPage('en_US', userQuery)
|
|
|
1425
2421
|
|
|
1426
2422
|
> This method searches for product page objects with pagination that do not have a category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
|
|
1427
2423
|
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
<summary>Example return:</summary>
|
|
2424
|
+
Example return:
|
|
1431
2425
|
|
|
1432
2426
|
```json
|
|
1433
2427
|
[
|
|
1434
2428
|
{
|
|
1435
2429
|
"id": 1764,
|
|
1436
2430
|
"localizeInfos": {
|
|
1437
|
-
"
|
|
1438
|
-
"title": "Product"
|
|
1439
|
-
}
|
|
2431
|
+
"title": "Product"
|
|
1440
2432
|
},
|
|
1441
2433
|
"isVisible": true,
|
|
1442
2434
|
"statusId": 1,
|
|
@@ -1451,17 +2443,70 @@ const value = await Products.getProductsEmptyPage('en_US', userQuery)
|
|
|
1451
2443
|
"templateIdentifier": "my-template",
|
|
1452
2444
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
1453
2445
|
"attributeValues": {
|
|
1454
|
-
"
|
|
1455
|
-
"
|
|
1456
|
-
|
|
1457
|
-
"type": "string"
|
|
1458
|
-
}
|
|
2446
|
+
"marker": {
|
|
2447
|
+
"value": "",
|
|
2448
|
+
"type": "string"
|
|
1459
2449
|
}
|
|
1460
2450
|
},
|
|
1461
2451
|
"position": 1
|
|
1462
2452
|
}
|
|
1463
2453
|
]
|
|
1464
2454
|
```
|
|
2455
|
+
<details>
|
|
2456
|
+
<summary>Schema</summary>
|
|
2457
|
+
|
|
2458
|
+
**id:** number <br>
|
|
2459
|
+
*object identifier* <br>
|
|
2460
|
+
example: 1764
|
|
2461
|
+
|
|
2462
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2463
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2464
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2465
|
+
|
|
2466
|
+
**isVisible:** boolean <br>
|
|
2467
|
+
*Page visibility flag* <br>
|
|
2468
|
+
example: true
|
|
2469
|
+
|
|
2470
|
+
**position:** number <br>
|
|
2471
|
+
*position number (for sorting)* <br>
|
|
2472
|
+
example: 192
|
|
2473
|
+
|
|
2474
|
+
**templateIdentifier:** string <br>
|
|
2475
|
+
*custom identifier of the associated template* <br>
|
|
2476
|
+
example: my-template
|
|
2477
|
+
|
|
2478
|
+
**attributeSetId:** number <br>
|
|
2479
|
+
*attribute set identifier* <br>
|
|
2480
|
+
example: 7
|
|
2481
|
+
|
|
2482
|
+
**isSync:** boolean <br>
|
|
2483
|
+
*indicator of page indexing (true or false)* <br>
|
|
2484
|
+
example: false
|
|
2485
|
+
|
|
2486
|
+
**attributeValues:** Record<string, string> <br>
|
|
2487
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2488
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
2489
|
+
|
|
2490
|
+
**statusId:** number <br>
|
|
2491
|
+
*status identifiers of the product page (can be null)* <br>
|
|
2492
|
+
example: 1
|
|
2493
|
+
|
|
2494
|
+
**relatedIds:** array <br>
|
|
2495
|
+
*identifiers of related product pages* <br>
|
|
2496
|
+
example: List [ 1, 2, 3 ]
|
|
2497
|
+
|
|
2498
|
+
**price:** number <br>
|
|
2499
|
+
*price value of the product page taken from the index* <br>
|
|
2500
|
+
example: 0
|
|
2501
|
+
|
|
2502
|
+
**templateIdentifier** string
|
|
2503
|
+
*custom identifier of the associated template*
|
|
2504
|
+
example: my-template
|
|
2505
|
+
|
|
2506
|
+
**shortDescTemplateIdentifier** string <br>
|
|
2507
|
+
*custom identifier of the associated template for short description* <br>
|
|
2508
|
+
example: my-template-short
|
|
2509
|
+
|
|
1465
2510
|
</details>
|
|
1466
2511
|
|
|
1467
2512
|
|
|
@@ -1473,9 +2518,7 @@ const value = await Products.getProductsPageById(1, 'en_US', userQuery)
|
|
|
1473
2518
|
|
|
1474
2519
|
> This method searches for all product page objects with pagination for the selected category based on the page identifier (id). It accepts an optional userQuery parameter to set query parameters for the search. The query parameters include limit, offset, statusMarker, conditionValue, conditionMarker, attributeMarker, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
|
|
1475
2520
|
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
<summary>Example return:</summary>
|
|
2521
|
+
Example return:
|
|
1479
2522
|
|
|
1480
2523
|
```json
|
|
1481
2524
|
{
|
|
@@ -1512,8 +2555,62 @@ const value = await Products.getProductsPageById(1, 'en_US', userQuery)
|
|
|
1512
2555
|
"position": 1
|
|
1513
2556
|
}
|
|
1514
2557
|
```
|
|
1515
|
-
|
|
2558
|
+
<details>
|
|
2559
|
+
<summary>Schema</summary>
|
|
2560
|
+
|
|
2561
|
+
**id:** number <br>
|
|
2562
|
+
*object identifier* <br>
|
|
2563
|
+
example: 1764
|
|
2564
|
+
|
|
2565
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2566
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2567
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2568
|
+
|
|
2569
|
+
**isVisible:** boolean <br>
|
|
2570
|
+
*Page visibility flag* <br>
|
|
2571
|
+
example: true
|
|
2572
|
+
|
|
2573
|
+
**position:** number <br>
|
|
2574
|
+
*position number (for sorting)* <br>
|
|
2575
|
+
example: 192
|
|
2576
|
+
|
|
2577
|
+
**templateIdentifier:** string <br>
|
|
2578
|
+
*custom identifier of the associated template* <br>
|
|
2579
|
+
example: my-template
|
|
2580
|
+
|
|
2581
|
+
**attributeSetId:** number <br>
|
|
2582
|
+
*attribute set identifier* <br>
|
|
2583
|
+
example: 7
|
|
2584
|
+
|
|
2585
|
+
**isSync:** boolean <br>
|
|
2586
|
+
*indicator of page indexing (true or false)* <br>
|
|
2587
|
+
example: false
|
|
2588
|
+
|
|
2589
|
+
**attributeValues:** Record<string, string> <br>
|
|
2590
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2591
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
1516
2592
|
|
|
2593
|
+
**statusId:** number <br>
|
|
2594
|
+
*status identifiers of the product page (can be null)* <br>
|
|
2595
|
+
example: 1
|
|
2596
|
+
|
|
2597
|
+
**relatedIds:** array <br>
|
|
2598
|
+
*identifiers of related product pages* <br>
|
|
2599
|
+
example: List [ 1, 2, 3 ]
|
|
2600
|
+
|
|
2601
|
+
**price:** number <br>
|
|
2602
|
+
*price value of the product page taken from the index* <br>
|
|
2603
|
+
example: 0
|
|
2604
|
+
|
|
2605
|
+
**templateIdentifier** string
|
|
2606
|
+
*custom identifier of the associated template*
|
|
2607
|
+
example: my-template
|
|
2608
|
+
|
|
2609
|
+
**shortDescTemplateIdentifier** string <br>
|
|
2610
|
+
*custom identifier of the associated template for short description* <br>
|
|
2611
|
+
example: my-template-short
|
|
2612
|
+
|
|
2613
|
+
</details>
|
|
1517
2614
|
|
|
1518
2615
|
### Products.getProductsPageByUrl(url, langCode, userQuery)
|
|
1519
2616
|
|
|
@@ -1523,14 +2620,13 @@ const value = await Products.getProductsPageByUrl('cup', 'en_US', userQuery)
|
|
|
1523
2620
|
|
|
1524
2621
|
> This method searches for all product page objects with pagination for the selected category based on the page URL (url). It accepts an optional userQuery parameter to set query parameters for the search. The query parameters include limit, offset, statusMarker, conditionValue, conditionMarker, attributeMarker, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
|
|
1525
2622
|
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
<summary>Example return:</summary>
|
|
2623
|
+
Example return:
|
|
1529
2624
|
|
|
1530
2625
|
```json
|
|
1531
2626
|
{
|
|
1532
2627
|
"id": 1764,
|
|
1533
|
-
"localizeInfos": {
|
|
2628
|
+
"localizeInfos": {
|
|
2629
|
+
"title": "Product"
|
|
1534
2630
|
},
|
|
1535
2631
|
"isVisible": true,
|
|
1536
2632
|
"statusId": 1,
|
|
@@ -1561,8 +2657,62 @@ const value = await Products.getProductsPageByUrl('cup', 'en_US', userQuery)
|
|
|
1561
2657
|
"position": 1
|
|
1562
2658
|
}
|
|
1563
2659
|
```
|
|
1564
|
-
|
|
2660
|
+
<details>
|
|
2661
|
+
<summary>Schema</summary>
|
|
2662
|
+
|
|
2663
|
+
**id:** number <br>
|
|
2664
|
+
*object identifier* <br>
|
|
2665
|
+
example: 1764
|
|
2666
|
+
|
|
2667
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2668
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2669
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2670
|
+
|
|
2671
|
+
**isVisible:** boolean <br>
|
|
2672
|
+
*Page visibility flag* <br>
|
|
2673
|
+
example: true
|
|
2674
|
+
|
|
2675
|
+
**position:** number <br>
|
|
2676
|
+
*position number (for sorting)* <br>
|
|
2677
|
+
example: 192
|
|
1565
2678
|
|
|
2679
|
+
**templateIdentifier:** string <br>
|
|
2680
|
+
*custom identifier of the associated template* <br>
|
|
2681
|
+
example: my-template
|
|
2682
|
+
|
|
2683
|
+
**attributeSetId:** number <br>
|
|
2684
|
+
*attribute set identifier* <br>
|
|
2685
|
+
example: 7
|
|
2686
|
+
|
|
2687
|
+
**isSync:** boolean <br>
|
|
2688
|
+
*indicator of page indexing (true or false)* <br>
|
|
2689
|
+
example: false
|
|
2690
|
+
|
|
2691
|
+
**attributeValues:** Record<string, string> <br>
|
|
2692
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2693
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
2694
|
+
|
|
2695
|
+
**statusId:** number <br>
|
|
2696
|
+
*status identifiers of the product page (can be null)* <br>
|
|
2697
|
+
example: 1
|
|
2698
|
+
|
|
2699
|
+
**relatedIds:** array <br>
|
|
2700
|
+
*identifiers of related product pages* <br>
|
|
2701
|
+
example: List [ 1, 2, 3 ]
|
|
2702
|
+
|
|
2703
|
+
**price:** number <br>
|
|
2704
|
+
*price value of the product page taken from the index* <br>
|
|
2705
|
+
example: 0
|
|
2706
|
+
|
|
2707
|
+
**templateIdentifier** string
|
|
2708
|
+
*custom identifier of the associated template*
|
|
2709
|
+
example: my-template
|
|
2710
|
+
|
|
2711
|
+
**shortDescTemplateIdentifier** string <br>
|
|
2712
|
+
*custom identifier of the associated template for short description* <br>
|
|
2713
|
+
example: my-template-short
|
|
2714
|
+
|
|
2715
|
+
</details>
|
|
1566
2716
|
|
|
1567
2717
|
### Products.getRelatedProductsById(id, langCode, userQuery)
|
|
1568
2718
|
|
|
@@ -1572,17 +2722,13 @@ const value = await Products.getRelatedProductsById(1, 'en_US', {limit:20, offse
|
|
|
1572
2722
|
|
|
1573
2723
|
> This method retrieves all related product page objects for a specific product based on its identifier (id) from the API. It accepts an optional userQuery parameter for additional query parameters such as limit, offset, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
|
|
1574
2724
|
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
<summary>Example return:</summary>
|
|
2725
|
+
Example return:
|
|
1578
2726
|
|
|
1579
2727
|
```json
|
|
1580
2728
|
{
|
|
1581
2729
|
"id": 1764,
|
|
1582
2730
|
"localizeInfos": {
|
|
1583
|
-
"
|
|
1584
|
-
"title": "Product"
|
|
1585
|
-
}
|
|
2731
|
+
"title": "Product"
|
|
1586
2732
|
},
|
|
1587
2733
|
"isVisible": true,
|
|
1588
2734
|
"statusId": 1,
|
|
@@ -1597,18 +2743,70 @@ const value = await Products.getRelatedProductsById(1, 'en_US', {limit:20, offse
|
|
|
1597
2743
|
"templateIdentifier": "my-template",
|
|
1598
2744
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
1599
2745
|
"attributeValues": {
|
|
1600
|
-
"
|
|
1601
|
-
"
|
|
1602
|
-
|
|
1603
|
-
"type": "string"
|
|
1604
|
-
}
|
|
2746
|
+
"marker": {
|
|
2747
|
+
"value": "",
|
|
2748
|
+
"type": "string"
|
|
1605
2749
|
}
|
|
1606
2750
|
},
|
|
1607
2751
|
"position": 1
|
|
1608
2752
|
}
|
|
1609
2753
|
```
|
|
1610
|
-
|
|
2754
|
+
<details>
|
|
2755
|
+
<summary>Schema</summary>
|
|
2756
|
+
|
|
2757
|
+
**id:** number <br>
|
|
2758
|
+
*object identifier* <br>
|
|
2759
|
+
example: 1764
|
|
2760
|
+
|
|
2761
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2762
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2763
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2764
|
+
|
|
2765
|
+
**isVisible:** boolean <br>
|
|
2766
|
+
*Page visibility flag* <br>
|
|
2767
|
+
example: true
|
|
2768
|
+
|
|
2769
|
+
**position:** number <br>
|
|
2770
|
+
*position number (for sorting)* <br>
|
|
2771
|
+
example: 192
|
|
2772
|
+
|
|
2773
|
+
**templateIdentifier:** string <br>
|
|
2774
|
+
*custom identifier of the associated template* <br>
|
|
2775
|
+
example: my-template
|
|
2776
|
+
|
|
2777
|
+
**attributeSetId:** number <br>
|
|
2778
|
+
*attribute set identifier* <br>
|
|
2779
|
+
example: 7
|
|
2780
|
+
|
|
2781
|
+
**isSync:** boolean <br>
|
|
2782
|
+
*indicator of page indexing (true or false)* <br>
|
|
2783
|
+
example: false
|
|
2784
|
+
|
|
2785
|
+
**attributeValues:** Record<string, string> <br>
|
|
2786
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2787
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
2788
|
+
|
|
2789
|
+
**statusId:** number <br>
|
|
2790
|
+
*status identifiers of the product page (can be null)* <br>
|
|
2791
|
+
example: 1
|
|
1611
2792
|
|
|
2793
|
+
**relatedIds:** array <br>
|
|
2794
|
+
*identifiers of related product pages* <br>
|
|
2795
|
+
example: List [ 1, 2, 3 ]
|
|
2796
|
+
|
|
2797
|
+
**price:** number <br>
|
|
2798
|
+
*price value of the product page taken from the index* <br>
|
|
2799
|
+
example: 0
|
|
2800
|
+
|
|
2801
|
+
**templateIdentifier** string
|
|
2802
|
+
*custom identifier of the associated template*
|
|
2803
|
+
example: my-template
|
|
2804
|
+
|
|
2805
|
+
**shortDescTemplateIdentifier** string <br>
|
|
2806
|
+
*custom identifier of the associated template for short description* <br>
|
|
2807
|
+
example: my-template-short
|
|
2808
|
+
|
|
2809
|
+
</details>
|
|
1612
2810
|
|
|
1613
2811
|
### Products.getProductById(id, langCode)
|
|
1614
2812
|
|
|
@@ -1618,17 +2816,13 @@ const value = await Products.getProductById(1, 'en_US')
|
|
|
1618
2816
|
|
|
1619
2817
|
> This method retrieves a single product object based on its identifier (id) from the API. It returns a Promise that resolves to a ContentIndexedProductDto object for the product.
|
|
1620
2818
|
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
<summary>Example return:</summary>
|
|
2819
|
+
Example return:
|
|
1624
2820
|
|
|
1625
2821
|
```json
|
|
1626
2822
|
{
|
|
1627
2823
|
"id": 1764,
|
|
1628
2824
|
"localizeInfos": {
|
|
1629
|
-
"
|
|
1630
|
-
"title": "Product"
|
|
1631
|
-
}
|
|
2825
|
+
"title": "Product"
|
|
1632
2826
|
},
|
|
1633
2827
|
"isVisible": true,
|
|
1634
2828
|
"statusId": 1,
|
|
@@ -1643,16 +2837,69 @@ const value = await Products.getProductById(1, 'en_US')
|
|
|
1643
2837
|
"templateIdentifier": "my-template",
|
|
1644
2838
|
"shortDescTemplateIdentifier": "my-template-short",
|
|
1645
2839
|
"attributeValues": {
|
|
1646
|
-
"
|
|
1647
|
-
"
|
|
1648
|
-
|
|
1649
|
-
"type": "string"
|
|
1650
|
-
}
|
|
2840
|
+
"marker": {
|
|
2841
|
+
"value": "",
|
|
2842
|
+
"type": "string"
|
|
1651
2843
|
}
|
|
1652
2844
|
},
|
|
1653
2845
|
"position": 1
|
|
1654
2846
|
}
|
|
1655
2847
|
```
|
|
2848
|
+
<details>
|
|
2849
|
+
<summary>Schema</summary>
|
|
2850
|
+
|
|
2851
|
+
**id:** number <br>
|
|
2852
|
+
*object identifier* <br>
|
|
2853
|
+
example: 1764
|
|
2854
|
+
|
|
2855
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2856
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2857
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2858
|
+
|
|
2859
|
+
**isVisible:** boolean <br>
|
|
2860
|
+
*Page visibility flag* <br>
|
|
2861
|
+
example: true
|
|
2862
|
+
|
|
2863
|
+
**position:** number <br>
|
|
2864
|
+
*position number (for sorting)* <br>
|
|
2865
|
+
example: 192
|
|
2866
|
+
|
|
2867
|
+
**templateIdentifier:** string <br>
|
|
2868
|
+
*custom identifier of the associated template* <br>
|
|
2869
|
+
example: my-template
|
|
2870
|
+
|
|
2871
|
+
**attributeSetId:** number <br>
|
|
2872
|
+
*attribute set identifier* <br>
|
|
2873
|
+
example: 7
|
|
2874
|
+
|
|
2875
|
+
**isSync:** boolean <br>
|
|
2876
|
+
*indicator of page indexing (true or false)* <br>
|
|
2877
|
+
example: false
|
|
2878
|
+
|
|
2879
|
+
**attributeValues:** Record<string, string> <br>
|
|
2880
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
2881
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
2882
|
+
|
|
2883
|
+
**statusId:** number <br>
|
|
2884
|
+
*status identifiers of the product page (can be null)* <br>
|
|
2885
|
+
example: 1
|
|
2886
|
+
|
|
2887
|
+
**relatedIds:** array <br>
|
|
2888
|
+
*identifiers of related product pages* <br>
|
|
2889
|
+
example: List [ 1, 2, 3 ]
|
|
2890
|
+
|
|
2891
|
+
**price:** number <br>
|
|
2892
|
+
*price value of the product page taken from the index* <br>
|
|
2893
|
+
example: 0
|
|
2894
|
+
|
|
2895
|
+
**templateIdentifier** string
|
|
2896
|
+
*custom identifier of the associated template*
|
|
2897
|
+
example: my-template
|
|
2898
|
+
|
|
2899
|
+
**shortDescTemplateIdentifier** string <br>
|
|
2900
|
+
*custom identifier of the associated template for short description* <br>
|
|
2901
|
+
example: my-template-short
|
|
2902
|
+
|
|
1656
2903
|
</details>
|
|
1657
2904
|
|
|
1658
2905
|
|
|
@@ -1689,9 +2936,7 @@ Example body:
|
|
|
1689
2936
|
|
|
1690
2937
|
> This method filters product page objects with pagination and multiple filtering based on the provided data request body. The data parameter should be an array of {attributeMarker:string,conditionMarker:string,conditionValue:number,pageId:number}.
|
|
1691
2938
|
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
<summary>Example return:</summary>
|
|
2939
|
+
Example return:
|
|
1695
2940
|
|
|
1696
2941
|
```json
|
|
1697
2942
|
{
|
|
@@ -1728,8 +2973,62 @@ Example body:
|
|
|
1728
2973
|
"position": 1
|
|
1729
2974
|
}
|
|
1730
2975
|
```
|
|
1731
|
-
|
|
2976
|
+
<details>
|
|
2977
|
+
<summary>Schema</summary>
|
|
2978
|
+
|
|
2979
|
+
**id:** number <br>
|
|
2980
|
+
*object identifier* <br>
|
|
2981
|
+
example: 1764
|
|
2982
|
+
|
|
2983
|
+
**localizeInfos:** Record<string, any> <br>
|
|
2984
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
2985
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
2986
|
+
|
|
2987
|
+
**isVisible:** boolean <br>
|
|
2988
|
+
*Page visibility flag* <br>
|
|
2989
|
+
example: true
|
|
2990
|
+
|
|
2991
|
+
**position:** number <br>
|
|
2992
|
+
*position number (for sorting)* <br>
|
|
2993
|
+
example: 192
|
|
2994
|
+
|
|
2995
|
+
**templateIdentifier:** string <br>
|
|
2996
|
+
*custom identifier of the associated template* <br>
|
|
2997
|
+
example: my-template
|
|
2998
|
+
|
|
2999
|
+
**attributeSetId:** number <br>
|
|
3000
|
+
*attribute set identifier* <br>
|
|
3001
|
+
example: 7
|
|
3002
|
+
|
|
3003
|
+
**isSync:** boolean <br>
|
|
3004
|
+
*indicator of page indexing (true or false)* <br>
|
|
3005
|
+
example: false
|
|
3006
|
+
|
|
3007
|
+
**attributeValues:** Record<string, string> <br>
|
|
3008
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
3009
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
3010
|
+
|
|
3011
|
+
**statusId:** number <br>
|
|
3012
|
+
*status identifiers of the product page (can be null)* <br>
|
|
3013
|
+
example: 1
|
|
3014
|
+
|
|
3015
|
+
**relatedIds:** array <br>
|
|
3016
|
+
*identifiers of related product pages* <br>
|
|
3017
|
+
example: List [ 1, 2, 3 ]
|
|
3018
|
+
|
|
3019
|
+
**price:** number <br>
|
|
3020
|
+
*price value of the product page taken from the index* <br>
|
|
3021
|
+
example: 0
|
|
3022
|
+
|
|
3023
|
+
**templateIdentifier** string
|
|
3024
|
+
*custom identifier of the associated template*
|
|
3025
|
+
example: my-template
|
|
3026
|
+
|
|
3027
|
+
**shortDescTemplateIdentifier** string <br>
|
|
3028
|
+
*custom identifier of the associated template for short description* <br>
|
|
3029
|
+
example: my-template-short
|
|
1732
3030
|
|
|
3031
|
+
</details>
|
|
1733
3032
|
|
|
1734
3033
|
### Products.searchProduct(name, langCode)
|
|
1735
3034
|
|
|
@@ -1739,9 +3038,7 @@ const value = await Products.searchProduct('cup', 'en_US')
|
|
|
1739
3038
|
|
|
1740
3039
|
> This method performs a quick search for product page objects based on a text query name. The search is performed on the title field of the localizeInfos object, taking the specified lang language code into consideration. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
|
|
1741
3040
|
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
<summary>Example return:</summary>
|
|
3041
|
+
Example return:
|
|
1745
3042
|
|
|
1746
3043
|
```json
|
|
1747
3044
|
[
|
|
@@ -1780,6 +3077,61 @@ const value = await Products.searchProduct('cup', 'en_US')
|
|
|
1780
3077
|
}
|
|
1781
3078
|
]
|
|
1782
3079
|
```
|
|
3080
|
+
<details>
|
|
3081
|
+
<summary>Schema</summary>
|
|
3082
|
+
|
|
3083
|
+
**id:** number <br>
|
|
3084
|
+
*object identifier* <br>
|
|
3085
|
+
example: 1764
|
|
3086
|
+
|
|
3087
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3088
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3089
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3090
|
+
|
|
3091
|
+
**isVisible:** boolean <br>
|
|
3092
|
+
*Page visibility flag* <br>
|
|
3093
|
+
example: true
|
|
3094
|
+
|
|
3095
|
+
**position:** number <br>
|
|
3096
|
+
*position number (for sorting)* <br>
|
|
3097
|
+
example: 192
|
|
3098
|
+
|
|
3099
|
+
**templateIdentifier:** string <br>
|
|
3100
|
+
*custom identifier of the associated template* <br>
|
|
3101
|
+
example: my-template
|
|
3102
|
+
|
|
3103
|
+
**attributeSetId:** number <br>
|
|
3104
|
+
*attribute set identifier* <br>
|
|
3105
|
+
example: 7
|
|
3106
|
+
|
|
3107
|
+
**isSync:** boolean <br>
|
|
3108
|
+
*indicator of page indexing (true or false)* <br>
|
|
3109
|
+
example: false
|
|
3110
|
+
|
|
3111
|
+
**attributeValues:** Record<string, string> <br>
|
|
3112
|
+
*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
|
|
3113
|
+
example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
|
|
3114
|
+
|
|
3115
|
+
**statusId:** number <br>
|
|
3116
|
+
*status identifiers of the product page (can be null)* <br>
|
|
3117
|
+
example: 1
|
|
3118
|
+
|
|
3119
|
+
**relatedIds:** array <br>
|
|
3120
|
+
*identifiers of related product pages* <br>
|
|
3121
|
+
example: List [ 1, 2, 3 ]
|
|
3122
|
+
|
|
3123
|
+
**price:** number <br>
|
|
3124
|
+
*price value of the product page taken from the index* <br>
|
|
3125
|
+
example: 0
|
|
3126
|
+
|
|
3127
|
+
**templateIdentifier** string
|
|
3128
|
+
*custom identifier of the associated template*
|
|
3129
|
+
example: my-template
|
|
3130
|
+
|
|
3131
|
+
**shortDescTemplateIdentifier** string <br>
|
|
3132
|
+
*custom identifier of the associated template for short description* <br>
|
|
3133
|
+
example: my-template-short
|
|
3134
|
+
|
|
1783
3135
|
</details>
|
|
1784
3136
|
|
|
1785
3137
|
---
|
|
@@ -1800,9 +3152,7 @@ const value = await ProductStatuses.getProductStatuses()
|
|
|
1800
3152
|
|
|
1801
3153
|
> This method searches for all product status objects from the API. It returns a Promise that resolves to an array of product status objects.
|
|
1802
3154
|
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
<summary>Example return:</summary>
|
|
3155
|
+
Example return:
|
|
1806
3156
|
|
|
1807
3157
|
```json
|
|
1808
3158
|
[
|
|
@@ -1812,15 +3162,34 @@ const value = await ProductStatuses.getProductStatuses()
|
|
|
1812
3162
|
"version": 10,
|
|
1813
3163
|
"identifier": "catalog",
|
|
1814
3164
|
"localizeInfos": {
|
|
1815
|
-
"
|
|
1816
|
-
"title": "Status 1"
|
|
1817
|
-
}
|
|
3165
|
+
"title": "Status 1"
|
|
1818
3166
|
}
|
|
1819
3167
|
}
|
|
1820
3168
|
]
|
|
1821
3169
|
```
|
|
1822
|
-
|
|
3170
|
+
<details>
|
|
3171
|
+
<summary>Schema</summary>
|
|
1823
3172
|
|
|
3173
|
+
**id:** number <br>
|
|
3174
|
+
*object identifier* <br>
|
|
3175
|
+
example: 1764
|
|
3176
|
+
|
|
3177
|
+
**updatedDate:** string($date-time) <br>
|
|
3178
|
+
*object's date of modification* <br>
|
|
3179
|
+
|
|
3180
|
+
**version** number <br>
|
|
3181
|
+
*object's version number of modification* <br>
|
|
3182
|
+
example: 10
|
|
3183
|
+
|
|
3184
|
+
**identifier:** string <br>
|
|
3185
|
+
*textual identifier for a field in the record* <br>
|
|
3186
|
+
example: catalog
|
|
3187
|
+
|
|
3188
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3189
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3190
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3191
|
+
|
|
3192
|
+
</details>
|
|
1824
3193
|
|
|
1825
3194
|
### ProductStatuses.getProductStatusesById(id)
|
|
1826
3195
|
|
|
@@ -1830,9 +3199,7 @@ const value = await ProductStatuses.getProductStatusesById(1)
|
|
|
1830
3199
|
|
|
1831
3200
|
> This method searches for a product status object based on its identifier (id) from the API. It returns a Promise that resolves to a product status object.
|
|
1832
3201
|
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
<summary>Example return:</summary>
|
|
3202
|
+
Example return:
|
|
1836
3203
|
|
|
1837
3204
|
```json
|
|
1838
3205
|
{
|
|
@@ -1841,14 +3208,33 @@ const value = await ProductStatuses.getProductStatusesById(1)
|
|
|
1841
3208
|
"version": 10,
|
|
1842
3209
|
"identifier": "catalog",
|
|
1843
3210
|
"localizeInfos": {
|
|
1844
|
-
"
|
|
1845
|
-
"title": "Status 1"
|
|
1846
|
-
}
|
|
3211
|
+
"title": "Status 1"
|
|
1847
3212
|
}
|
|
1848
3213
|
}
|
|
1849
3214
|
```
|
|
1850
|
-
|
|
3215
|
+
<details>
|
|
3216
|
+
<summary>Schema</summary>
|
|
3217
|
+
|
|
3218
|
+
**id:** number <br>
|
|
3219
|
+
*object identifier* <br>
|
|
3220
|
+
example: 1764
|
|
3221
|
+
|
|
3222
|
+
**updatedDate:** string($date-time) <br>
|
|
3223
|
+
*object's date of modification* <br>
|
|
3224
|
+
|
|
3225
|
+
**version** number <br>
|
|
3226
|
+
*object's version number of modification* <br>
|
|
3227
|
+
example: 10
|
|
3228
|
+
|
|
3229
|
+
**identifier:** string <br>
|
|
3230
|
+
*textual identifier for a field in the record* <br>
|
|
3231
|
+
example: catalog
|
|
3232
|
+
|
|
3233
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3234
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3235
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
1851
3236
|
|
|
3237
|
+
</details>
|
|
1852
3238
|
|
|
1853
3239
|
### ProductStatuses.getProductsByStatusMarker(marker)
|
|
1854
3240
|
|
|
@@ -1858,9 +3244,7 @@ const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
|
|
|
1858
3244
|
|
|
1859
3245
|
> This method searches for a product status object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a product status object.
|
|
1860
3246
|
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
<summary>Example return:</summary>
|
|
3247
|
+
Example return:
|
|
1864
3248
|
|
|
1865
3249
|
```json
|
|
1866
3250
|
{
|
|
@@ -1869,14 +3253,33 @@ const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
|
|
|
1869
3253
|
"version": 10,
|
|
1870
3254
|
"identifier": "catalog",
|
|
1871
3255
|
"localizeInfos": {
|
|
1872
|
-
"
|
|
1873
|
-
"title": "Status 1"
|
|
1874
|
-
}
|
|
3256
|
+
"title": "Status 1"
|
|
1875
3257
|
}
|
|
1876
3258
|
}
|
|
1877
3259
|
```
|
|
1878
|
-
|
|
3260
|
+
<details>
|
|
3261
|
+
<summary>Schema</summary>
|
|
3262
|
+
|
|
3263
|
+
**id:** number <br>
|
|
3264
|
+
*object identifier* <br>
|
|
3265
|
+
example: 1764
|
|
3266
|
+
|
|
3267
|
+
**updatedDate:** string($date-time) <br>
|
|
3268
|
+
*object's date of modification* <br>
|
|
1879
3269
|
|
|
3270
|
+
**version** number <br>
|
|
3271
|
+
*object's version number of modification* <br>
|
|
3272
|
+
example: 10
|
|
3273
|
+
|
|
3274
|
+
**identifier:** string <br>
|
|
3275
|
+
*textual identifier for a field in the record* <br>
|
|
3276
|
+
example: catalog
|
|
3277
|
+
|
|
3278
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3279
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3280
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3281
|
+
|
|
3282
|
+
</details>
|
|
1880
3283
|
|
|
1881
3284
|
### ProductStatuses.validateMarker(marker)
|
|
1882
3285
|
|
|
@@ -1886,14 +3289,11 @@ const value = await ProductStatuses.validateMarker('marker')
|
|
|
1886
3289
|
|
|
1887
3290
|
> This method checks the existence of a textual identifier (marker). It takes a marker parameter as input, representing the product marker to validate. It returns a Promise that resolves to true if the textual identifier (marker) exists or false if it doesn't.
|
|
1888
3291
|
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
<summary>Example return:</summary>
|
|
3292
|
+
Example return:
|
|
1892
3293
|
|
|
1893
3294
|
```json
|
|
1894
3295
|
true
|
|
1895
3296
|
```
|
|
1896
|
-
</details>
|
|
1897
3297
|
|
|
1898
3298
|
---
|
|
1899
3299
|
|
|
@@ -1936,9 +3336,7 @@ const value = await Templates.getAllTemplates()
|
|
|
1936
3336
|
|
|
1937
3337
|
> This method retrieves all template objects grouped by types from the API. It returns a Promise that resolves to an object GroupedTemplatesObject, which contains an array of template objects.
|
|
1938
3338
|
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
<summary>Example return:</summary>
|
|
3339
|
+
Example return:
|
|
1942
3340
|
|
|
1943
3341
|
```json
|
|
1944
3342
|
[
|
|
@@ -1953,9 +3351,7 @@ const value = await Templates.getAllTemplates()
|
|
|
1953
3351
|
},
|
|
1954
3352
|
"generalTypeId": 4,
|
|
1955
3353
|
"localizeInfos": {
|
|
1956
|
-
"
|
|
1957
|
-
"title": "Page template"
|
|
1958
|
-
}
|
|
3354
|
+
"title": "Page template"
|
|
1959
3355
|
},
|
|
1960
3356
|
"position": 0,
|
|
1961
3357
|
"positionId": 12,
|
|
@@ -1963,8 +3359,50 @@ const value = await Templates.getAllTemplates()
|
|
|
1963
3359
|
}
|
|
1964
3360
|
]
|
|
1965
3361
|
```
|
|
1966
|
-
|
|
3362
|
+
<details>
|
|
3363
|
+
<summary>Schema</summary>
|
|
3364
|
+
|
|
3365
|
+
**id:** number <br>
|
|
3366
|
+
*object identifier* <br>
|
|
3367
|
+
example: 1764
|
|
3368
|
+
|
|
3369
|
+
**updatedDate:** string($date-time) <br>
|
|
3370
|
+
*object's date of modification* <br>
|
|
1967
3371
|
|
|
3372
|
+
**version** number <br>
|
|
3373
|
+
*object's version number of modification* <br>
|
|
3374
|
+
example: 10
|
|
3375
|
+
|
|
3376
|
+
**identifier:** string <br>
|
|
3377
|
+
*textual identifier for a field in the record* <br>
|
|
3378
|
+
example: catalog
|
|
3379
|
+
|
|
3380
|
+
**generalType:**: object <br>
|
|
3381
|
+
*object type* <br>
|
|
3382
|
+
example: OrderedMap { "id": 4, "type": "forCatalogPages" }
|
|
3383
|
+
|
|
3384
|
+
**generalTypeId:** number
|
|
3385
|
+
*type identifier*
|
|
3386
|
+
example: 4
|
|
3387
|
+
|
|
3388
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3389
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3390
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3391
|
+
|
|
3392
|
+
**position** object <br>
|
|
3393
|
+
*position number* <br>
|
|
3394
|
+
example: 0
|
|
3395
|
+
|
|
3396
|
+
|
|
3397
|
+
**positionId:** number <br>
|
|
3398
|
+
*position object identifier* <br>
|
|
3399
|
+
example: 12
|
|
3400
|
+
|
|
3401
|
+
**generalTypeName** string <br>
|
|
3402
|
+
*example: forProductPreview* <br>
|
|
3403
|
+
general type name
|
|
3404
|
+
|
|
3405
|
+
</details>
|
|
1968
3406
|
|
|
1969
3407
|
### Templates.getTemplateByType(type)
|
|
1970
3408
|
|
|
@@ -1974,9 +3412,7 @@ const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
|
1974
3412
|
|
|
1975
3413
|
> 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.
|
|
1976
3414
|
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
<summary>Example return:</summary>
|
|
3415
|
+
Example return:
|
|
1980
3416
|
|
|
1981
3417
|
```json
|
|
1982
3418
|
[
|
|
@@ -1991,9 +3427,7 @@ const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
|
1991
3427
|
},
|
|
1992
3428
|
"generalTypeId": 4,
|
|
1993
3429
|
"localizeInfos": {
|
|
1994
|
-
"
|
|
1995
|
-
"title": "Page template"
|
|
1996
|
-
}
|
|
3430
|
+
"title": "Page template"
|
|
1997
3431
|
},
|
|
1998
3432
|
"position": 0,
|
|
1999
3433
|
"positionId": 12,
|
|
@@ -2001,8 +3435,52 @@ const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
|
2001
3435
|
}
|
|
2002
3436
|
]
|
|
2003
3437
|
```
|
|
3438
|
+
<details>
|
|
3439
|
+
<summary>Schema</summary>
|
|
3440
|
+
|
|
3441
|
+
**id:** number <br>
|
|
3442
|
+
*object identifier* <br>
|
|
3443
|
+
example: 1764
|
|
3444
|
+
|
|
3445
|
+
**updatedDate:** string($date-time) <br>
|
|
3446
|
+
*object's date of modification* <br>
|
|
3447
|
+
|
|
3448
|
+
**version** number <br>
|
|
3449
|
+
*object's version number of modification* <br>
|
|
3450
|
+
example: 10
|
|
3451
|
+
|
|
3452
|
+
**identifier:** string <br>
|
|
3453
|
+
*textual identifier for a field in the record* <br>
|
|
3454
|
+
example: catalog
|
|
3455
|
+
|
|
3456
|
+
**generalType:**: object <br>
|
|
3457
|
+
*object type* <br>
|
|
3458
|
+
example: OrderedMap { "id": 4, "type": "forCatalogPages" }
|
|
3459
|
+
|
|
3460
|
+
**generalTypeId:** number
|
|
3461
|
+
*type identifier*
|
|
3462
|
+
example: 4
|
|
3463
|
+
|
|
3464
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3465
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3466
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3467
|
+
|
|
3468
|
+
**position** object <br>
|
|
3469
|
+
*position number* <br>
|
|
3470
|
+
example: 0
|
|
3471
|
+
|
|
3472
|
+
|
|
3473
|
+
**positionId:** number <br>
|
|
3474
|
+
*position object identifier* <br>
|
|
3475
|
+
example: 12
|
|
3476
|
+
|
|
3477
|
+
**generalTypeName** string <br>
|
|
3478
|
+
*example: forProductPreview* <br>
|
|
3479
|
+
general type name
|
|
3480
|
+
|
|
2004
3481
|
</details>
|
|
2005
3482
|
|
|
3483
|
+
---
|
|
2006
3484
|
|
|
2007
3485
|
## TemplatePreviews
|
|
2008
3486
|
|
|
@@ -2018,9 +3496,7 @@ const value = await TemplatePreviews.getTemplatePreviews()
|
|
|
2018
3496
|
|
|
2019
3497
|
> This method retrieves all template objects from the API. It returns a Promise that resolves to an array of TemplatePreviewsEntity template objects.
|
|
2020
3498
|
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
<summary>Example return:</summary>
|
|
3499
|
+
Example return:
|
|
2024
3500
|
|
|
2025
3501
|
```json
|
|
2026
3502
|
[
|
|
@@ -2052,14 +3528,47 @@ const value = await TemplatePreviews.getTemplatePreviews()
|
|
|
2052
3528
|
}
|
|
2053
3529
|
},
|
|
2054
3530
|
"localizeInfos": {
|
|
2055
|
-
"
|
|
2056
|
-
"title": "Page Template"
|
|
2057
|
-
}
|
|
3531
|
+
"title": "Page Template"
|
|
2058
3532
|
},
|
|
2059
3533
|
"position": 0
|
|
2060
3534
|
}
|
|
2061
3535
|
]
|
|
2062
3536
|
```
|
|
3537
|
+
<details>
|
|
3538
|
+
<summary>Schema</summary>
|
|
3539
|
+
|
|
3540
|
+
**id:** number <br>
|
|
3541
|
+
*object identifier* <br>
|
|
3542
|
+
example: 1764
|
|
3543
|
+
|
|
3544
|
+
**updatedDate:** string($date-time) <br>
|
|
3545
|
+
*object's date of modification* <br>
|
|
3546
|
+
|
|
3547
|
+
**version** number <br>
|
|
3548
|
+
*object's version number of modification* <br>
|
|
3549
|
+
example: 10
|
|
3550
|
+
|
|
3551
|
+
**identifier:** string <br>
|
|
3552
|
+
*textual identifier for a field in the record* <br>
|
|
3553
|
+
example: catalog
|
|
3554
|
+
|
|
3555
|
+
**proportion** ITemplateProportionType <br>
|
|
3556
|
+
*template proportion parameters* <br>
|
|
3557
|
+
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" } }
|
|
3558
|
+
|
|
3559
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3560
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3561
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3562
|
+
|
|
3563
|
+
**position** object <br>
|
|
3564
|
+
*position number* <br>
|
|
3565
|
+
example: 0
|
|
3566
|
+
|
|
3567
|
+
|
|
3568
|
+
**positionId:** number <br>
|
|
3569
|
+
*position object identifier* <br>
|
|
3570
|
+
example: 12
|
|
3571
|
+
|
|
2063
3572
|
</details>
|
|
2064
3573
|
|
|
2065
3574
|
|
|
@@ -2071,9 +3580,7 @@ const value = await TemplatePreviews.getTemplatePreviewById(1)
|
|
|
2071
3580
|
|
|
2072
3581
|
> This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
|
|
2073
3582
|
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
<summary>Example return:</summary>
|
|
3583
|
+
Example return:
|
|
2077
3584
|
|
|
2078
3585
|
```json
|
|
2079
3586
|
{
|
|
@@ -2104,16 +3611,48 @@ const value = await TemplatePreviews.getTemplatePreviewById(1)
|
|
|
2104
3611
|
}
|
|
2105
3612
|
},
|
|
2106
3613
|
"localizeInfos": {
|
|
2107
|
-
"
|
|
2108
|
-
"title": "Page Template"
|
|
2109
|
-
}
|
|
3614
|
+
"title": "Page Template"
|
|
2110
3615
|
},
|
|
2111
3616
|
"position": 0
|
|
2112
3617
|
}
|
|
2113
3618
|
```
|
|
2114
|
-
|
|
3619
|
+
<details>
|
|
3620
|
+
<summary>Schema</summary>
|
|
3621
|
+
|
|
3622
|
+
**id:** number <br>
|
|
3623
|
+
*object identifier* <br>
|
|
3624
|
+
example: 1764
|
|
3625
|
+
|
|
3626
|
+
**updatedDate:** string($date-time) <br>
|
|
3627
|
+
*object's date of modification* <br>
|
|
3628
|
+
|
|
3629
|
+
**version** number <br>
|
|
3630
|
+
*object's version number of modification* <br>
|
|
3631
|
+
example: 10
|
|
3632
|
+
|
|
3633
|
+
**identifier:** string <br>
|
|
3634
|
+
*textual identifier for a field in the record* <br>
|
|
3635
|
+
example: catalog
|
|
3636
|
+
|
|
3637
|
+
**proportion** ITemplateProportionType <br>
|
|
3638
|
+
*template proportion parameters* <br>
|
|
3639
|
+
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" } }
|
|
3640
|
+
|
|
3641
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3642
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3643
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3644
|
+
|
|
3645
|
+
**position** object <br>
|
|
3646
|
+
*position number* <br>
|
|
3647
|
+
example: 0
|
|
2115
3648
|
|
|
2116
3649
|
|
|
3650
|
+
**positionId:** number <br>
|
|
3651
|
+
*position object identifier* <br>
|
|
3652
|
+
example: 12
|
|
3653
|
+
|
|
3654
|
+
</details>
|
|
3655
|
+
|
|
2117
3656
|
### TemplatePreviews.getTemplatesPreviewByMarker(marker)
|
|
2118
3657
|
|
|
2119
3658
|
```js
|
|
@@ -2122,11 +3661,7 @@ const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
|
|
|
2122
3661
|
|
|
2123
3662
|
> This method retrieves a single template object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
|
|
2124
3663
|
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
<summary>Example return:</summary>
|
|
2128
|
-
|
|
2129
|
-
|
|
3664
|
+
Example return:
|
|
2130
3665
|
|
|
2131
3666
|
```json
|
|
2132
3667
|
{
|
|
@@ -2157,11 +3692,47 @@ const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
|
|
|
2157
3692
|
}
|
|
2158
3693
|
},
|
|
2159
3694
|
"localizeInfos": {
|
|
2160
|
-
"
|
|
2161
|
-
"title": "Page Template"
|
|
2162
|
-
}
|
|
3695
|
+
"title": "Page Template"
|
|
2163
3696
|
},
|
|
2164
3697
|
"position": 0
|
|
2165
3698
|
}
|
|
2166
3699
|
```
|
|
2167
|
-
|
|
3700
|
+
<details>
|
|
3701
|
+
<summary>Schema</summary>
|
|
3702
|
+
|
|
3703
|
+
**id:** number <br>
|
|
3704
|
+
*object identifier* <br>
|
|
3705
|
+
example: 1764
|
|
3706
|
+
|
|
3707
|
+
**updatedDate:** string($date-time) <br>
|
|
3708
|
+
*object's date of modification* <br>
|
|
3709
|
+
|
|
3710
|
+
**version** number <br>
|
|
3711
|
+
*object's version number of modification* <br>
|
|
3712
|
+
example: 10
|
|
3713
|
+
|
|
3714
|
+
**identifier:** string <br>
|
|
3715
|
+
*textual identifier for a field in the record* <br>
|
|
3716
|
+
example: catalog
|
|
3717
|
+
|
|
3718
|
+
**proportion** ITemplateProportionType <br>
|
|
3719
|
+
*template proportion parameters* <br>
|
|
3720
|
+
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" } }
|
|
3721
|
+
|
|
3722
|
+
**localizeInfos:** Record<string, any> <br>
|
|
3723
|
+
*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
3724
|
+
example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
|
|
3725
|
+
|
|
3726
|
+
**position** object <br>
|
|
3727
|
+
*position number* <br>
|
|
3728
|
+
example: 0
|
|
3729
|
+
|
|
3730
|
+
|
|
3731
|
+
**positionId:** number <br>
|
|
3732
|
+
*position object identifier* <br>
|
|
3733
|
+
example: 12
|
|
3734
|
+
|
|
3735
|
+
</details>
|
|
3736
|
+
---
|
|
3737
|
+
|
|
3738
|
+
|