oneentry 1.0.84 → 1.0.85

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 CHANGED
@@ -850,27 +850,33 @@ const value = await Blocks.getBlocks('forTextBlock')
850
850
  Example return:
851
851
 
852
852
  ```json
853
- [
854
- {
855
- "id": 1,
856
- "localizeInfos": {
857
- "title": "Block"
858
- },
859
- "version": 0,
860
- "position": 1,
861
- "identifier": "block",
862
- "type": "forTextBlock",
863
- "templateIdentifier": null,
864
- "isVisible": true,
865
- "attributeValues": {},
866
- "countElementsPerRow": 0
867
- }
868
- ]
853
+ {
854
+ "total": 100,
855
+ "items": [
856
+ {
857
+ "id": 1,
858
+ "localizeInfos": {
859
+ "title": "Block"
860
+ },
861
+ "version": 0,
862
+ "position": 1,
863
+ "identifier": "block",
864
+ "type": "forTextBlock",
865
+ "templateIdentifier": null,
866
+ "isVisible": true,
867
+ "attributeValues": {}
868
+ }
869
+ ]
870
+ }
869
871
  ```
870
872
 
871
873
  <details>
872
874
  <summary>Schema</summary>
873
875
 
876
+ **total:** number <br>
877
+ *total number of found records* <br>
878
+ example: 100 <br>
879
+
874
880
  **id:** number <br>
875
881
  *object identifier*
876
882
  example: 1764 <br>
@@ -918,7 +924,7 @@ example: null <br>
918
924
  ---
919
925
 
920
926
 
921
- ### Blocks.getBlockByMarker(marker, langCode)
927
+ ### Blocks.getBlockByMarker(marker, langCode, offset, limit)
922
928
 
923
929
  ```js
924
930
  const value = await Blocks.getBlockByMarker('my-marker')
@@ -930,24 +936,87 @@ Example return:
930
936
 
931
937
  ```json
932
938
  {
933
- "id": 1,
934
- "localizeInfos": {
935
- "title": "Block"
936
- },
937
- "version": 0,
938
- "position": 1,
939
- "identifier": "block",
940
- "type": "forTextBlock",
941
- "countElementsPerRow": 0,
942
- "templateIdentifier": null,
943
- "isVisible": true,
944
- "attributeValues": {}
939
+ "total": 1,
940
+ "items": [
941
+ {
942
+ "id": 5,
943
+ "localizeInfos": {
944
+ "title": "Similar"
945
+ },
946
+ "version": 0,
947
+ "position": 1,
948
+ "identifier": "similar",
949
+ "type": "forSimilarProductBlock",
950
+ "templateIdentifier": "block-template",
951
+ "isVisible": true,
952
+ "attributeValues": {
953
+ "block-text": {
954
+ "type": "string",
955
+ "value": "",
956
+ "position": 0,
957
+ "isProductPreview": false
958
+ }
959
+ },
960
+ "countElementsPerRow": "1",
961
+ "quantity": "2",
962
+ "similarProducts": [
963
+ {
964
+ "id": 2,
965
+ "localizeInfos": {
966
+ "title": "Box"
967
+ },
968
+ "statusIdentifier": "sold",
969
+ "statusLocalizeInfos": {
970
+ "title": "Sold"
971
+ },
972
+ "attributeSetIdentifier": "products",
973
+ "position": 2,
974
+ "templateIdentifier": null,
975
+ "shortDescTemplateIdentifier": null,
976
+ "price": 148,
977
+ "additional": {
978
+ "prices": {
979
+ "min": 120,
980
+ "max": 150
981
+ }
982
+ },
983
+ "sku": null,
984
+ "isSync": true,
985
+ "attributeValues": {
986
+ "price": {
987
+ "type": "integer",
988
+ "value": 148,
989
+ "position": 1,
990
+ "isProductPreview": false
991
+ },
992
+ "product-name": {
993
+ "type": "string",
994
+ "value": "Box text",
995
+ "position": 0,
996
+ "isProductPreview": false
997
+ },
998
+ "currency_products": {
999
+ "type": "string",
1000
+ "value": "$",
1001
+ "position": 2,
1002
+ "isProductPreview": false
1003
+ }
1004
+ },
1005
+ "isVisible": true
1006
+ }
1007
+ ]
1008
+ }
1009
+ ]
945
1010
  }
