-
Notifications
You must be signed in to change notification settings - Fork 10
/
descriptions.yml
3815 lines (2544 loc) · 153 KB
/
descriptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
".components.schemas.Criteria": >
Criteria to query entities.
".paths./salutation.post": >
Fetches salutations with a criteria obj.
".components.schemas.Cart.properties.id": >
Unique identity of cart.
".components.schemas.Cart.properties.errors.properties.key": >
Unique key for every message.
".components.schemas.Cart.properties.errors.properties.level": >
Types of level - Notice, warning and error.
".components.schemas.Cart.properties.errors.properties.message": >
A persistent error passed from the shopping cart calculation processes to the user end.
".components.schemas.Cart.properties.transactions.properties.paymentMethodId": >
Unique identity of payment method.
".components.schemas.Cart.properties.modified": >
It signifies any changes to cart.
".components.schemas.SalesChannelContext.properties.currentCustomerGroup.properties.name": >
Name of customer group to which the customer belongs within the specific sales channel they are currently interacting with.
".components.schemas.SalesChannelContext.properties.currentCustomerGroup.properties.displayGross": >
When `true`, product's gross price is displayed for that customer group who belongs to the specific sales channel they are currently interacting with.
".components.schemas.SalesChannelContext.properties.currency.properties.isoCode": >
Standard international three digit code to represent currency in a given sales channel. For example, USD.
".components.schemas.SalesChannelContext.properties.currency.properties.factor": >
Currency exchange rate in a specific sales channel the customer is currently interacting with.
".components.schemas.SalesChannelContext.properties.currency.properties.symbol": >
A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $ in a given sales channel.
".components.schemas.SalesChannelContext.properties.currency.properties.shortName": >
Acronym for international currencies, for example, USD in a given sales channel.
".components.schemas.SalesChannelContext.properties.currency.properties.name": >
Full name of the currency in a given sales channel. For example, US-Dollar.
".components.schemas.SalesChannelContext.properties.currency.properties.position": >
The order of the tabs for multiple currencies defined in a given sales channel.
".components.schemas.SalesChannelContext.properties.currency.properties.decimalPrecision": >
It defines the round off value for currency to the nearest decimal point in a given sales channel. If set to 2, it rounds off to two significant decimal points.
".components.schemas.SalesChannelContext.properties.currency.properties.isSystemDefault": >
Runtime field, cannot be used as part of the criteria.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.typeId": >
Unique identity of a sales channel's type within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.languageId": >
Unique identity of a sales channel's language within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.currencyId": >
Unique identity of a sales channel's currency within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.paymentMethodId": >
Unique identity of a sales channel's payment method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.shippingMethodId": >
Unique identity of a sales channel's shipping method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.countryId": >
Unique identity of a sales channel's country within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.navigationCategoryId": >
Unique identity of a sales channel's navigation category within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.navigationCategoryDepth": >
It determines the number of levels of subcategories in the storefront category menu within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.footerCategoryId": >
Unique identity of a sales channel's footer category within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.serviceCategoryId": >
Unique identity of a sales channel's service category within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.name": >
Name of the sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.shortName": >
A short name for sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.accessKey": >
Access key to store api.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.active": >
When `true`, the sales channel is enabled.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.maintenance": >
When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.maintenanceIpWhitelist": >
Array of IP address allowed to access the sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.mailHeaderFooterId": >
Unique identity of a sales channel's mail header and footer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.customerGroupId": >
Unique identity of a sales channel's customer group within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.hreflangActive": >
When `true`, the sales channel pages are available in different languages within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.hreflangDefaultDomainId": >
Unique identity of a sales channel's hreflangDefaultDomain within a specific sales channel.
".components.schemas.SalesChannelContext.properties.salesChannel.properties.analyticsId": >
Unique identity of a sales channel's analytics within a specific sales channel.
".components.schemas.SalesChannelContext.properties.taxRules.properties.taxRate": >
Rate of tax within a specific sales channel.
".components.schemas.SalesChannelContext.properties.taxRules.properties.name": >
Name defined for a Tax within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.groupId": >
Unique identity of a customer's group within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.defaultPaymentMethodId": >
Unique identity of a customer's default payment method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.salesChannelId": >
Unique identity of sales channel the customer is currently interacting with.
".components.schemas.SalesChannelContext.properties.customer.properties.languageId": >
Unique identity of language within a specific sales channel the customer is interacting.
".components.schemas.SalesChannelContext.properties.customer.properties.lastPaymentMethodId": >
Unique identity of customer's last payment method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.defaultBillingAddressId": >
Unique identity of customer's default billing address within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.defaultShippingAddressId": >
Unique identity of customer's default shipping address within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.customerNumber": >
Name of the customer within a specific sales channel the customer is interacting.
".components.schemas.SalesChannelContext.properties.customer.properties.salutationId": >
Unique identity of customer's default shipping address within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.firstName": >
First name of the customer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.lastName": >
Last name of the customer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.company": >
Company name of the customer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.password": >
Password of the customer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.email": >
Email of the customer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.title": >
Customer's title or honorifics like Mr, Mrs, etc within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.affiliateCode": >
An affiliate code is an identification option with which website operators can mark outgoing links within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.campaignCode": >
A unique identifier for a campaign within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.active": >
When `true`, the status of the customer is set active within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.doubleOptInRegistration": >
When `true`, user subscriptions to an email marketing list is allowed within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.doubleOptInEmailSentDate": >
Date and time when the double opt-in email was sent within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.doubleOptInConfirmDate": >
Date and time when the double opt-in email was confirmed within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.hash": >
Password hash for account recovery within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.guest": >
Boolean value is `true` for a guest account within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.firstLogin": >
Captures date and time of customer's first login within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.lastLogin": >
Captures date and time of customer's last login within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.newsletter": >
When `true`, then the customer gets subscribe to the newsletter
".components.schemas.SalesChannelContext.properties.customer.properties.birthday": >
Captures customer's birthday details within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.lastOrderDate": >
Captures customer's last order date within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.orderCount": >
Captures the number of orders placed by a customer within a specific sales channel.
".components.schemas.SalesChannelContext.properties.customer.properties.legacyEncoder": >
encapsulates shop credentials when needed to migrate shop system from old instance to new instance
".components.schemas.SalesChannelContext.properties.customer.properties.legacyPassword": >
Hashed password of the old shop system
".components.schemas.SalesChannelContext.properties.customer.properties.autoIncrement": >
Internal field.
".components.schemas.SalesChannelContext.properties.customer.properties.remoteAddress": >
Anonymous IP address of the customer for last session.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.pluginId": >
Unique identity of payment plugin within a specific sales channel.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.handlerIdentifier": >
Internal field that contains system identifier details for payment methods like Paypal.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.name": >
Name of the payment method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.description": >
A short description about the payment method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.position": >
The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc within a specific sales channel.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.active": >
When `true`, the payment method is available for usage within a specific sales channel.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.availabilityRuleId": >
Unique identity of the rule for the payment method.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.mediaId": >
Unique identity of media used in payment method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.paymentMethod.properties.formattedHandlerIdentifier": >
Internal field that contains system identifier details for payment methods like Paypal.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.name": >
Name of the shipping method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.active": >
When `true`, the shipping method is available for usage within a specific sales channel.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.description": >
A short description about the shipping method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.trackingUrl": >
URL that allows to track packages for a specific sales channel.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.deliveryTimeId": >
Unique identity of deliveryTime within a specific sales channel.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.availabilityRuleId": >
Unique identity of the rule for the payment method.
".components.schemas.SalesChannelContext.properties.shippingMethod.properties.mediaId": >
Unique identity of media used in shipping method within a specific sales channel.
".components.schemas.SalesChannelContext.properties.context.properties.versionId": >
Unique identity of context's version in a specific sales channel.
".components.schemas.SalesChannelContext.properties.context.properties.currencyId": >
Unique identity of currency context in a specific sales channel.
".components.schemas.SalesChannelContext.properties.context.properties.currencyFactor": >
Unique identity of currency factor context in a specific sales channel.
".components.schemas.SalesChannelContext.properties.context.properties.currencyPrecision": >
It defines the round off value of currency to the nearest decimal point. If set to 2, it rounds off to two significant decimal points.
".components.schemas.SalesChannelContext.properties.context.properties.scope": >
Scope defines if its related to system or user context.
".components.schemas.SalesChannelContext.properties.context.properties.source": >
When context is related to user in the source, then there is userId.
".components.schemas.SalesChannelContext.properties.context.properties.taxState": >
Tax state can either be `gross` or `net`.
".components.schemas.SalesChannelContext.properties.context.properties.useCache": >
When boolean value is `true`, caching is used.
".components.schemas.AccountNewsletterRecipientResult.properties.status": >
Status indicates if the customer has subscribed to the news letter or not.
".components.schemas.ProductDetailResponse.properties.id": >
Unique identity of product detail response.
".components.schemas.ProductDetailResponse.properties.available": >
When boolean value is true, the product is available for purchase.
".components.schemas.ProductDetailResponse.properties.isCloseout": >
Boolean value to check if the product is still buyable when stock value is 0.
".components.schemas.ProductDetailResponse.properties.displayGroup": >
Internal field.
".components.schemas.ProductDetailResponse.properties.manufacturerNumber": >
Unique number of the product manufacturer.
".components.schemas.ProductDetailResponse.properties.stock": >
Quantity of product available.
".components.schemas.ProductDetailResponse.properties.sortedProperties": >
Properties of the product that are sorted
".components.schemas.Criteria.properties.filter.properties.type": >
To filter the results and aggregations with filter types like ==, >=, etc.
".components.schemas.Criteria.properties.filter.properties.field": >
To filter the results and aggregations by field like an property identifier.
".components.schemas.Criteria.properties.filter.properties.value": >
To filter the results and aggregations by value.
".components.schemas.Criteria.properties.sort.properties.field": >
Sort the search results by field like an property identifier.
".components.schemas.Criteria.properties.sort.properties.order": >
Sort the search results of orders by ascending or descending.
".components.schemas.Criteria.properties.sort.properties.naturalSorting": >
Sorting for special cases such as German letters with umlauts and similar characters etc.
".components.schemas.Criteria.properties.post-filter.properties.type": >
To filter only the results but not the aggregations with filter types like ==, >=, etc.
".components.schemas.Criteria.properties.post-filter.properties.field": >
To filter only the results but not the aggregations by field like an property identifier.
".components.schemas.Criteria.properties.post-filter.properties.value": >
To filter only the results but not the aggregations by value.
".components.schemas.ProductListingCriteria.properties.filter.properties.type": >
To filter the results and aggregations with filter types like ==, >=, etc.
".components.schemas.ProductListingCriteria.properties.filter.properties.field": >
To filter the results and aggregations by field like an property identifier.
".components.schemas.ProductListingCriteria.properties.filter.properties.value": >
To filter the results and aggregations by value.
".components.schemas.ProductListingCriteria.properties.sort.properties.field": >
Sort the search results by field like an property identifier.
".components.schemas.ProductListingCriteria.properties.sort.properties.order": >
Sort the search results of orders by ascending or descending.
".components.schemas.ProductListingCriteria.properties.sort.properties.naturalSorting": >
Sorting for special cases such as German letters with umlauts and similar characters etc.
".components.schemas.ProductListingCriteria.properties.post-filter.properties.type": >
To filter only the results but not the aggregations with filter types like ==, >=, etc.
".components.schemas.ProductListingCriteria.properties.post-filter.properties.field": >
To filter only the results but not the aggregations by field like an property identifier.
".components.schemas.ProductListingCriteria.properties.post-filter.properties.value": >
To filter only the results but not the aggregations by value.
".components.schemas.CartItems.properties.items.properties.id": >
Unique identity of cart item.
".components.schemas.CartItems.properties.items.properties.modified": >
When boolean value is `true`, the cart is said to be modified.
".components.schemas.ShippingMethodPageRouteResponse.properties.name": >
Name of the shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.active": >
When boolean value is `true`, the shipping methods are available for selection in the storefront.
".components.schemas.ShippingMethodPageRouteResponse.properties.description": >
The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.
".components.schemas.ShippingMethodPageRouteResponse.properties.deliveryTimeId": >
Unique identity of the delivery time.
".components.schemas.ShippingMethodPageRouteResponse.properties.deliveryTime.properties.name": >
Name given to delivery time.
".components.schemas.ShippingMethodPageRouteResponse.properties.deliveryTime.properties.min": >
Minimum delivery time taken.
".components.schemas.ShippingMethodPageRouteResponse.properties.deliveryTime.properties.max": >
Maximum delivery time taken.
".components.schemas.ShippingMethodPageRouteResponse.properties.deliveryTime.properties.unit": >
Unit in which the delivery time is defined. For example, days or hours.
".components.schemas.ShippingMethodPageRouteResponse.properties.translations.properties.shippingMethodId": >
Unique identity of shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.translations.properties.name": >
Name of the shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.translations.properties.description": >
A short description of the shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.orderDeliveries.properties.orderId": >
Unique identity of order.
".components.schemas.ShippingMethodPageRouteResponse.properties.orderDeliveries.properties.shippingOrderAddressId": >
Unique identity of shipping order address.
".components.schemas.ShippingMethodPageRouteResponse.properties.orderDeliveries.properties.shippingMethodId": >
Unique identity of shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.orderDeliveries.properties.shippingDateEarliest": >
Date and time of earliest delivery of products.
".components.schemas.ShippingMethodPageRouteResponse.properties.orderDeliveries.properties.shippingDateLatest": >
Date and time of latest delivery of products.
".components.schemas.ShippingMethodPageRouteResponse.properties.orderDeliveries.properties.stateId": >
Unique identity of state.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.stateId": >
Unique identity of state.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.languageId": >
Unique identity of language.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.currencyId": >
Unique identity of currency.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.paymentMethodId": >
Unique identity of payment method.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.shippingMethodId": >
Unique identity of shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.countryId": >
Unique identity of country.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.navigationCategoryId": >
Unique identity of navigation category.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.navigationCategoryDepth": >
It determines the number of levels of subcategories in the storefront category menu.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.footerCategoryId": >
Unique identity of footer category.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.serviceCategoryId": >
Unique identity of service category.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.name": >
Name of the sales channel.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.shortName": >
A short name for sales channel.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.accessKey": >
Access key to store api.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.active": >
When boolean value is `true`, the shipping methods are available for selection in the sales channel's storefront.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.maintenance": >
When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.maintenanceIpWhitelist": >
Array of IP address allowed to access the sales channel.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.mailHeaderFooterId": >
Unique identity of mail header and footer.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.customerGroupId": >
Unique identity of customer group.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.hreflangActive": >
When boolean value is `true`, the sales channel pages are available in different languages.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannelDefaultAssignments.properties.hreflangDefaultDomainId": >
Unique identity of hreflangDefaultDomain.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.stateId": >
Unique identity of state.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.languageId": >
Unique identity of language.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.currencyId": >
Unique identity of currency.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.paymentMethodId": >
Unique identity of payment method.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.shippingMethodId": >
Unique identity of shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.countryId": >
Unique identity of country.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.navigationCategoryId": >
Unique identity of navigation category.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.navigationCategoryDepth": >
It determines the number of levels of subcategories in the storefront category menu.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.footerCategoryId": >
Unique identity of footer category.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.serviceCategoryId": >
Unique identity of service category.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.name": >
Name of the sales channel.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.shortName": >
A short name for sales channel.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.accessKey": >
Access key to store api.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.active": >
When boolean value is `true`, the shipping methods are available for selection in the storefront.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.maintenance": >
When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.maintenanceIpWhitelist": >
Array of IP address allowed to access the sales channel.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.mailHeaderFooterId": >
Unique identity of mail header and footer.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.customerGroupId": >
Unique identity of customer group.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.hreflangActive": >
When boolean value is `true``, the sales channel pages are available in different languages.
".components.schemas.ShippingMethodPageRouteResponse.properties.salesChannels.properties.hreflangDefaultDomainId": >
Unique identity of hreflangDefaultDomain.
".components.schemas.ShippingMethodPageRouteResponse.properties.availabilityRule.properties.name": >
Unique name for the rule.
".components.schemas.ShippingMethodPageRouteResponse.properties.availabilityRule.properties.description": >
A short description about the rule.
".components.schemas.ShippingMethodPageRouteResponse.properties.availabilityRule.properties.priority": >
A numerical value to prioritize one of the rules from the list.
".components.schemas.ShippingMethodPageRouteResponse.properties.availabilityRule.properties.invalid": >
When the boolean value is `true`, the rule is no more available for usage.
".components.schemas.ShippingMethodPageRouteResponse.properties.availabilityRuleId": >
Unique identity of availability rule.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.shippingMethodId": >
Unique identity of shipping method.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.currencyId": >
Unique identity of currency.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.ruleId": >
Unique identity of rule.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.calculation": >
Shipping price calculated based on quantity, price, weight or volume of items.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.quantityStart": >
Starting range of quantity of an item.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.quantityEnd": >
Ending range of quantity of an item.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.price": >
Shipping method price after applied rules.
".components.schemas.ShippingMethodPageRouteResponse.properties.prices.properties.calculationRuleId": >
Unique identity of calculation rule.
".components.schemas.ShippingMethodPageRouteResponse.properties.mediaId": >
Unique identity of media.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.userId": >
Unique identity of user.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.mimeType": >
A string sent along with a file indicating the type of the file. For example: image/jpeg.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.fileExtension": >
Type of file indication. For example: jpeg, png.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.fileSize": >
Size of the file media file uploaded.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.title": >
Title name give to the media.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.metaDataRaw": >
Details of the media file uploaded.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.alt": >
Alternate text for media.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.url": >
Runtime field, cannot be used as part of the criteria.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.fileName": >
Name of the media file uploaded.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.mediaFolderId": >
Unique identity of media folder.
".components.schemas.ShippingMethodPageRouteResponse.properties.media.properties.private": >
Boolean value is `true` to keep the media display private.
".components.schemas.ShippingMethodPageRouteResponse.properties.tags.properties.name": >
Name of the tag.
".components.schemas.FindProductVariantRouteResponse.properties.foundCombination.properties.variantId": >
Unique identity of a variant.
".components.schemas.FindProductVariantRouteResponse.properties.foundCombination.properties.options": >
Available product variant options. For example, for variant `Size`, option would be `XS`, `S`, `M`, `L`, `XL`.
".components.schemas.Order.properties.id": >
Unique identity of order.
".components.schemas.Order.properties.versionId": >
Unique identity of order version.
".components.schemas.Order.properties.orderNumber": >
Unique number associated with every order.
".components.schemas.Order.properties.billingAddressId": >
Unique identity of the billing address.
".components.schemas.Order.properties.billingAddressVersionId": >
Unique identity of the billing address version.
".components.schemas.Order.properties.currencyId": >
Unique identity of the currency.
".components.schemas.Order.properties.languageId": >
Unique identity of the language.
".components.schemas.Order.properties.salesChannelId": >
Unique identity of the sales channel.
".components.schemas.Order.properties.orderDateTime": >
Timestamp when the order was placed.
".components.schemas.Order.properties.orderDate": >
Date when the order was placed.
".components.schemas.Order.properties.price.properties.netPrice": >
Net price of the product.
".components.schemas.Order.properties.price.properties.totalPrice": >
Gross price of the product.
".components.schemas.Order.properties.price.properties.positionPrice": >
Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.
".components.schemas.Order.properties.price.properties.rawTotal": >
The total value before rounding off.
".components.schemas.Order.properties.price.properties.taxStatus": >
TaxStatus takes `Free`, `Net` or `Gross` as values.
".components.schemas.Order.properties.amountTotal": >
Gross price of the order.
".components.schemas.Order.properties.amountNet": >
Net price of the order.
".components.schemas.Order.properties.positionPrice": >
Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.
".components.schemas.Order.properties.taxStatus": >
TaxStatus takes `Free`, `Net` or `Gross` as values.
".components.schemas.Order.properties.shippingCosts.properties.unitPrice": >
Shipping cost of product per item (where, quantity=1).
".components.schemas.Order.properties.shippingCosts.properties.totalPrice": >
Shipping cost of product based on quantity.
".components.schemas.Order.properties.shippingCosts.properties.quantity": >
Number of items of each product.
".components.schemas.Order.properties.shippingCosts.properties.calculatedTaxes": >
Contains calculated taxes based on shipping costs/methods.
".components.schemas.Order.properties.shippingCosts.properties.taxRules": >
Pricing based on multiple taxes.
".components.schemas.Order.properties.shippingCosts.properties.referencePrice": >
Original cost price of the product.
".components.schemas.Order.properties.shippingCosts.properties.listPrice.properties.price": >
Price of each line item.
".components.schemas.Order.properties.shippingCosts.properties.listPrice.properties.discount": >
Absolute discount on each line item.
".components.schemas.Order.properties.shippingCosts.properties.listPrice.properties.percentage": >
Discount in percentage.
".components.schemas.Order.properties.shippingCosts.properties.regulationPrice.properties.price": >
Contains cheapest price from last 30 days as per EU law.
".components.schemas.Order.properties.shippingTotal": >
Total shipping cost of the ordered product.
".components.schemas.Order.properties.currencyFactor": >
Rate at which currency is exchanged.
".components.schemas.Order.properties.deepLinkCode": >
It is a generated special code linked to email. It is used to access orders placed by guest customers.
".components.schemas.Order.properties.affiliateCode": >
An affiliate code is an identification option with which website operators can mark outgoing links.
".components.schemas.Order.properties.campaignCode": >
A campaign code is the globally unique identifier for a campaign.
".components.schemas.Order.properties.customerComment": >
Comments given by comments.
".components.schemas.Order.properties.source": >
Source of orders either via normal order placement or subscriptions.
".components.schemas.Order.properties.extensions": >
To store additional data to an order from extensions.
".components.schemas.Order.properties.customFields": >
Additional fields that offer a possibility to add own fields for the different program-areas.
".components.schemas.OrderAddress.properties.id": >
Unique identity of order's address.
".components.schemas.OrderAddress.properties.versionId": >
Unique identity of OrderAddresses version.
".components.schemas.OrderAddress.properties.countryId": >
Unique identity of country.
".components.schemas.OrderAddress.properties.countryStateId": >
Unique identity of state.
".components.schemas.OrderAddress.properties.firstName": >
First name of the customer.
".components.schemas.OrderAddress.properties.lastName": >
Last name of the customer.
".components.schemas.OrderAddress.properties.street": >
Street address
".components.schemas.OrderAddress.properties.zipcode": >
Zip code of the country.
".components.schemas.OrderAddress.properties.city": >
Name of the city.
".components.schemas.OrderAddress.properties.company": >
Name of the company.
".components.schemas.OrderAddress.properties.department": >
Name of the department.
".components.schemas.OrderAddress.properties.title": >
Title name given to customer like DR. , Prof., etc.
".components.schemas.OrderAddress.properties.vatId": >
Unique identity of VAT.
".components.schemas.OrderAddress.properties.phoneNumber": >
Phone number of the customer.
".components.schemas.OrderAddress.properties.additionalAddressLine1": >
Additional address input if necessary.
".components.schemas.OrderAddress.properties.additionalAddressLine2": >
Additional address input if necessary.
".components.schemas.OrderAddress.properties.customFields": >
Additional fields that offer a possibility to add own fields for the different program-areas.
".components.schemas.OrderCustomer.properties.id": >
Unique identity of order customer.
".components.schemas.OrderCustomer.properties.versionId": >
Unique identity of OrderCustomer's version.
".components.schemas.OrderCustomer.properties.email": >
Email address of the customer.
".components.schemas.OrderCustomer.properties.salutationId": >
Unique identity of salutation.
".components.schemas.OrderCustomer.properties.firstName": >
First name of the customer.
".components.schemas.OrderCustomer.properties.lastName": >
Last name of the customer.
".components.schemas.OrderCustomer.properties.company": >
Name of the company.
".components.schemas.OrderCustomer.properties.title": >
Title name given to the customer like Dr, prof. etc.
".components.schemas.OrderCustomer.properties.vatIds": >
Unique identity of VAT.
".components.schemas.OrderCustomer.properties.customerNumber": >
Unique number assigned to the customer.
".components.schemas.OrderCustomer.properties.customFields": >
Additional fields that offer a possibility to add own fields for the different program-areas.
".components.schemas.OrderDelivery.properties.id": >
Unique identity of Order's delivery.
".components.schemas.OrderDelivery.properties.versionId": >
Unique identity of OrderDelivery's version.
".components.schemas.OrderDelivery.properties.orderId": >
Unique identity of order.
".components.schemas.OrderDelivery.properties.orderVersionId": >
Unique identity of order's version.
".components.schemas.OrderDelivery.properties.shippingOrderAddressId": >
Unique identity of order's shipping address.
".components.schemas.OrderDelivery.properties.shippingOrderAddressVersionId": >
Unique identity of order's shipping address version.
".components.schemas.OrderDelivery.properties.shippingMethodId": >
Unique identity of shipping method.
".components.schemas.OrderDelivery.properties.stateId": >
Unique identity of state.
".components.schemas.OrderDelivery.properties.trackingCodes": >
Tracking code is a unique URL code assigned to each package, which allows you to monitor the movement of the parcel.
".components.schemas.OrderDelivery.properties.shippingDateEarliest": >
Date and time of earliest delivery of products.
".components.schemas.OrderDelivery.properties.shippingDateLatest": >
Date and time of latest delivery of products.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.unitPrice": >
Shipping cost of product per item (where, quantity=1).
".components.schemas.OrderDelivery.properties.shippingCosts.properties.totalPrice": >
Shipping cost of product based on quantity.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.quantity": >
Number of items of each product.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.calculatedTaxes": >
Contains calculated taxes based on shipping costs/methods.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.taxRules": >
Pricing based on multiple taxes.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.referencePrice": >
Original cost price of the product.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.listPrice.properties.price": >
Price of each line item.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.listPrice.properties.discount": >
Absolute discount on each line item.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.listPrice.properties.percentage": >
Discount in percentage.
".components.schemas.OrderDelivery.properties.shippingCosts.properties.regulationPrice.properties.price": >
Contains cheapest price from last 30 days as per EU law.
".components.schemas.OrderDelivery.properties.customFields": >
Additional fields that offer a possibility to add own fields for the different program-areas.
".components.schemas.OrderDeliveryPosition.properties.id": >
Unique identity of order delivery position.
".components.schemas.OrderDeliveryPosition.properties.versionId": >
Unique identity of OrderDeliveryPosition's version.
".components.schemas.OrderDeliveryPosition.properties.orderDeliveryId": >
Unique identity of order delivery.
".components.schemas.OrderDeliveryPosition.properties.orderDeliveryVersionId": >
Unique identity of order delivery's version.
".components.schemas.OrderDeliveryPosition.properties.orderLineItemId": >
Unique identity of line items in an order.
".components.schemas.OrderDeliveryPosition.properties.orderLineItemVersionId": >
Unique identity of line item's version in an order.
".components.schemas.OrderDeliveryPosition.properties.price.properties.unitPrice": >
Price of product per item (where, quantity=1).
".components.schemas.OrderDeliveryPosition.properties.price.properties.totalPrice": >
Cost of product based on quantity.
".components.schemas.OrderDeliveryPosition.properties.price.properties.quantity": >
Number of items of each product.
".components.schemas.OrderDeliveryPosition.properties.price.properties.calculatedTaxes": >
Contains calculated taxes based on order delivery price.
".components.schemas.OrderDeliveryPosition.properties.price.properties.taxRules": >
Pricing based on multiple taxes.
".components.schemas.OrderDeliveryPosition.properties.price.properties.referencePrice": >
Original cost price of the product.
".components.schemas.OrderDeliveryPosition.properties.price.properties.listPrice.properties.price": >
Price of each line item.
".components.schemas.OrderDeliveryPosition.properties.price.properties.listPrice.properties.discount": >
Absolute discount on each line item.
".components.schemas.OrderDeliveryPosition.properties.price.properties.listPrice.properties.percentage": >
Discount in percentage.
".components.schemas.OrderDeliveryPosition.properties.price.properties.regulationPrice.properties.price": >
Contains cheapest price from last 30 days as per EU law.
".components.schemas.OrderDeliveryPosition.properties.unitPrice": >
Price of product per item (where, quantity=1).
".components.schemas.OrderDeliveryPosition.properties.totalPrice": >
Cost of product based on quantity.
".components.schemas.OrderDeliveryPosition.properties.quantity": >
Number of items of each product.
".components.schemas.OrderDeliveryPosition.properties.customFields": >
Additional fields that offer a possibility to add own fields for the different program-areas.
".components.schemas.OrderLineItem.properties.id": >
Unique identity of OrderLineItem.
".components.schemas.OrderLineItem.properties.versionId": >
Unique identity of OrderLineItem's version.
".components.schemas.OrderLineItem.properties.orderId": >
Unique identity of order.
".components.schemas.OrderLineItem.properties.orderVersionId": >
Unique identity of order's version.
".components.schemas.OrderLineItem.properties.productId": >
Unique identity of product.
".components.schemas.OrderLineItem.properties.productVersionId": >
Unique identity of products's version.
".components.schemas.OrderLineItem.properties.parentId": >
Unique identity of parent product.
".components.schemas.OrderLineItem.properties.parentVersionId": >
Unique identity of parent's version.
".components.schemas.OrderLineItem.properties.coverId": >
Unique identity of cover image.
".components.schemas.OrderLineItem.properties.identifier": >
It is a unique identity of an item in cart before its converted to an order.
".components.schemas.OrderLineItem.properties.referencedId": >
Unique identity of type of entity.
".components.schemas.OrderLineItem.properties.quantity": >
Number of items of product.
".components.schemas.OrderLineItem.properties.label": >
It is a typical product name given to the line item.
".components.schemas.OrderLineItem.properties.payload": >
Any data related to product is passed.
".components.schemas.OrderLineItem.properties.good": >