946
1011
  ```
947
1012
 
948
1013
  <details>
949
1014
  <summary>Schema</summary>
950
1015
 
1016
+ **total:** number <br>
1017
+ *total number of found records* <br>
1018
+ example: 100 <br>
1019
+
951
1020
  **id:** number <br>
952
1021
  *object identifier*
953
1022
  example: 1764 <br>
@@ -994,125 +1063,6 @@ example: null <br>
994
1063
  </details>
995
1064
  ---
996
1065
 
997
- ### Blocks.getSimilarProducts(marker, langCode, offset, limit)
998
-
999
-
1000
- ```js
1001
- const value = await Blocks.getSimilarProducts('my-marker', 'en_US')
1002
- ```
1003
-
1004
- > This method return array of similar products from block by block marker.
1005
-
1006
- Example return:
1007
-
1008
- ```json
1009
- [
1010
- {
1011
- "id": 2,
1012
- "localizeInfos": {
1013
- "title": "Box"
1014
- },
1015
- "statusIdentifier": "sold",
1016
- "statusLocalizeInfos": {
1017
- "title": "Sold"
1018
- },
1019
- "attributeSetIdentifier": "products",
1020
- "position": 1,
1021
- "templateIdentifier": null,
1022
- "shortDescTemplateIdentifier": null,
1023
- "price": 148,
1024
- "additional": {
1025
- "prices": {
1026
- "min": 120,
1027
- "max": 150
1028
- }
1029
- },
1030
- "sku": null,
1031
- "isSync": true,
1032
- "attributeValues": {
1033
- "price": {
1034
- "type": "integer",
1035
- "value": "148",
1036
- "position": 1,
1037
- "isProductPreview": false
1038
- },
1039
- "product-name": {
1040
- "type": "string",
1041
- "value": "Box text",
1042
- "position": 0,
1043
- "isProductPreview": false
1044
- },
1045
- "currency_products": {
1046
- "type": "string",
1047
- "value": "$",
1048
- "position": 2,
1049
- "isProductPreview": false
1050
- }
1051
- },
1052
- "isVisible": true
1053
- }
1054
- ]
1055
- ```
1056
-
1057
-
1058
-
1059
- ### Blocks.getProductsByBlockMarker(marker, langCode, offset, limit)
1060
-
1061
- ```js
1062
- const value = await Blocks.getProductsByBlockMarker('my-marker', 'en_US')
1063
- ```
1064
-
1065
- > This method return array of products from block by block marker.
1066
-
1067
- Example return:
1068
-
1069
- ```json
1070
- [
1071
- {
1072
- "id": 3,
1073
- "localizeInfos": {
1074
- "title": "Product"
1075
- },
1076
- "statusIdentifier": null,
1077
- "statusLocalizeInfos": {},
1078
- "attributeSetIdentifier": "products",
1079
- "position": 1,
1080
- "templateIdentifier": null,
1081
- "shortDescTemplateIdentifier": null,
1082
- "price": 120,
1083
- "additional": {
1084
- "prices": {
1085
- "min": 120,
1086
- "max": 150
1087
- }
1088
- },
1089
- "sku": null,
1090
- "isSync": true,
1091
- "attributeValues": {
1092
- "price": {
1093
- "type": "integer",
1094
- "value": "120",
1095
- "position": 1,
1096
- "isProductPreview": false
1097
- },
1098
- "product-name": {
1099
- "type": "string",
1100
- "value": "Prod",
1101
- "position": 0,
1102
- "isProductPreview": false
1103
- },
1104
- "currency_products": {
1105
- "type": "string",
1106
- "value": "$",
1107
- "position": 2,
1108
- "isProductPreview": false
1109
- }
1110
- },
1111
- "isVisible": true
1112
- }
1113
- ]
1114
- ```
1115
-
1116
1066
  ### Blocks.searchBlock(name, langCode)
1117
1067
 
1118
1068
  ```js
@@ -1679,15 +1629,20 @@ Example return:
1679
1629
 
1680
1630
  ```json
1681
1631
  {
1682
- "id": 1764,
1683
- "formIdentifier": "my-form",
1684
- "time": "2023-02-12 10:56",
1685
- "formData": {
1686
- "marker": "name_1",
1687
- "value": "Name",
1688
- "type": "string"
1689
- },
1690
- "attributeSetIdentifier": "test-form"
1632
+ "total": 1,
1633
+ "items": [
1634
+ {
1635
+ "id": 1764,
1636
+ "formIdentifier": "my-form",
1637
+ "time": "2023-02-12 10:56",
1638
+ "formData": {
1639
+ "marker": "name_1",
1640
+ "value": "Name",
1641
+ "type": "string"
1642
+ },
1643
+ "attributeSetIdentifier": "test-form"
1644
+ }
1645
+ ]
1691
1646
  }
1692
1647
  ```
1693
1648
  ---
@@ -1695,6 +1650,10 @@ Example return:
1695
1650
  <details>
1696
1651
  <summary>Schema</summary>
1697
1652
 
1653
+ **total:** number <br>
1654
+ *total number of found records* <br>
1655
+ example: 100 <br>
1656
+
1698
1657
  **id:** number <br>
1699
1658
  *object identifier* <br>
1700
1659
  example: 1764 <br>
@@ -1730,21 +1689,31 @@ Example return:
1730
1689
 
1731
1690
  ```json
1732
1691
  {
1733
- "id": 1764,
1734
- "formIdentifier": "my-form",
1735
- "time": "2023-02-12 10:56",
1736
- "formData": {
1737
- "marker": "name_1",
1738
- "value": "Name",
1739
- "type": "string"
1740
- },
1741
- "attributeSetIdentifier": "test-form"
1692
+ "total": 1,
1693
+ "items": [
1694
+ {
1695
+ "id": 1764,
1696
+ "formIdentifier": "my-form",
1697
+ "time": "2023-02-12 10:56",
1698
+ "formData": {
1699
+ "marker": "name_1",
1700
+ "value": "Name",
1701
+ "type": "string"
1702
+ },
1703
+ "attributeSetIdentifier": "test-form"
1704
+ }
1705
+ ]
1742
1706
  }
1743
1707
  ```
1744
1708
 
1745
1709
  <details>
1746
1710
  <summary>Schema</summary>
1747
1711
 
1712
+
1713
+ **total:** number <br>
1714
+ *total number of found records* <br>
1715
+ example: 100 <br>
1716
+
1748
1717
  **id:** number <br>
1749
1718
  *object identifier* <br>
1750
1719
  example: 1764 <br>
@@ -2264,10 +2233,10 @@ example: [{ "identifier": "p1" }] <br>
2264
2233
 
2265
2234
  </details>
2266
2235
 
2267
- ### Orders.getAllOrders(langCode, limit, offset)
2236
+ ### Orders.getAllOrdersStorage(langCode, limit, offset)
2268
2237
 
2269
2238
  ```js
2270
- const value = await Orders.getAllOrders()
2239
+ const value = await Orders.getAllOrdersStorage()
2271
2240
  ```
2272
2241
 
2273
2242
  > This method getting all the order storage objects. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
@@ -2332,48 +2301,56 @@ const value = await Orders.getAllOrdersByMarker('my-order')
2332
2301
  Example return:
2333
2302
 
2334
2303
  ```json
2335
- [
2336
- {
2337
- "id": 1764,
2338
- "statusIdentifier": "inprogress",
2339
- "formIdentifier": "order-form",
2340
- "formData": [
2341
- {
2342
- "marker": "naimenovanie_1",
2343
- "type": "string",
2344
- "value": "Name"
2345
- }
2346
- ],
2347
- "products": [
2348
- {
2349
- "id": 1,
2350
- "title": "Laminate Floorwood Maxima, 9811 Oak Mistral",
2351
- "sku": null,
2352
- "price": "1.00",
2353
- "quantity": 10,
2354
- "previewImage": [
2355
- {
2356
- "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2357
- "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2358
- "size": 296391,
2359
- "previewLink": ""
2360
- }
2361
- ]
2362
- }
2363
- ],
2364
- "totalSum": "12.00",
2365
- "currency": "USD",
2366
- "createdDate": "2023-01-01 12:12",
2367
- "paymentAccountIdentifier": "payment-1",
2368
- "paymentAccountLocalizeInfos": {"title": "Account 1"
2369
- },
2370
- "isHistory": true
2371
- }
2372
- ]
2304
+ {
2305
+ "total": 100,
2306
+ "items": [
2307
+ {
2308
+ "id": 1764,
2309
+ "statusIdentifier": "inprogress",
2310
+ "formIdentifier": "order-form",
2311
+ "formData": [
2312
+ {
2313
+ "marker": "name_1",
2314
+ "type": "string",
2315
+ "value": "Name"
2316
+ }
2317
+ ],
2318
+ "products": [
2319
+ {
2320
+ "id": 1,
2321
+ "title": "Laminate Floorwood Maxima, 9811 Oak Mistral",
2322
+ "sku": null,
2323
+ "price": "1.00",
2324
+ "quantity": 10,
2325
+ "previewImage": [
2326
+ {
2327
+ "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2328
+ "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2329
+ "size": 296391,
2330
+ "previewLink": ""
2331
+ }
2332
+ ]
2333
+ }
2334
+ ],
2335
+ "totalSum": "12.00",
2336
+ "currency": "USD",
2337
+ "createdDate": "2023-01-01 12:12",
2338
+ "paymentAccountIdentifier": "payment-1",
2339
+ "paymentAccountLocalizeInfos": {"title": "Account 1"
2340
+ },
2341
+ "isHistory": true
2342
+ }
2343
+ ]
2344
+
2345
+ }
2373
2346
  ```
2374
2347
  <details>
2375
2348
  <summary>Schema</summary>
2376
2349
 
2350
+ **total:** number <br>
2351
+ *total number of found records* <br>
2352
+ example: 100 <br>
2353
+
2377
2354
  **statusIdentifier:** string <br>
2378
2355
  *text identifier of the order status* <br>
2379
2356
  example: inprogress <br>
@@ -3255,18 +3232,21 @@ const value = await Payments.getSessions()
3255
3232
  Example return:
3256
3233
 
3257
3234
  ```json
3258
- [
3259
- {
3260
- "id": 1764,
3261
- "updatedDate": "2024-06-21T09:51:57.785Z",
3262
- "type": "session",
3263
- "status": "completed",
3264
- "orderId": 1,
3265
- "paymentAccountId": 1,
3266
- "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
3267
- "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
3268
- }
3269
- ]
3235
+ {
3236
+ "total": 100,
3237
+ "items": [
3238
+ {
3239
+ "id": 1764,
3240
+ "updatedDate": "2024-06-21T09:51:57.785Z",
3241
+ "type": "session",
3242
+ "status": "completed",
3243
+ "orderId": 1,
3244
+ "paymentAccountId": 1,
3245
+ "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
3246
+ "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
3247
+ }
3248
+ ]
3249
+ }
3270
3250
  ```
3271
3251
  <details>
3272
3252
  <summary>Schema</summary>
@@ -3738,55 +3718,62 @@ const value = await Products.getProducts(body)
3738
3718
  Example return:
3739
3719
 
3740
3720
  ```json
3741
- [
3742
- {
3743
- "id": 4,
3744
- "localizeInfos": {
3745
- "title": "Cosmo"
3746
- },
3747
- "statusIdentifier": null,
3748
- "statusLocalizeInfos": {},
3749
- "attributeSetIdentifier": "products",
3750
- "position": 1,
3751
- "templateIdentifier": null,
3752
- "isPositionLocked": false,
3753
- "shortDescTemplateIdentifier": null,
3754
- "price": 150,
3755
- "additional": {
3756
- "prices": {
3757
- "min": 120,
3758
- "max": 150
3759
- }
3760
- },
3761
- "sku": null,
3762
- "isSync": true,
3763
- "attributeValues": {
3764
- "price": {
3765
- "type": "integer",
3766
- "value": "150",
3767
- "position": 1,
3768
- "isProductPreview": false
3721
+ {
3722
+ "total": 100,
3723
+ "items": [
3724
+ {
3725
+ "id": 4,
3726
+ "localizeInfos": {
3727
+ "title": "Cosmo"
3769
3728
  },
3770
- "product-name": {
3771
- "type": "string",
3772
- "value": "Cosmo",
3773
- "position": 0,
3774
- "isProductPreview": false
3729
+ "statusIdentifier": null,
3730
+ "statusLocalizeInfos": {},
3731
+ "attributeSetIdentifier": "products",
3732
+ "position": 1,
3733
+ "templateIdentifier": null,
3734
+ "isPositionLocked": false,
3735
+ "shortDescTemplateIdentifier": null,
3736
+ "price": 150,
3737
+ "additional": {
3738
+ "prices": {
3739
+ "min": 120,
3740
+ "max": 150
3741
+ }
3775
3742
  },
3776
- "currency_products": {
3777
- "type": "string",
3778
- "value": "",
3779
- "position": 2,
3780
- "isProductPreview": false
3781
- }
3782
- },
3783
- "isVisible": true
3784
- }
3785
- ]
3743
+ "sku": null,
3744
+ "isSync": true,
3745
+ "attributeValues": {
3746
+ "price": {
3747
+ "type": "integer",
3748
+ "value": 150,
3749
+ "position": 1,
3750
+ "isProductPreview": false
3751
+ },
3752
+ "product-name": {
3753
+ "type": "string",
3754
+ "value": "Cosmo",
3755
+ "position": 0,
3756
+ "isProductPreview": false
3757
+ },
3758
+ "currency_products": {
3759
+ "type": "string",
3760
+ "value": "",
3761
+ "position": 2,
3762
+ "isProductPreview": false
3763
+ }
3764
+ },
3765
+ "isVisible": true
3766
+ }
3767
+ ]
3768
+ }
3786
3769
  ```
3787
3770
  <details>
3788
3771
  <summary>Schema</summary>
3789
3772
 
3773
+ **total:** number <br>
3774
+ *total number of found records* <br>
3775
+ example: 100 <br>
3776
+
3790
3777
  **id:** number <br>
3791
3778
  *object identifier* <br>
3792
3779
  example: 1764 <br>
@@ -3869,55 +3856,64 @@ const value = await Products.getProductsEmptyPage('en_US', userQuery)
3869
3856
  Example return:
3870
3857
 
3871
3858
  ```json
3872
- [
3873
- {
3874
- "id": 4,
3875
- "localizeInfos": {
3876
- "title": "Cosmo"
3877
- },
3878
- "statusIdentifier": null,
3879
- "statusLocalizeInfos": {},
3880
- "attributeSetIdentifier": "products",
3881
- "position": 1,
3882
- "templateIdentifier": null,
3883
- "isPositionLocked": false,
3884
- "shortDescTemplateIdentifier": null,
3885
- "price": 150,
3886
- "additional": {
3887
- "prices": {
3888
- "min": 120,
3889
- "max": 150
3890
- }
3891
- },
3892
- "sku": null,
3893
- "isSync": true,
3894
- "attributeValues": {
3895
- "price": {
3896
- "type": "integer",
3897
- "value": "150",
3898
- "position": 1,
3899
- "isProductPreview": false
3859
+ {
3860
+ "total": 100,
3861
+ "itema": [
3862
+ {
3863
+ "id": 4,
3864
+ "localizeInfos": {
3865
+ "title": "Cosmo"
3900
3866
  },
3901
- "product-name": {
3902
- "type": "string",
3903
- "value": "Cosmo",
3904
- "position": 0,
3905
- "isProductPreview": false
3867
+ "statusIdentifier": null,
3868
+ "statusLocalizeInfos": {},
3869
+ "attributeSetIdentifier": "products",
3870
+ "position": 1,
3871
+ "templateIdentifier": null,
3872
+ "isPositionLocked": false,
3873
+ "shortDescTemplateIdentifier": null,
3874
+ "price": 150,
3875
+ "additional": {
3876
+ "prices": {
3877
+ "min": 120,
3878
+ "max": 150
3879
+ }
3906
3880
  },
3907
- "currency_products": {
3908
- "type": "string",
3909
- "value": "",
3910
- "position": 2,
3911
- "isProductPreview": false
3912
- }
3913
- },
3914
- "isVisible": true
3915
- }
3916
- ]
3881
+ "sku": null,
3882
+ "isSync": true,
3883
+ "attributeValues": {
3884
+ "price": {
3885
+ "type": "integer",
3886
+ "value": 150,
3887
+ "position": 1,
3888
+ "isProductPreview": false
3889
+ },
3890
+ "product-name": {
3891
+ "type": "string",
3892
+ "value": "Cosmo",
3893
+ "position": 0,
3894
+ "isProductPreview": false
3895
+ },
3896
+ "currency_products": {
3897
+ "type": "string",
3898
+ "value": "",
3899
+ "position": 2,
3900
+ "isProductPreview": false
3901
+ }
3902
+ },
3903
+ "isVisible": true
3904
+ }
3905
+ ]
3906
+
3907
+ }
3917
3908
  ```
3909
+
3918
3910
  <details>
3919
3911
  <summary>Schema</summary>
3920
3912
 
3913
+ **total:** number <br>
3914
+ *total number of found records* <br>
3915
+ example: 100 <br>
3916
+
3921
3917
  **id:** number <br>
3922
3918
  *object identifier* <br>
3923
3919
  example: 1764 <br>
@@ -4020,58 +4016,66 @@ const value = await Products.getProductsByPageId(1764, body)
4020
4016
  Example return:
4021
4017
 
4022
4018
  ```json
4023
- [
4024
- {
4025
- "id": 2,
4026
- "localizeInfos": {
4027
- "title": "Box"
4028
- },
4029
- "statusIdentifier": "sold",
4030
- "statusLocalizeInfos": {
4031
- "title": "Sold"
4032
- },
4033
- "attributeSetIdentifier": "products",
4034
- "position": 3,
4035
- "templateIdentifier": null,
4036
- "isPositionLocked": false,
4037
- "shortDescTemplateIdentifier": null,
4038
- "price": 148,
4039
- "additional": {
4040
- "prices": {
4041
- "min": 120,
4042
- "max": 150
4043
- }
4044
- },
4045
- "sku": null,
4046
- "isSync": true,
4047
- "attributeValues": {
4048
- "price": {
4049
- "type": "integer",
4050
- "value": "148",
4051
- "position": 1,
4052
- "isProductPreview": false
4019
+ {
4020
+ "total": 100,
4021
+ "items": [
4022
+ {
4023
+ "id": 2,
4024
+ "localizeInfos": {
4025
+ "title": "Box"
4053
4026
  },
4054
- "product-name": {
4055
- "type": "string",
4056
- "value": "Box text",
4057
- "position": 0,
4058
- "isProductPreview": false
4027
+ "statusIdentifier": "sold",
4028
+ "statusLocalizeInfos": {
4029
+ "title": "Sold"
4059
4030
  },
4060
- "currency_products": {
4061
- "type": "string",
4062
- "value": "$",
4063
- "position": 2,
4064
- "isProductPreview": false
4065
- }
4066
- },
4067
- "isVisible": true,
4068
- "isPositionLocked": false
4069
- }
4070
- ]
4031
+ "attributeSetIdentifier": "products",
4032
+ "position": 3,
4033
+ "templateIdentifier": null,
4034
+ "isPositionLocked": false,
4035
+ "shortDescTemplateIdentifier": null,
4036
+ "price": 148,
4037
+ "additional": {
4038
+ "prices": {
4039
+ "min": 120,
4040
+ "max": 150
4041
+ }
4042
+ },
4043
+ "sku": null,
4044
+ "isSync": true,
4045
+ "attributeValues": {
4046
+ "price": {
4047
+ "type": "integer",
4048
+ "value": 148,
4049
+ "position": 1,
4050
+ "isProductPreview": false
4051
+ },
4052
+ "product-name": {
4053
+ "type": "string",
4054
+ "value": "Box text",
4055
+ "position": 0,
4056
+ "isProductPreview": false
4057
+ },
4058
+ "currency_products": {
4059
+ "type": "string",
4060
+ "value": "$",
4061
+ "position": 2,
4062
+ "isProductPreview": false
4063
+ }
4064
+ },
4065
+ "isVisible": true,
4066
+ "isPositionLocked": false
4067
+ }
4068
+ ]
4069
+
4070
+ }
4071
4071
  ```
4072
4072
  <details>
4073
4073
  <summary>Schema</summary>
4074
4074
 
4075
+ **total:** number <br>
4076
+ *total number of found records* <br>
4077
+ example: 100 <br>
4078
+
4075
4079
  **id:** number <br>
4076
4080
  *object identifier* <br>
4077
4081
  example: 1764 <br>
@@ -4154,16 +4158,23 @@ const value = await Products.getProductsPriceByPageUrl('catalog')
4154
4158
  Example return:
4155
4159
 
4156
4160
  ```json
4157
- [
4158
- {
4159
- "id": 1764,
4160
- "price": 0
4161
- }
4162
- ]
4161
+ {
4162
+ "total": 100,
4163
+ "items": [
4164
+ {
4165
+ "id": 1764,
4166
+ "price": 0
4167
+ }
4168
+ ]
4169
+ }
4163
4170
  ```
4164
4171
  <details>
4165
4172
  <summary>Schema</summary>
4166
4173
 
4174
+ **total:** number <br>
4175
+ *total number of found records* <br>
4176
+ example: 100 <br>
4177
+
4167
4178
  **id:** number <br>
4168
4179
  *object identifier* <br>
4169
4180
  example: 1764 <br>
@@ -4206,57 +4217,65 @@ const value = await Products.getProductsByPageUrl('catalog', body)
4206
4217
  Example return:
4207
4218
 
4208
4219
  ```json
4209
- [
4210
- {
4211
- "id": 2,
4212
- "localizeInfos": {
4213
- "title": "Box"
4214
- },
4215
- "statusIdentifier": "sold",
4216
- "statusLocalizeInfos": {
4217
- "title": "Sold"
4218
- },
4219
- "attributeSetIdentifier": "products",
4220
- "position": 3,
4221
- "templateIdentifier": null,
4222
- "shortDescTemplateIdentifier": null,
4223
- "price": 148,
4224
- "additional": {
4225
- "prices": {
4226
- "min": 120,
4227
- "max": 150
4228
- }
4229
- },
4230
- "sku": null,
4231
- "isSync": true,
4232
- "attributeValues": {
4233
- "price": {
4234
- "type": "integer",
4235
- "value": "148",
4236
- "position": 1,
4237
- "isProductPreview": false
4220
+ {
4221
+ "total": 100,
4222
+ "items": [
4223
+ {
4224
+ "id": 2,
4225
+ "localizeInfos": {
4226
+ "title": "Box"
4238
4227
  },
4239
- "product-name": {
4240
- "type": "string",
4241
- "value": "Box text",
4242
- "position": 0,
4243
- "isProductPreview": false
4228
+ "statusIdentifier": "sold",
4229
+ "statusLocalizeInfos": {
4230
+ "title": "Sold"
4244
4231
  },
4245
- "currency_products": {
4246
- "type": "string",
4247
- "value": "$",
4248
- "position": 2,
4249
- "isProductPreview": false
4250
- }
4251
- },
4252
- "isVisible": true,
4253
- "isPositionLocked": false
4254
- }
4255
- ]
4232
+ "attributeSetIdentifier": "products",
4233
+ "position": 3,
4234
+ "templateIdentifier": null,
4235
+ "shortDescTemplateIdentifier": null,
4236
+ "price": 148,
4237
+ "additional": {
4238
+ "prices": {
4239
+ "min": 120,
4240
+ "max": 150
4241
+ }
4242
+ },
4243
+ "sku": null,
4244
+ "isSync": true,
4245
+ "attributeValues": {
4246
+ "price": {
4247
+ "type": "integer",
4248
+ "value": 148,
4249
+ "position": 1,
4250
+ "isProductPreview": false
4251
+ },
4252
+ "product-name": {
4253
+ "type": "string",
4254
+ "value": "Box text",
4255
+ "position": 0,
4256
+ "isProductPreview": false
4257
+ },
4258
+ "currency_products": {
4259
+ "type": "string",
4260
+ "value": "$",
4261
+ "position": 2,
4262
+ "isProductPreview": false
4263
+ }
4264
+ },
4265
+ "isVisible": true,
4266
+ "isPositionLocked": false
4267
+ }
4268
+ ]
4269
+
4270
+ }
4256
4271
  ```
4257
4272
  <details>
4258
4273
  <summary>Schema</summary>
4259
4274
 
4275
+ **total:** number <br>
4276
+ *total number of found records* <br>
4277
+ example: 100 <br>
4278
+
4260
4279
  **id:** number <br>
4261
4280
  *object identifier* <br>
4262
4281
  example: 1764 <br>
@@ -4340,55 +4359,65 @@ Example return:
4340
4359
 
4341
4360
  ```json
4342
4361
  {
4343
- "id": 2,
4344
- "localizeInfos": {
4345
- "title": "Box"
4346
- },
4347
- "statusIdentifier": "sold",
4348
- "statusLocalizeInfos": {
4349
- "title": "Sold"
4350
- },
4351
- "attributeSetIdentifier": "products",
4352
- "position": 3,
4353
- "templateIdentifier": null,
4354
- "isPositionLocked": false,
4355
- "shortDescTemplateIdentifier": null,
4356
- "price": 148,
4357
- "additional": {
4358
- "prices": {
4359
- "min": 120,
4360
- "max": 150
4361
- }
4362
- },
4363
- "sku": null,
4364
- "isSync": true,
4365
- "attributeValues": {
4366
- "price": {
4367
- "type": "integer",
4368
- "value": "148",
4369
- "position": 1,
4370
- "isProductPreview": false
4371
- },
4372
- "product-name": {
4373
- "type": "string",
4374
- "value": "Box text",
4375
- "position": 0,
4376
- "isProductPreview": false
4377
- },
4378
- "currency_products": {
4379
- "type": "string",
4380
- "value": "$",
4381
- "position": 2,
4382
- "isProductPreview": false
4362
+ "total": 100,
4363
+ "items": [
4364
+ {
4365
+ "id": 2,
4366
+ "localizeInfos": {
4367
+ "title": "Box"
4368
+ },
4369
+ "statusIdentifier": "sold",
4370
+ "statusLocalizeInfos": {
4371
+ "title": "Sold"
4372
+ },
4373
+ "attributeSetIdentifier": "products",
4374
+ "position": 3,
4375
+ "templateIdentifier": null,
4376
+ "isPositionLocked": false,
4377
+ "shortDescTemplateIdentifier": null,
4378
+ "price": 148,
4379
+ "additional": {
4380
+ "prices": {
4381
+ "min": 120,
4382
+ "max": 150
4383
+ }
4384
+ },
4385
+ "sku": null,
4386
+ "isSync": true,
4387
+ "attributeValues": {
4388
+ "price": {
4389
+ "type": "integer",
4390
+ "value": 148,
4391
+ "position": 1,
4392
+ "isProductPreview": false
4393
+ },
4394
+ "product-name": {
4395
+ "type": "string",
4396
+ "value": "Box text",
4397
+ "position": 0,
4398
+ "isProductPreview": false
4399
+ },
4400
+ "currency_products": {
4401
+ "type": "string",
4402
+ "value": "$",
4403
+ "position": 2,
4404
+ "isProductPreview": false
4405
+ }
4406
+ },
4407
+ "isVisible": true,
4408
+ "isPositionLocked": false
4383
4409
  }
4384
- },
4385
- "isVisible": true,
4386
- "isPositionLocked": false
4410
+
4411
+ ]
4387
4412
  }
4388
4413
  ```
4389
4414
  <details>
4390
4415
  <summary>Schema</summary>
4391
4416
 
4417
+ **total:** number <br>
4418
+ *total number of found records* <br>
4419
+ example: 100 <br>
4420
+
4392
4421
  **id:** number <br>
4393
4422
  *object identifier* <br>
4394
4423
  example: 1764 <br>