@shopbite-de/storefront 1.3.0 → 1.4.1
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/api-types/storeApiSchema.json +279 -81
- package/api-types/storeApiTypes.d.ts +155 -113
- package/app/app.vue +1 -2
- package/app/components/Checkout/DeliveryTimeSelect.vue +1 -1
- package/app/components/Checkout/Summary.vue +1 -1
- package/app/components/Header.vue +1 -1
- package/app/components/Product/Card.vue +1 -1
- package/app/composables/useDeliveryTime.ts +1 -1
- package/app/composables/{usePizzaToppings.ts → useShopBiteConfig.ts} +5 -5
- package/app/layouts/listing.vue +1 -1
- package/app/utils/businessHours.ts +41 -46
- package/app/utils/holidays.ts +5 -24
- package/app/utils/storeHours.ts +2 -2
- package/nuxt.config.ts +1 -1
- package/package.json +1 -1
- package/playwright.config.ts +2 -2
- package/test/nuxt/useAddToCart.test.ts +10 -7
- package/test/nuxt/useDeliveryTime.test.ts +14 -7
- package/test/nuxt/useProductConfigurator.test.ts +14 -16
- package/test/nuxt/useProductVariants.test.ts +17 -17
- package/test/nuxt/useProductVariantsZwei.test.ts +7 -7
- package/test/nuxt/useScrollAnimation.test.ts +8 -6
- package/test/nuxt/{usePizzaToppings.test.ts → useShopBiteConfig.test.ts} +17 -17
- package/test/nuxt/useTopSellers.test.ts +6 -3
- package/test/nuxt/useWishlistActions.test.ts +26 -10
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
"name": "MIT",
|
|
8
8
|
"url": "https://github.com/shopware/shopware/blob/trunk/LICENSE"
|
|
9
9
|
},
|
|
10
|
-
"version": "6.7.
|
|
10
|
+
"version": "6.7.5.1"
|
|
11
11
|
},
|
|
12
12
|
"servers": [{ "url": "https://shopware.shopbite.de/store-api" }],
|
|
13
13
|
"components": {
|
|
@@ -580,6 +580,7 @@
|
|
|
580
580
|
"type": "object"
|
|
581
581
|
},
|
|
582
582
|
"children": {
|
|
583
|
+
"description": "Child categories within this category for hierarchical navigation",
|
|
583
584
|
"properties": {
|
|
584
585
|
"links": {
|
|
585
586
|
"type": "object",
|
|
@@ -608,6 +609,7 @@
|
|
|
608
609
|
"type": "object"
|
|
609
610
|
},
|
|
610
611
|
"media": {
|
|
612
|
+
"description": "Category image or banner",
|
|
611
613
|
"properties": {
|
|
612
614
|
"links": {
|
|
613
615
|
"type": "object",
|
|
@@ -634,6 +636,7 @@
|
|
|
634
636
|
"type": "object"
|
|
635
637
|
},
|
|
636
638
|
"tags": {
|
|
639
|
+
"description": "Tags for organizing and filtering categories",
|
|
637
640
|
"properties": {
|
|
638
641
|
"links": {
|
|
639
642
|
"type": "object",
|
|
@@ -662,6 +665,7 @@
|
|
|
662
665
|
"type": "object"
|
|
663
666
|
},
|
|
664
667
|
"cmsPage": {
|
|
668
|
+
"description": "CMS page layout for the category",
|
|
665
669
|
"properties": {
|
|
666
670
|
"links": {
|
|
667
671
|
"type": "object",
|
|
@@ -688,6 +692,7 @@
|
|
|
688
692
|
"type": "object"
|
|
689
693
|
},
|
|
690
694
|
"seoUrls": {
|
|
695
|
+
"description": "SEO-friendly URLs for the category across different sales channels",
|
|
691
696
|
"properties": {
|
|
692
697
|
"links": {
|
|
693
698
|
"type": "object",
|
|
@@ -812,16 +817,25 @@
|
|
|
812
817
|
},
|
|
813
818
|
"parent": { "$ref": "#/components/schemas/Category" },
|
|
814
819
|
"children": {
|
|
820
|
+
"description": "Child categories within this category for hierarchical navigation",
|
|
815
821
|
"type": "array",
|
|
816
822
|
"items": { "$ref": "#/components/schemas/Category" }
|
|
817
823
|
},
|
|
818
|
-
"media": {
|
|
824
|
+
"media": {
|
|
825
|
+
"$ref": "#/components/schemas/Media",
|
|
826
|
+
"description": "Category image or banner"
|
|
827
|
+
},
|
|
819
828
|
"tags": {
|
|
829
|
+
"description": "Tags for organizing and filtering categories",
|
|
820
830
|
"type": "array",
|
|
821
831
|
"items": { "$ref": "#/components/schemas/Tag" }
|
|
822
832
|
},
|
|
823
|
-
"cmsPage": {
|
|
833
|
+
"cmsPage": {
|
|
834
|
+
"$ref": "#/components/schemas/CmsPage",
|
|
835
|
+
"description": "CMS page layout for the category"
|
|
836
|
+
},
|
|
824
837
|
"seoUrls": {
|
|
838
|
+
"description": "SEO-friendly URLs for the category across different sales channels",
|
|
825
839
|
"type": "array",
|
|
826
840
|
"items": { "$ref": "#/components/schemas/SeoUrl" }
|
|
827
841
|
},
|
|
@@ -918,11 +932,16 @@
|
|
|
918
932
|
},
|
|
919
933
|
"translated": { "type": "object" },
|
|
920
934
|
"sections": {
|
|
935
|
+
"description": "Content sections within the CMS page (layout blocks containing slots)",
|
|
921
936
|
"type": "array",
|
|
922
937
|
"items": { "$ref": "#/components/schemas/CmsSection" }
|
|
923
938
|
},
|
|
924
|
-
"previewMedia": {
|
|
939
|
+
"previewMedia": {
|
|
940
|
+
"$ref": "#/components/schemas/Media",
|
|
941
|
+
"description": "Preview image for the CMS page in admin panel and page selection"
|
|
942
|
+
},
|
|
925
943
|
"landingPages": {
|
|
944
|
+
"description": "Landing pages using this CMS layout",
|
|
926
945
|
"type": "array",
|
|
927
946
|
"items": { "$ref": "#/components/schemas/LandingPage" }
|
|
928
947
|
},
|
|
@@ -1071,6 +1090,7 @@
|
|
|
1071
1090
|
"relationships": {
|
|
1072
1091
|
"properties": {
|
|
1073
1092
|
"states": {
|
|
1093
|
+
"description": "States/provinces/regions within the country",
|
|
1074
1094
|
"properties": {
|
|
1075
1095
|
"links": {
|
|
1076
1096
|
"type": "object",
|
|
@@ -1163,6 +1183,7 @@
|
|
|
1163
1183
|
},
|
|
1164
1184
|
"translated": { "type": "object" },
|
|
1165
1185
|
"states": {
|
|
1186
|
+
"description": "States/provinces/regions within the country",
|
|
1166
1187
|
"type": "array",
|
|
1167
1188
|
"items": { "$ref": "#/components/schemas/CountryState" }
|
|
1168
1189
|
}
|
|
@@ -1522,27 +1543,45 @@
|
|
|
1522
1543
|
"format": "date-time",
|
|
1523
1544
|
"readOnly": true
|
|
1524
1545
|
},
|
|
1525
|
-
"group": {
|
|
1526
|
-
|
|
1527
|
-
|
|
1546
|
+
"group": {
|
|
1547
|
+
"$ref": "#/components/schemas/CustomerGroup",
|
|
1548
|
+
"description": "Customer group determining pricing and permissions"
|
|
1549
|
+
},
|
|
1550
|
+
"language": {
|
|
1551
|
+
"$ref": "#/components/schemas/Language",
|
|
1552
|
+
"description": "Preferred language for customer communication"
|
|
1553
|
+
},
|
|
1554
|
+
"lastPaymentMethod": {
|
|
1555
|
+
"$ref": "#/components/schemas/PaymentMethod",
|
|
1556
|
+
"description": "Last used payment method by the customer"
|
|
1557
|
+
},
|
|
1528
1558
|
"defaultBillingAddress": {
|
|
1529
|
-
"$ref": "#/components/schemas/CustomerAddress"
|
|
1559
|
+
"$ref": "#/components/schemas/CustomerAddress",
|
|
1560
|
+
"description": "Default billing address for the customer"
|
|
1530
1561
|
},
|
|
1531
1562
|
"activeBillingAddress": {
|
|
1532
|
-
"$ref": "#/components/schemas/CustomerAddress"
|
|
1563
|
+
"$ref": "#/components/schemas/CustomerAddress",
|
|
1564
|
+
"description": "Currently active billing address in the session"
|
|
1533
1565
|
},
|
|
1534
1566
|
"defaultShippingAddress": {
|
|
1535
|
-
"$ref": "#/components/schemas/CustomerAddress"
|
|
1567
|
+
"$ref": "#/components/schemas/CustomerAddress",
|
|
1568
|
+
"description": "Default shipping address for the customer"
|
|
1536
1569
|
},
|
|
1537
1570
|
"activeShippingAddress": {
|
|
1538
|
-
"$ref": "#/components/schemas/CustomerAddress"
|
|
1571
|
+
"$ref": "#/components/schemas/CustomerAddress",
|
|
1572
|
+
"description": "Currently active shipping address in the session"
|
|
1573
|
+
},
|
|
1574
|
+
"salutation": {
|
|
1575
|
+
"$ref": "#/components/schemas/Salutation",
|
|
1576
|
+
"description": "Customer salutation (e.g., Mr., Mrs., Ms.)"
|
|
1539
1577
|
},
|
|
1540
|
-
"salutation": { "$ref": "#/components/schemas/Salutation" },
|
|
1541
1578
|
"addresses": {
|
|
1579
|
+
"description": "All addresses saved for the customer",
|
|
1542
1580
|
"type": "array",
|
|
1543
1581
|
"items": { "$ref": "#/components/schemas/CustomerAddress" }
|
|
1544
1582
|
},
|
|
1545
1583
|
"tags": {
|
|
1584
|
+
"description": "Tags assigned to the customer for organization and segmentation",
|
|
1546
1585
|
"type": "array",
|
|
1547
1586
|
"items": { "$ref": "#/components/schemas/Tag" }
|
|
1548
1587
|
},
|
|
@@ -2042,6 +2081,7 @@
|
|
|
2042
2081
|
"relationships": {
|
|
2043
2082
|
"properties": {
|
|
2044
2083
|
"cmsPage": {
|
|
2084
|
+
"description": "CMS page layout for the landing page",
|
|
2045
2085
|
"properties": {
|
|
2046
2086
|
"links": {
|
|
2047
2087
|
"type": "object",
|
|
@@ -2068,6 +2108,7 @@
|
|
|
2068
2108
|
"type": "object"
|
|
2069
2109
|
},
|
|
2070
2110
|
"seoUrls": {
|
|
2111
|
+
"description": "SEO-friendly URLs for the landing page across different sales channels",
|
|
2071
2112
|
"properties": {
|
|
2072
2113
|
"links": {
|
|
2073
2114
|
"type": "object",
|
|
@@ -2130,8 +2171,12 @@
|
|
|
2130
2171
|
"readOnly": true
|
|
2131
2172
|
},
|
|
2132
2173
|
"translated": { "type": "object" },
|
|
2133
|
-
"cmsPage": {
|
|
2174
|
+
"cmsPage": {
|
|
2175
|
+
"$ref": "#/components/schemas/CmsPage",
|
|
2176
|
+
"description": "CMS page layout for the landing page"
|
|
2177
|
+
},
|
|
2134
2178
|
"seoUrls": {
|
|
2179
|
+
"description": "SEO-friendly URLs for the landing page across different sales channels",
|
|
2135
2180
|
"type": "array",
|
|
2136
2181
|
"items": { "$ref": "#/components/schemas/SeoUrl" }
|
|
2137
2182
|
},
|
|
@@ -2195,6 +2240,7 @@
|
|
|
2195
2240
|
"type": "object"
|
|
2196
2241
|
},
|
|
2197
2242
|
"locale": {
|
|
2243
|
+
"description": "Locale defining regional settings (date, time, number formats)",
|
|
2198
2244
|
"properties": {
|
|
2199
2245
|
"links": {
|
|
2200
2246
|
"type": "object",
|
|
@@ -2221,6 +2267,7 @@
|
|
|
2221
2267
|
"type": "object"
|
|
2222
2268
|
},
|
|
2223
2269
|
"translationCode": {
|
|
2270
|
+
"description": "Locale used for translating content",
|
|
2224
2271
|
"properties": {
|
|
2225
2272
|
"links": {
|
|
2226
2273
|
"type": "object",
|
|
@@ -2247,6 +2294,7 @@
|
|
|
2247
2294
|
"type": "object"
|
|
2248
2295
|
},
|
|
2249
2296
|
"children": {
|
|
2297
|
+
"description": "Child languages inheriting from this parent language",
|
|
2250
2298
|
"properties": {
|
|
2251
2299
|
"links": {
|
|
2252
2300
|
"type": "object",
|
|
@@ -2307,9 +2355,16 @@
|
|
|
2307
2355
|
"readOnly": true
|
|
2308
2356
|
},
|
|
2309
2357
|
"parent": { "$ref": "#/components/schemas/Language" },
|
|
2310
|
-
"locale": {
|
|
2311
|
-
|
|
2358
|
+
"locale": {
|
|
2359
|
+
"$ref": "#/components/schemas/Locale",
|
|
2360
|
+
"description": "Locale defining regional settings (date, time, number formats)"
|
|
2361
|
+
},
|
|
2362
|
+
"translationCode": {
|
|
2363
|
+
"$ref": "#/components/schemas/Locale",
|
|
2364
|
+
"description": "Locale used for translating content"
|
|
2365
|
+
},
|
|
2312
2366
|
"children": {
|
|
2367
|
+
"description": "Child languages inheriting from this parent language",
|
|
2313
2368
|
"type": "array",
|
|
2314
2369
|
"items": { "$ref": "#/components/schemas/Language" }
|
|
2315
2370
|
}
|
|
@@ -2635,6 +2690,7 @@
|
|
|
2635
2690
|
},
|
|
2636
2691
|
"translated": { "type": "object" },
|
|
2637
2692
|
"thumbnails": {
|
|
2693
|
+
"description": "Generated thumbnail images in various sizes",
|
|
2638
2694
|
"type": "array",
|
|
2639
2695
|
"items": { "$ref": "#/components/schemas/MediaThumbnail" }
|
|
2640
2696
|
},
|
|
@@ -3018,39 +3074,60 @@
|
|
|
3018
3074
|
"readOnly": true
|
|
3019
3075
|
},
|
|
3020
3076
|
"stateMachineState": {
|
|
3021
|
-
"$ref": "#/components/schemas/StateMachineState"
|
|
3077
|
+
"$ref": "#/components/schemas/StateMachineState",
|
|
3078
|
+
"description": "Current order state (e.g., open, in_progress, completed, cancelled)"
|
|
3022
3079
|
},
|
|
3023
3080
|
"primaryOrderDelivery": {
|
|
3024
|
-
"$ref": "#/components/schemas/OrderDelivery"
|
|
3081
|
+
"$ref": "#/components/schemas/OrderDelivery",
|
|
3082
|
+
"description": "Primary delivery information for the order"
|
|
3025
3083
|
},
|
|
3026
3084
|
"primaryOrderTransaction": {
|
|
3027
|
-
"$ref": "#/components/schemas/OrderTransaction"
|
|
3085
|
+
"$ref": "#/components/schemas/OrderTransaction",
|
|
3086
|
+
"description": "Primary payment transaction for the order"
|
|
3087
|
+
},
|
|
3088
|
+
"orderCustomer": {
|
|
3089
|
+
"$ref": "#/components/schemas/OrderCustomer",
|
|
3090
|
+
"description": "Customer information associated with the order"
|
|
3091
|
+
},
|
|
3092
|
+
"currency": {
|
|
3093
|
+
"$ref": "#/components/schemas/Currency",
|
|
3094
|
+
"description": "Currency used for the order"
|
|
3095
|
+
},
|
|
3096
|
+
"language": {
|
|
3097
|
+
"$ref": "#/components/schemas/Language",
|
|
3098
|
+
"description": "Language used when placing the order"
|
|
3028
3099
|
},
|
|
3029
|
-
"orderCustomer": { "$ref": "#/components/schemas/OrderCustomer" },
|
|
3030
|
-
"currency": { "$ref": "#/components/schemas/Currency" },
|
|
3031
|
-
"language": { "$ref": "#/components/schemas/Language" },
|
|
3032
3100
|
"addresses": {
|
|
3101
|
+
"description": "All addresses associated with the order (billing and shipping)",
|
|
3033
3102
|
"type": "array",
|
|
3034
3103
|
"items": { "$ref": "#/components/schemas/OrderAddress" }
|
|
3035
3104
|
},
|
|
3036
|
-
"billingAddress": {
|
|
3105
|
+
"billingAddress": {
|
|
3106
|
+
"$ref": "#/components/schemas/OrderAddress",
|
|
3107
|
+
"description": "Billing address for the order"
|
|
3108
|
+
},
|
|
3037
3109
|
"deliveries": {
|
|
3110
|
+
"description": "Delivery information including shipping address and tracking",
|
|
3038
3111
|
"type": "array",
|
|
3039
3112
|
"items": { "$ref": "#/components/schemas/OrderDelivery" }
|
|
3040
3113
|
},
|
|
3041
3114
|
"lineItems": {
|
|
3115
|
+
"description": "Order line items (products, discounts, fees)",
|
|
3042
3116
|
"type": "array",
|
|
3043
3117
|
"items": { "$ref": "#/components/schemas/OrderLineItem" }
|
|
3044
3118
|
},
|
|
3045
3119
|
"transactions": {
|
|
3120
|
+
"description": "Payment transactions for the order",
|
|
3046
3121
|
"type": "array",
|
|
3047
3122
|
"items": { "$ref": "#/components/schemas/OrderTransaction" }
|
|
3048
3123
|
},
|
|
3049
3124
|
"documents": {
|
|
3125
|
+
"description": "Generated documents (invoices, delivery notes, credit notes)",
|
|
3050
3126
|
"type": "array",
|
|
3051
3127
|
"items": { "$ref": "#/components/schemas/Document" }
|
|
3052
3128
|
},
|
|
3053
3129
|
"tags": {
|
|
3130
|
+
"description": "Tags assigned to the order for organization and filtering",
|
|
3054
3131
|
"type": "array",
|
|
3055
3132
|
"items": { "$ref": "#/components/schemas/Tag" }
|
|
3056
3133
|
}
|
|
@@ -3201,13 +3278,19 @@
|
|
|
3201
3278
|
"readOnly": true
|
|
3202
3279
|
},
|
|
3203
3280
|
"stateMachineState": {
|
|
3204
|
-
"$ref": "#/components/schemas/StateMachineState"
|
|
3281
|
+
"$ref": "#/components/schemas/StateMachineState",
|
|
3282
|
+
"description": "Current delivery state (e.g., open, shipped, delivered, cancelled)"
|
|
3205
3283
|
},
|
|
3206
3284
|
"shippingOrderAddress": {
|
|
3207
|
-
"$ref": "#/components/schemas/OrderAddress"
|
|
3285
|
+
"$ref": "#/components/schemas/OrderAddress",
|
|
3286
|
+
"description": "Shipping address for this delivery"
|
|
3287
|
+
},
|
|
3288
|
+
"shippingMethod": {
|
|
3289
|
+
"$ref": "#/components/schemas/ShippingMethod",
|
|
3290
|
+
"description": "Shipping method used for this delivery"
|
|
3208
3291
|
},
|
|
3209
|
-
"shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" },
|
|
3210
3292
|
"positions": {
|
|
3293
|
+
"description": "Line items included in this delivery",
|
|
3211
3294
|
"type": "array",
|
|
3212
3295
|
"items": { "$ref": "#/components/schemas/OrderDeliveryPosition" }
|
|
3213
3296
|
}
|
|
@@ -3378,13 +3461,21 @@
|
|
|
3378
3461
|
"format": "date-time",
|
|
3379
3462
|
"readOnly": true
|
|
3380
3463
|
},
|
|
3381
|
-
"cover": {
|
|
3382
|
-
|
|
3464
|
+
"cover": {
|
|
3465
|
+
"$ref": "#/components/schemas/Media",
|
|
3466
|
+
"description": "Line item image or thumbnail"
|
|
3467
|
+
},
|
|
3468
|
+
"product": {
|
|
3469
|
+
"$ref": "#/components/schemas/Product",
|
|
3470
|
+
"description": "Referenced product if this is a product line item"
|
|
3471
|
+
},
|
|
3383
3472
|
"orderDeliveryPositions": {
|
|
3473
|
+
"description": "Delivery positions for this line item",
|
|
3384
3474
|
"type": "array",
|
|
3385
3475
|
"items": { "$ref": "#/components/schemas/OrderDeliveryPosition" }
|
|
3386
3476
|
},
|
|
3387
3477
|
"downloads": {
|
|
3478
|
+
"description": "Digital downloads associated with this line item",
|
|
3388
3479
|
"type": "array",
|
|
3389
3480
|
"items": { "$ref": "#/components/schemas/OrderLineItemDownload" }
|
|
3390
3481
|
},
|
|
@@ -3498,10 +3589,15 @@
|
|
|
3498
3589
|
"readOnly": true
|
|
3499
3590
|
},
|
|
3500
3591
|
"stateMachineState": {
|
|
3501
|
-
"$ref": "#/components/schemas/StateMachineState"
|
|
3592
|
+
"$ref": "#/components/schemas/StateMachineState",
|
|
3593
|
+
"description": "Current payment transaction state (e.g., open, paid, cancelled)"
|
|
3594
|
+
},
|
|
3595
|
+
"paymentMethod": {
|
|
3596
|
+
"$ref": "#/components/schemas/PaymentMethod",
|
|
3597
|
+
"description": "Payment method used for this transaction"
|
|
3502
3598
|
},
|
|
3503
|
-
"paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" },
|
|
3504
3599
|
"captures": {
|
|
3600
|
+
"description": "Payment captures for this transaction",
|
|
3505
3601
|
"type": "array",
|
|
3506
3602
|
"items": { "$ref": "#/components/schemas/OrderTransactionCapture" }
|
|
3507
3603
|
}
|
|
@@ -3732,6 +3828,7 @@
|
|
|
3732
3828
|
"relationships": {
|
|
3733
3829
|
"properties": {
|
|
3734
3830
|
"media": {
|
|
3831
|
+
"description": "Payment method logo or icon image",
|
|
3735
3832
|
"properties": {
|
|
3736
3833
|
"links": {
|
|
3737
3834
|
"type": "object",
|
|
@@ -3794,7 +3891,10 @@
|
|
|
3794
3891
|
"readOnly": true
|
|
3795
3892
|
},
|
|
3796
3893
|
"translated": { "type": "object" },
|
|
3797
|
-
"media": {
|
|
3894
|
+
"media": {
|
|
3895
|
+
"$ref": "#/components/schemas/Media",
|
|
3896
|
+
"description": "Payment method logo or icon image"
|
|
3897
|
+
}
|
|
3798
3898
|
},
|
|
3799
3899
|
"type": "object"
|
|
3800
3900
|
},
|
|
@@ -4002,6 +4102,7 @@
|
|
|
4002
4102
|
"relationships": {
|
|
4003
4103
|
"properties": {
|
|
4004
4104
|
"downloads": {
|
|
4105
|
+
"description": "Downloadable files associated with the product (e.g., manuals, digital content)",
|
|
4005
4106
|
"properties": {
|
|
4006
4107
|
"links": {
|
|
4007
4108
|
"type": "object",
|
|
@@ -4059,6 +4160,7 @@
|
|
|
4059
4160
|
"type": "object"
|
|
4060
4161
|
},
|
|
4061
4162
|
"children": {
|
|
4163
|
+
"description": "Product variants that inherit from this parent product",
|
|
4062
4164
|
"properties": {
|
|
4063
4165
|
"links": {
|
|
4064
4166
|
"type": "object",
|
|
@@ -4087,6 +4189,7 @@
|
|
|
4087
4189
|
"type": "object"
|
|
4088
4190
|
},
|
|
4089
4191
|
"deliveryTime": {
|
|
4192
|
+
"description": "Estimated delivery time for the product",
|
|
4090
4193
|
"properties": {
|
|
4091
4194
|
"links": {
|
|
4092
4195
|
"type": "object",
|
|
@@ -4116,6 +4219,7 @@
|
|
|
4116
4219
|
"type": "object"
|
|
4117
4220
|
},
|
|
4118
4221
|
"tax": {
|
|
4222
|
+
"description": "Tax configuration (rate and calculation rules)",
|
|
4119
4223
|
"properties": {
|
|
4120
4224
|
"links": {
|
|
4121
4225
|
"type": "object",
|
|
@@ -4142,6 +4246,7 @@
|
|
|
4142
4246
|
"type": "object"
|
|
4143
4247
|
},
|
|
4144
4248
|
"manufacturer": {
|
|
4249
|
+
"description": "Product manufacturer or brand information",
|
|
4145
4250
|
"properties": {
|
|
4146
4251
|
"links": {
|
|
4147
4252
|
"type": "object",
|
|
@@ -4171,6 +4276,7 @@
|
|
|
4171
4276
|
"type": "object"
|
|
4172
4277
|
},
|
|
4173
4278
|
"unit": {
|
|
4279
|
+
"description": "Product unit of measure (e.g., piece, liter, kg)",
|
|
4174
4280
|
"properties": {
|
|
4175
4281
|
"links": {
|
|
4176
4282
|
"type": "object",
|
|
@@ -4197,6 +4303,7 @@
|
|
|
4197
4303
|
"type": "object"
|
|
4198
4304
|
},
|
|
4199
4305
|
"cover": {
|
|
4306
|
+
"description": "Main product image displayed in listings and detail pages",
|
|
4200
4307
|
"properties": {
|
|
4201
4308
|
"links": {
|
|
4202
4309
|
"type": "object",
|
|
@@ -4226,6 +4333,7 @@
|
|
|
4226
4333
|
"type": "object"
|
|
4227
4334
|
},
|
|
4228
4335
|
"cmsPage": {
|
|
4336
|
+
"description": "Custom CMS page layout for the product detail page",
|
|
4229
4337
|
"properties": {
|
|
4230
4338
|
"links": {
|
|
4231
4339
|
"type": "object",
|
|
@@ -4252,6 +4360,7 @@
|
|
|
4252
4360
|
"type": "object"
|
|
4253
4361
|
},
|
|
4254
4362
|
"canonicalProduct": {
|
|
4363
|
+
"description": "Canonical product reference for variant consolidation and SEO purposes",
|
|
4255
4364
|
"properties": {
|
|
4256
4365
|
"links": {
|
|
4257
4366
|
"type": "object",
|
|
@@ -4278,6 +4387,7 @@
|
|
|
4278
4387
|
"type": "object"
|
|
4279
4388
|
},
|
|
4280
4389
|
"media": {
|
|
4390
|
+
"description": "Product images and media gallery",
|
|
4281
4391
|
"properties": {
|
|
4282
4392
|
"links": {
|
|
4283
4393
|
"type": "object",
|
|
@@ -4309,6 +4419,7 @@
|
|
|
4309
4419
|
"type": "object"
|
|
4310
4420
|
},
|
|
4311
4421
|
"crossSellings": {
|
|
4422
|
+
"description": "Cross-selling configurations (related products, accessories, similar items)",
|
|
4312
4423
|
"properties": {
|
|
4313
4424
|
"links": {
|
|
4314
4425
|
"type": "object",
|
|
@@ -4340,6 +4451,7 @@
|
|
|
4340
4451
|
"type": "object"
|
|
4341
4452
|
},
|
|
4342
4453
|
"configuratorSettings": {
|
|
4454
|
+
"description": "Variant configurator settings defining available options for product variants",
|
|
4343
4455
|
"properties": {
|
|
4344
4456
|
"links": {
|
|
4345
4457
|
"type": "object",
|
|
@@ -4371,6 +4483,7 @@
|
|
|
4371
4483
|
"type": "object"
|
|
4372
4484
|
},
|
|
4373
4485
|
"productReviews": {
|
|
4486
|
+
"description": "Customer reviews and ratings for the product",
|
|
4374
4487
|
"properties": {
|
|
4375
4488
|
"links": {
|
|
4376
4489
|
"type": "object",
|
|
@@ -4402,6 +4515,7 @@
|
|
|
4402
4515
|
"type": "object"
|
|
4403
4516
|
},
|
|
4404
4517
|
"mainCategories": {
|
|
4518
|
+
"description": "Primary category assignments per sales channel for SEO and navigation",
|
|
4405
4519
|
"properties": {
|
|
4406
4520
|
"links": {
|
|
4407
4521
|
"type": "object",
|
|
@@ -4433,6 +4547,7 @@
|
|
|
4433
4547
|
"type": "object"
|
|
4434
4548
|
},
|
|
4435
4549
|
"seoUrls": {
|
|
4550
|
+
"description": "SEO-friendly URLs for the product across different sales channels",
|
|
4436
4551
|
"properties": {
|
|
4437
4552
|
"links": {
|
|
4438
4553
|
"type": "object",
|
|
@@ -4461,6 +4576,7 @@
|
|
|
4461
4576
|
"type": "object"
|
|
4462
4577
|
},
|
|
4463
4578
|
"options": {
|
|
4579
|
+
"description": "Product variant options (e.g., size, color) that define different variants",
|
|
4464
4580
|
"properties": {
|
|
4465
4581
|
"links": {
|
|
4466
4582
|
"type": "object",
|
|
@@ -4492,6 +4608,7 @@
|
|
|
4492
4608
|
"type": "object"
|
|
4493
4609
|
},
|
|
4494
4610
|
"properties": {
|
|
4611
|
+
"description": "Product properties and characteristics for filtering",
|
|
4495
4612
|
"properties": {
|
|
4496
4613
|
"links": {
|
|
4497
4614
|
"type": "object",
|
|
@@ -4523,6 +4640,7 @@
|
|
|
4523
4640
|
"type": "object"
|
|
4524
4641
|
},
|
|
4525
4642
|
"categories": {
|
|
4643
|
+
"description": "Categories this product is assigned to",
|
|
4526
4644
|
"properties": {
|
|
4527
4645
|
"links": {
|
|
4528
4646
|
"type": "object",
|
|
@@ -4551,6 +4669,7 @@
|
|
|
4551
4669
|
"type": "object"
|
|
4552
4670
|
},
|
|
4553
4671
|
"streams": {
|
|
4672
|
+
"description": "Dynamic product streams this product belongs to based on defined filters",
|
|
4554
4673
|
"properties": {
|
|
4555
4674
|
"links": {
|
|
4556
4675
|
"type": "object",
|
|
@@ -4582,6 +4701,7 @@
|
|
|
4582
4701
|
"type": "object"
|
|
4583
4702
|
},
|
|
4584
4703
|
"categoriesRo": {
|
|
4704
|
+
"description": "Read-only category tree including all parent categories for optimized queries",
|
|
4585
4705
|
"properties": {
|
|
4586
4706
|
"links": {
|
|
4587
4707
|
"type": "object",
|
|
@@ -4610,6 +4730,7 @@
|
|
|
4610
4730
|
"type": "object"
|
|
4611
4731
|
},
|
|
4612
4732
|
"tags": {
|
|
4733
|
+
"description": "Tags for organizing and filtering products",
|
|
4613
4734
|
"properties": {
|
|
4614
4735
|
"links": {
|
|
4615
4736
|
"type": "object",
|
|
@@ -4638,6 +4759,7 @@
|
|
|
4638
4759
|
"type": "object"
|
|
4639
4760
|
},
|
|
4640
4761
|
"seoCategory": {
|
|
4762
|
+
"description": "Main category used for SEO URL generation in the current sales channel",
|
|
4641
4763
|
"properties": {
|
|
4642
4764
|
"links": {
|
|
4643
4765
|
"type": "object",
|
|
@@ -4872,74 +4994,110 @@
|
|
|
4872
4994
|
},
|
|
4873
4995
|
"translated": { "type": "object" },
|
|
4874
4996
|
"downloads": {
|
|
4997
|
+
"description": "Downloadable files associated with the product (e.g., manuals, digital content)",
|
|
4875
4998
|
"type": "array",
|
|
4876
4999
|
"items": { "$ref": "#/components/schemas/ProductDownload" }
|
|
4877
5000
|
},
|
|
4878
5001
|
"parent": { "$ref": "#/components/schemas/Product" },
|
|
4879
5002
|
"children": {
|
|
5003
|
+
"description": "Product variants that inherit from this parent product",
|
|
4880
5004
|
"type": "array",
|
|
4881
5005
|
"items": { "$ref": "#/components/schemas/Product" }
|
|
4882
5006
|
},
|
|
4883
|
-
"deliveryTime": {
|
|
4884
|
-
|
|
5007
|
+
"deliveryTime": {
|
|
5008
|
+
"$ref": "#/components/schemas/DeliveryTime",
|
|
5009
|
+
"description": "Estimated delivery time for the product"
|
|
5010
|
+
},
|
|
5011
|
+
"tax": {
|
|
5012
|
+
"$ref": "#/components/schemas/Tax",
|
|
5013
|
+
"description": "Tax configuration (rate and calculation rules)"
|
|
5014
|
+
},
|
|
4885
5015
|
"manufacturer": {
|
|
4886
|
-
"$ref": "#/components/schemas/ProductManufacturer"
|
|
5016
|
+
"$ref": "#/components/schemas/ProductManufacturer",
|
|
5017
|
+
"description": "Product manufacturer or brand information"
|
|
5018
|
+
},
|
|
5019
|
+
"unit": {
|
|
5020
|
+
"$ref": "#/components/schemas/Unit",
|
|
5021
|
+
"description": "Product unit of measure (e.g., piece, liter, kg)"
|
|
5022
|
+
},
|
|
5023
|
+
"cover": {
|
|
5024
|
+
"$ref": "#/components/schemas/ProductMedia",
|
|
5025
|
+
"description": "Main product image displayed in listings and detail pages"
|
|
5026
|
+
},
|
|
5027
|
+
"cmsPage": {
|
|
5028
|
+
"$ref": "#/components/schemas/CmsPage",
|
|
5029
|
+
"description": "Custom CMS page layout for the product detail page"
|
|
5030
|
+
},
|
|
5031
|
+
"canonicalProduct": {
|
|
5032
|
+
"$ref": "#/components/schemas/Product",
|
|
5033
|
+
"description": "Canonical product reference for variant consolidation and SEO purposes"
|
|
4887
5034
|
},
|
|
4888
|
-
"unit": { "$ref": "#/components/schemas/Unit" },
|
|
4889
|
-
"cover": { "$ref": "#/components/schemas/ProductMedia" },
|
|
4890
|
-
"cmsPage": { "$ref": "#/components/schemas/CmsPage" },
|
|
4891
|
-
"canonicalProduct": { "$ref": "#/components/schemas/Product" },
|
|
4892
5035
|
"media": {
|
|
5036
|
+
"description": "Product images and media gallery",
|
|
4893
5037
|
"type": "array",
|
|
4894
5038
|
"items": { "$ref": "#/components/schemas/ProductMedia" }
|
|
4895
5039
|
},
|
|
4896
5040
|
"crossSellings": {
|
|
5041
|
+
"description": "Cross-selling configurations (related products, accessories, similar items)",
|
|
4897
5042
|
"type": "array",
|
|
4898
5043
|
"items": { "$ref": "#/components/schemas/ProductCrossSelling" }
|
|
4899
5044
|
},
|
|
4900
5045
|
"configuratorSettings": {
|
|
5046
|
+
"description": "Variant configurator settings defining available options for product variants",
|
|
4901
5047
|
"type": "array",
|
|
4902
5048
|
"items": {
|
|
4903
5049
|
"$ref": "#/components/schemas/ProductConfiguratorSetting"
|
|
4904
5050
|
}
|
|
4905
5051
|
},
|
|
4906
5052
|
"productReviews": {
|
|
5053
|
+
"description": "Customer reviews and ratings for the product",
|
|
4907
5054
|
"type": "array",
|
|
4908
5055
|
"items": { "$ref": "#/components/schemas/ProductReview" }
|
|
4909
5056
|
},
|
|
4910
5057
|
"mainCategories": {
|
|
5058
|
+
"description": "Primary category assignments per sales channel for SEO and navigation",
|
|
4911
5059
|
"type": "array",
|
|
4912
5060
|
"items": { "$ref": "#/components/schemas/MainCategory" }
|
|
4913
5061
|
},
|
|
4914
5062
|
"seoUrls": {
|
|
5063
|
+
"description": "SEO-friendly URLs for the product across different sales channels",
|
|
4915
5064
|
"type": "array",
|
|
4916
5065
|
"items": { "$ref": "#/components/schemas/SeoUrl" }
|
|
4917
5066
|
},
|
|
4918
5067
|
"options": {
|
|
5068
|
+
"description": "Product variant options (e.g., size, color) that define different variants",
|
|
4919
5069
|
"type": "array",
|
|
4920
5070
|
"items": { "$ref": "#/components/schemas/PropertyGroupOption" }
|
|
4921
5071
|
},
|
|
4922
5072
|
"properties": {
|
|
5073
|
+
"description": "Product properties and characteristics for filtering",
|
|
4923
5074
|
"type": "array",
|
|
4924
5075
|
"items": { "$ref": "#/components/schemas/PropertyGroupOption" }
|
|
4925
5076
|
},
|
|
4926
5077
|
"categories": {
|
|
5078
|
+
"description": "Categories this product is assigned to",
|
|
4927
5079
|
"type": "array",
|
|
4928
5080
|
"items": { "$ref": "#/components/schemas/Category" }
|
|
4929
5081
|
},
|
|
4930
5082
|
"streams": {
|
|
5083
|
+
"description": "Dynamic product streams this product belongs to based on defined filters",
|
|
4931
5084
|
"type": "array",
|
|
4932
5085
|
"items": { "$ref": "#/components/schemas/ProductStream" }
|
|
4933
5086
|
},
|
|
4934
5087
|
"categoriesRo": {
|
|
5088
|
+
"description": "Read-only category tree including all parent categories for optimized queries",
|
|
4935
5089
|
"type": "array",
|
|
4936
5090
|
"items": { "$ref": "#/components/schemas/Category" }
|
|
4937
5091
|
},
|
|
4938
5092
|
"tags": {
|
|
5093
|
+
"description": "Tags for organizing and filtering products",
|
|
4939
5094
|
"type": "array",
|
|
4940
5095
|
"items": { "$ref": "#/components/schemas/Tag" }
|
|
4941
5096
|
},
|
|
4942
|
-
"seoCategory": {
|
|
5097
|
+
"seoCategory": {
|
|
5098
|
+
"$ref": "#/components/schemas/Category",
|
|
5099
|
+
"description": "Main category used for SEO URL generation in the current sales channel"
|
|
5100
|
+
},
|
|
4943
5101
|
"apiAlias": { "type": "string", "enum": ["product"] },
|
|
4944
5102
|
"variantListingConfig": {
|
|
4945
5103
|
"oneOf": [
|
|
@@ -5608,18 +5766,43 @@
|
|
|
5608
5766
|
"readOnly": true
|
|
5609
5767
|
},
|
|
5610
5768
|
"translated": { "type": "object" },
|
|
5611
|
-
"language": {
|
|
5612
|
-
|
|
5613
|
-
|
|
5614
|
-
|
|
5615
|
-
"
|
|
5769
|
+
"language": {
|
|
5770
|
+
"$ref": "#/components/schemas/Language",
|
|
5771
|
+
"description": "Default language for the sales channel"
|
|
5772
|
+
},
|
|
5773
|
+
"currency": {
|
|
5774
|
+
"$ref": "#/components/schemas/Currency",
|
|
5775
|
+
"description": "Default currency for the sales channel"
|
|
5776
|
+
},
|
|
5777
|
+
"paymentMethod": {
|
|
5778
|
+
"$ref": "#/components/schemas/PaymentMethod",
|
|
5779
|
+
"description": "Default payment method for the sales channel"
|
|
5780
|
+
},
|
|
5781
|
+
"shippingMethod": {
|
|
5782
|
+
"$ref": "#/components/schemas/ShippingMethod",
|
|
5783
|
+
"description": "Default shipping method for the sales channel"
|
|
5784
|
+
},
|
|
5785
|
+
"country": {
|
|
5786
|
+
"$ref": "#/components/schemas/Country",
|
|
5787
|
+
"description": "Default country for the sales channel"
|
|
5788
|
+
},
|
|
5616
5789
|
"domains": {
|
|
5790
|
+
"description": "Domain URLs configured for the sales channel",
|
|
5617
5791
|
"type": "array",
|
|
5618
5792
|
"items": { "$ref": "#/components/schemas/SalesChannelDomain" }
|
|
5619
5793
|
},
|
|
5620
|
-
"navigationCategory": {
|
|
5621
|
-
|
|
5622
|
-
|
|
5794
|
+
"navigationCategory": {
|
|
5795
|
+
"$ref": "#/components/schemas/Category",
|
|
5796
|
+
"description": "Root category for navigation menu"
|
|
5797
|
+
},
|
|
5798
|
+
"footerCategory": {
|
|
5799
|
+
"$ref": "#/components/schemas/Category",
|
|
5800
|
+
"description": "Root category for footer navigation"
|
|
5801
|
+
},
|
|
5802
|
+
"serviceCategory": {
|
|
5803
|
+
"$ref": "#/components/schemas/Category",
|
|
5804
|
+
"description": "Root category for service pages"
|
|
5805
|
+
},
|
|
5623
5806
|
"hreflangDefaultDomain": {
|
|
5624
5807
|
"$ref": "#/components/schemas/SalesChannelDomain"
|
|
5625
5808
|
}
|
|
@@ -5944,6 +6127,7 @@
|
|
|
5944
6127
|
"relationships": {
|
|
5945
6128
|
"properties": {
|
|
5946
6129
|
"deliveryTime": {
|
|
6130
|
+
"description": "Estimated delivery time information",
|
|
5947
6131
|
"properties": {
|
|
5948
6132
|
"links": {
|
|
5949
6133
|
"type": "object",
|
|
@@ -5973,6 +6157,7 @@
|
|
|
5973
6157
|
"type": "object"
|
|
5974
6158
|
},
|
|
5975
6159
|
"availabilityRule": {
|
|
6160
|
+
"description": "Rule defining when this shipping method is available",
|
|
5976
6161
|
"properties": {
|
|
5977
6162
|
"links": {
|
|
5978
6163
|
"type": "object",
|
|
@@ -5999,6 +6184,7 @@
|
|
|
5999
6184
|
"type": "object"
|
|
6000
6185
|
},
|
|
6001
6186
|
"prices": {
|
|
6187
|
+
"description": "Shipping prices based on weight, volume, or cart value",
|
|
6002
6188
|
"properties": {
|
|
6003
6189
|
"links": {
|
|
6004
6190
|
"type": "object",
|
|
@@ -6030,6 +6216,7 @@
|
|
|
6030
6216
|
"type": "object"
|
|
6031
6217
|
},
|
|
6032
6218
|
"media": {
|
|
6219
|
+
"description": "Shipping method logo or carrier image",
|
|
6033
6220
|
"properties": {
|
|
6034
6221
|
"links": {
|
|
6035
6222
|
"type": "object",
|
|
@@ -6056,6 +6243,7 @@
|
|
|
6056
6243
|
"type": "object"
|
|
6057
6244
|
},
|
|
6058
6245
|
"tags": {
|
|
6246
|
+
"description": "Tags for organizing shipping methods",
|
|
6059
6247
|
"properties": {
|
|
6060
6248
|
"links": {
|
|
6061
6249
|
"type": "object",
|
|
@@ -6084,6 +6272,7 @@
|
|
|
6084
6272
|
"type": "object"
|
|
6085
6273
|
},
|
|
6086
6274
|
"tax": {
|
|
6275
|
+
"description": "Tax configuration for shipping costs",
|
|
6087
6276
|
"properties": {
|
|
6088
6277
|
"links": {
|
|
6089
6278
|
"type": "object",
|
|
@@ -6143,18 +6332,32 @@
|
|
|
6143
6332
|
"readOnly": true
|
|
6144
6333
|
},
|
|
6145
6334
|
"translated": { "type": "object" },
|
|
6146
|
-
"deliveryTime": {
|
|
6147
|
-
|
|
6335
|
+
"deliveryTime": {
|
|
6336
|
+
"$ref": "#/components/schemas/DeliveryTime",
|
|
6337
|
+
"description": "Estimated delivery time information"
|
|
6338
|
+
},
|
|
6339
|
+
"availabilityRule": {
|
|
6340
|
+
"$ref": "#/components/schemas/Rule",
|
|
6341
|
+
"description": "Rule defining when this shipping method is available"
|
|
6342
|
+
},
|
|
6148
6343
|
"prices": {
|
|
6344
|
+
"description": "Shipping prices based on weight, volume, or cart value",
|
|
6149
6345
|
"type": "array",
|
|
6150
6346
|
"items": { "$ref": "#/components/schemas/ShippingMethodPrice" }
|
|
6151
6347
|
},
|
|
6152
|
-
"media": {
|
|
6348
|
+
"media": {
|
|
6349
|
+
"$ref": "#/components/schemas/Media",
|
|
6350
|
+
"description": "Shipping method logo or carrier image"
|
|
6351
|
+
},
|
|
6153
6352
|
"tags": {
|
|
6353
|
+
"description": "Tags for organizing shipping methods",
|
|
6154
6354
|
"type": "array",
|
|
6155
6355
|
"items": { "$ref": "#/components/schemas/Tag" }
|
|
6156
6356
|
},
|
|
6157
|
-
"tax": {
|
|
6357
|
+
"tax": {
|
|
6358
|
+
"$ref": "#/components/schemas/Tax",
|
|
6359
|
+
"description": "Tax configuration for shipping costs"
|
|
6360
|
+
}
|
|
6158
6361
|
},
|
|
6159
6362
|
"type": "object"
|
|
6160
6363
|
},
|
|
@@ -7304,7 +7507,7 @@
|
|
|
7304
7507
|
"type": "array",
|
|
7305
7508
|
"items": { "$ref": "#/components/schemas/LineItem" }
|
|
7306
7509
|
},
|
|
7307
|
-
"cover": { "$ref": "#/components/schemas/
|
|
7510
|
+
"cover": { "$ref": "#/components/schemas/Media" },
|
|
7308
7511
|
"dataContextHash": { "type": "string" },
|
|
7309
7512
|
"dataTimestamp": { "type": "string" },
|
|
7310
7513
|
"deliveryInformation": {
|
|
@@ -8661,7 +8864,7 @@
|
|
|
8661
8864
|
"type": "array",
|
|
8662
8865
|
"items": { "$ref": "#/components/schemas/Breadcrumb" }
|
|
8663
8866
|
},
|
|
8664
|
-
"
|
|
8867
|
+
"ShopBiteConfig": {
|
|
8665
8868
|
"type": "object",
|
|
8666
8869
|
"description": "ShopBite configuration data",
|
|
8667
8870
|
"properties": {
|
|
@@ -9742,7 +9945,7 @@
|
|
|
9742
9945
|
"post": {
|
|
9743
9946
|
"tags": ["Profile", "Endpoints supporting Criteria "],
|
|
9744
9947
|
"summary": "Get information about current customer",
|
|
9745
|
-
"description": "Returns information about the current customer.",
|
|
9948
|
+
"description": "Returns information about the current customer.\n\n**Available Associations:**\n- `group` - Customer group determining pricing and permissions\n- `language` - Preferred language for customer communication\n- `lastPaymentMethod` - Last used payment method by the customer\n- `defaultBillingAddress` - Default billing address for the customer\n- `activeBillingAddress` - Currently active billing address in the session\n- `defaultShippingAddress` - Default shipping address for the customer\n- `activeShippingAddress` - Currently active shipping address in the session\n- `salutation` - Customer salutation (e.g., Mr., Mrs., Ms.)\n- `addresses` - All addresses saved for the customer\n- `tags` - Tags assigned to the customer for organization and segmentation",
|
|
9746
9949
|
"operationId": "readCustomer",
|
|
9747
9950
|
"requestBody": {
|
|
9748
9951
|
"required": false,
|
|
@@ -10387,7 +10590,7 @@
|
|
|
10387
10590
|
"post": {
|
|
10388
10591
|
"tags": ["System & Context", "Endpoints supporting Criteria "],
|
|
10389
10592
|
"summary": "Fetch languages",
|
|
10390
|
-
"description": "Perform a filtered search for languages
|
|
10593
|
+
"description": "Perform a filtered search for languages.\n\n**Available Associations:**\n- `locale` - Locale defining regional settings (date, time, number formats)\n- `translationCode` - Locale used for translating content\n- `children` - Child languages inheriting from this parent language",
|
|
10391
10594
|
"operationId": "readLanguages",
|
|
10392
10595
|
"parameters": [
|
|
10393
10596
|
{
|
|
@@ -10423,7 +10626,7 @@
|
|
|
10423
10626
|
"get": {
|
|
10424
10627
|
"tags": ["System & Context", "Endpoints supporting Criteria "],
|
|
10425
10628
|
"summary": "Fetch languages",
|
|
10426
|
-
"description": "Perform a filtered search for languages
|
|
10629
|
+
"description": "Perform a filtered search for languages.\n\n**Available Associations:**\n- `locale` - Locale defining regional settings (date, time, number formats)\n- `translationCode` - Locale used for translating content\n- `children` - Child languages inheriting from this parent language",
|
|
10427
10630
|
"operationId": "readLanguagesGet",
|
|
10428
10631
|
"parameters": [
|
|
10429
10632
|
{
|
|
@@ -10459,7 +10662,7 @@
|
|
|
10459
10662
|
"post": {
|
|
10460
10663
|
"tags": ["Product"],
|
|
10461
10664
|
"summary": "Fetch a product listing by category",
|
|
10462
|
-
"description": "Fetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint.",
|
|
10665
|
+
"description": "Fetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint.\n\n**Available Associations:**\n- `downloads` - Downloadable files associated with the product (e.g., manuals, digital content)\n- `children` - Product variants that inherit from this parent product\n- `deliveryTime` - Estimated delivery time for the product\n- `tax` - Tax configuration (rate and calculation rules)\n- `manufacturer` - Product manufacturer or brand information\n- `unit` - Product unit of measure (e.g., piece, liter, kg)\n- `cover` - Main product image displayed in listings and detail pages\n- `cmsPage` - Custom CMS page layout for the product detail page\n- `canonicalProduct` - Canonical product reference for variant consolidation and SEO purposes\n- `media` - Product images and media gallery\n- `crossSellings` - Cross-selling configurations (related products, accessories, similar items)\n- `configuratorSettings` - Variant configurator settings defining available options for product variants\n- `productReviews` - Customer reviews and ratings for the product\n- `mainCategories` - Primary category assignments per sales channel for SEO and navigation\n- `seoUrls` - SEO-friendly URLs for the product across different sales channels\n- `options` - Product variant options (e.g., size, color) that define different variants\n- `properties` - Product properties and characteristics for filtering\n- `categories` - Categories this product is assigned to\n- `streams` - Dynamic product streams this product belongs to based on defined filters\n- `categoriesRo` - Read-only category tree including all parent categories for optimized queries\n- `tags` - Tags for organizing and filtering products\n- `seoCategory` - Main category used for SEO URL generation in the current sales channel",
|
|
10463
10666
|
"operationId": "readProductListing",
|
|
10464
10667
|
"parameters": [
|
|
10465
10668
|
{
|
|
@@ -10575,7 +10778,7 @@
|
|
|
10575
10778
|
"post": {
|
|
10576
10779
|
"tags": ["Order", "Endpoints supporting Criteria "],
|
|
10577
10780
|
"summary": "Fetch a list of orders",
|
|
10578
|
-
"description": "List orders of a customer.",
|
|
10781
|
+
"description": "List orders of a customer.\n\n**Available Associations:**\n- `stateMachineState` - Current order state (e.g., open, in_progress, completed, cancelled)\n- `primaryOrderDelivery` - Primary delivery information for the order\n- `primaryOrderTransaction` - Primary payment transaction for the order\n- `orderCustomer` - Customer information associated with the order\n- `currency` - Currency used for the order\n- `language` - Language used when placing the order\n- `addresses` - All addresses associated with the order (billing and shipping)\n- `billingAddress` - Billing address for the order\n- `deliveries` - Delivery information including shipping address and tracking\n- `lineItems` - Order line items (products, discounts, fees)\n- `transactions` - Payment transactions for the order\n- `documents` - Generated documents (invoices, delivery notes, credit notes)\n- `tags` - Tags assigned to the order for organization and filtering",
|
|
10579
10782
|
"operationId": "readOrder",
|
|
10580
10783
|
"parameters": [
|
|
10581
10784
|
{
|
|
@@ -10764,7 +10967,7 @@
|
|
|
10764
10967
|
"post": {
|
|
10765
10968
|
"tags": ["Payment & Shipping", "Endpoints supporting Criteria "],
|
|
10766
10969
|
"summary": "Fetch shipping methods",
|
|
10767
|
-
"description": "Perform a filtered search for shipping methods.",
|
|
10970
|
+
"description": "Perform a filtered search for shipping methods.\n\n**Available Associations:**\n- `prices` - Shipping method price configurations (based on current cart and context)\n- `deliveryTime` - Delivery time information (min/max days, unit)\n- `media` - Media/images associated with the shipping method (loaded by default)\n- `availabilityRule` - Availability rule determining when this method is available\n- `tax` - Tax configuration for the shipping method\n\n**Example with associations:**\n```json\n{\n \"associations\": {\n \"prices\": {},\n \"deliveryTime\": {}\n }\n}\n```\n\nNote: The `prices` association is essential for accessing shipping cost configurations.",
|
|
10768
10971
|
"operationId": "readShippingMethod",
|
|
10769
10972
|
"parameters": [
|
|
10770
10973
|
{
|
|
@@ -10837,7 +11040,7 @@
|
|
|
10837
11040
|
"get": {
|
|
10838
11041
|
"tags": ["Payment & Shipping", "Endpoints supporting Criteria "],
|
|
10839
11042
|
"summary": "Fetch shipping methods",
|
|
10840
|
-
"description": "Perform a filtered search for shipping methods.",
|
|
11043
|
+
"description": "Perform a filtered search for shipping methods.\n\n**Available Associations:**\n- `prices` - Shipping method price configurations (graduated prices, quantity-based pricing)\n- `deliveryTime` - Delivery time information (min/max days, unit)\n- `media` - Media/images associated with the shipping method (loaded by default)\n- `availabilityRule` - Availability rule determining when this method is available\n- `tax` - Tax configuration for the shipping method\n\nNote: The `prices` association is essential for accessing shipping cost configurations.",
|
|
10841
11044
|
"operationId": "readShippingMethodGet",
|
|
10842
11045
|
"parameters": [
|
|
10843
11046
|
{
|
|
@@ -10945,7 +11148,7 @@
|
|
|
10945
11148
|
"post": {
|
|
10946
11149
|
"tags": ["Content"],
|
|
10947
11150
|
"summary": "Fetch and resolve a CMS page",
|
|
10948
|
-
"description": "Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page
|
|
11151
|
+
"description": "Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.\n\n**Available Associations:**\n- `sections` - Content sections within the CMS page (layout blocks containing slots)\n- `previewMedia` - Preview image for the CMS page in admin panel and page selection\n- `landingPages` - Landing pages using this CMS layout",
|
|
10949
11152
|
"operationId": "readCms",
|
|
10950
11153
|
"parameters": [
|
|
10951
11154
|
{
|
|
@@ -11006,7 +11209,7 @@
|
|
|
11006
11209
|
"get": {
|
|
11007
11210
|
"tags": ["Content"],
|
|
11008
11211
|
"summary": "Fetch and resolve a CMS page",
|
|
11009
|
-
"description": "Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page
|
|
11212
|
+
"description": "Loads a content management page by its identifier and resolve the slot data. This could be media files, product listing and so on.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.\n\n**Available Associations:**\n- `sections` - Content sections within the CMS page (layout blocks containing slots)\n- `previewMedia` - Preview image for the CMS page in admin panel and page selection\n- `landingPages` - Landing pages using this CMS layout",
|
|
11010
11213
|
"operationId": "readCmsGet",
|
|
11011
11214
|
"parameters": [
|
|
11012
11215
|
{
|
|
@@ -11349,7 +11552,7 @@
|
|
|
11349
11552
|
"post": {
|
|
11350
11553
|
"tags": ["System & Context", "Endpoints supporting Criteria "],
|
|
11351
11554
|
"summary": "Fetch countries",
|
|
11352
|
-
"description": "Perform a filtered search for countries",
|
|
11555
|
+
"description": "Perform a filtered search for countries\n\n**Available Associations:**\n- `states` - States/provinces/regions within the country",
|
|
11353
11556
|
"operationId": "readCountry",
|
|
11354
11557
|
"parameters": [
|
|
11355
11558
|
{
|
|
@@ -11385,7 +11588,7 @@
|
|
|
11385
11588
|
"get": {
|
|
11386
11589
|
"tags": ["System & Context", "Endpoints supporting Criteria "],
|
|
11387
11590
|
"summary": "Fetch countries",
|
|
11388
|
-
"description": "Perform a filtered search for countries",
|
|
11591
|
+
"description": "Perform a filtered search for countries\n\n**Available Associations:**\n- `states` - States/provinces/regions within the country",
|
|
11389
11592
|
"operationId": "readCountryGet",
|
|
11390
11593
|
"parameters": [
|
|
11391
11594
|
{
|
|
@@ -11719,7 +11922,8 @@
|
|
|
11719
11922
|
"schema": { "$ref": "#/components/schemas/Cart" }
|
|
11720
11923
|
}
|
|
11721
11924
|
}
|
|
11722
|
-
}
|
|
11925
|
+
},
|
|
11926
|
+
"400": { "$ref": "#/components/responses/400" }
|
|
11723
11927
|
},
|
|
11724
11928
|
"security": [{ "ApiKey": [] }]
|
|
11725
11929
|
},
|
|
@@ -11976,7 +12180,7 @@
|
|
|
11976
12180
|
"post": {
|
|
11977
12181
|
"tags": ["Category", "Endpoints supporting Criteria "],
|
|
11978
12182
|
"summary": "Fetch a list of categories",
|
|
11979
|
-
"description": "Perform a filtered search for categories
|
|
12183
|
+
"description": "Perform a filtered search for categories.\n\n**Available Associations:**\n- `children` - Child categories within this category for hierarchical navigation\n- `media` - Category image or banner\n- `tags` - Tags for organizing and filtering categories\n- `cmsPage` - CMS page layout for the category\n- `seoUrls` - SEO-friendly URLs for the category across different sales channels",
|
|
11980
12184
|
"operationId": "readCategoryList",
|
|
11981
12185
|
"parameters": [
|
|
11982
12186
|
{
|
|
@@ -12012,7 +12216,7 @@
|
|
|
12012
12216
|
"get": {
|
|
12013
12217
|
"tags": ["Category", "Endpoints supporting Criteria "],
|
|
12014
12218
|
"summary": "Fetch a list of categories",
|
|
12015
|
-
"description": "Perform a filtered search for categories
|
|
12219
|
+
"description": "Perform a filtered search for categories.\n\n**Available Associations:**\n- `children` - Child categories within this category for hierarchical navigation\n- `media` - Category image or banner\n- `tags` - Tags for organizing and filtering categories\n- `cmsPage` - CMS page layout for the category\n- `seoUrls` - SEO-friendly URLs for the category across different sales channels",
|
|
12016
12220
|
"operationId": "readCategoryListGet",
|
|
12017
12221
|
"parameters": [
|
|
12018
12222
|
{
|
|
@@ -12048,7 +12252,7 @@
|
|
|
12048
12252
|
"post": {
|
|
12049
12253
|
"tags": ["Category", "Endpoints supporting Criteria "],
|
|
12050
12254
|
"summary": "Fetch a single category",
|
|
12051
|
-
"description": "This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively
|
|
12255
|
+
"description": "This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively.\n\n**Available Associations:**\n- `children` - Child categories within this category for hierarchical navigation\n- `media` - Category image or banner\n- `tags` - Tags for organizing and filtering categories\n- `cmsPage` - CMS page layout for the category\n- `seoUrls` - SEO-friendly URLs for the category across different sales channels",
|
|
12052
12256
|
"operationId": "readCategory",
|
|
12053
12257
|
"parameters": [
|
|
12054
12258
|
{
|
|
@@ -12112,7 +12316,7 @@
|
|
|
12112
12316
|
"get": {
|
|
12113
12317
|
"tags": ["Category", "Endpoints supporting Criteria "],
|
|
12114
12318
|
"summary": "Fetch a single category",
|
|
12115
|
-
"description": "This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively
|
|
12319
|
+
"description": "This endpoint returns information about the category, as well as a fully resolved (hydrated with mapping values) CMS page, if one is assigned to the category. You can pass slots which should be resolved exclusively.\n\n**Available Associations:**\n- `children` - Child categories within this category for hierarchical navigation\n- `media` - Category image or banner\n- `tags` - Tags for organizing and filtering categories\n- `cmsPage` - CMS page layout for the category\n- `seoUrls` - SEO-friendly URLs for the category across different sales channels",
|
|
12116
12320
|
"operationId": "readCategoryGet",
|
|
12117
12321
|
"parameters": [
|
|
12118
12322
|
{
|
|
@@ -12270,7 +12474,7 @@
|
|
|
12270
12474
|
"post": {
|
|
12271
12475
|
"tags": ["Content", "Endpoints supporting Criteria "],
|
|
12272
12476
|
"summary": "Fetch a landing page with the resolved CMS page",
|
|
12273
|
-
"description": "Loads a landing page by its identifier and resolves the CMS page.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page
|
|
12477
|
+
"description": "Loads a landing page by its identifier and resolves the CMS page.\n\n**Important notice**\n\nThe criteria passed with this route also affects the listing, if there is one within the cms page.\n\n**Available Associations:**\n- `cmsPage` - CMS page layout for the landing page\n- `seoUrls` - SEO-friendly URLs for the landing page across different sales channels",
|
|
12274
12478
|
"operationId": "readLandingPage",
|
|
12275
12479
|
"parameters": [
|
|
12276
12480
|
{
|
|
@@ -12818,7 +13022,7 @@
|
|
|
12818
13022
|
"post": {
|
|
12819
13023
|
"tags": ["Product"],
|
|
12820
13024
|
"summary": "Fetch a single product",
|
|
12821
|
-
"description": "This route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined when a parent id is passed.",
|
|
13025
|
+
"description": "This route is used to load a single product with the corresponding details. In addition to loading the data, the best variant of the product is determined when a parent id is passed.\n\n**Available Associations:**\n- `downloads` - Downloadable files associated with the product (e.g., manuals, digital content)\n- `children` - Product variants that inherit from this parent product\n- `deliveryTime` - Estimated delivery time for the product\n- `tax` - Tax configuration (rate and calculation rules)\n- `manufacturer` - Product manufacturer or brand information\n- `unit` - Product unit of measure (e.g., piece, liter, kg)\n- `cover` - Main product image displayed in listings and detail pages\n- `cmsPage` - Custom CMS page layout for the product detail page\n- `canonicalProduct` - Canonical product reference for variant consolidation and SEO purposes\n- `media` - Product images and media gallery\n- `crossSellings` - Cross-selling configurations (related products, accessories, similar items)\n- `configuratorSettings` - Variant configurator settings defining available options for product variants\n- `productReviews` - Customer reviews and ratings for the product\n- `mainCategories` - Primary category assignments per sales channel for SEO and navigation\n- `seoUrls` - SEO-friendly URLs for the product across different sales channels\n- `options` - Product variant options (e.g., size, color) that define different variants\n- `properties` - Product properties and characteristics for filtering\n- `categories` - Categories this product is assigned to\n- `streams` - Dynamic product streams this product belongs to based on defined filters\n- `categoriesRo` - Read-only category tree including all parent categories for optimized queries\n- `tags` - Tags for organizing and filtering products\n- `seoCategory` - Main category used for SEO URL generation in the current sales channel",
|
|
12822
13026
|
"operationId": "readProductDetail",
|
|
12823
13027
|
"parameters": [
|
|
12824
13028
|
{
|
|
@@ -12893,7 +13097,7 @@
|
|
|
12893
13097
|
"post": {
|
|
12894
13098
|
"tags": ["Product", "Endpoints supporting Criteria "],
|
|
12895
13099
|
"summary": "Fetch a list of products",
|
|
12896
|
-
"description": "List products that match the given criteria. For performance reasons a limit should always be set.",
|
|
13100
|
+
"description": "List products that match the given criteria. For performance reasons a limit should always be set.\n\n**Available Associations:**\n- `downloads` - Downloadable files associated with the product (e.g., manuals, digital content)\n- `children` - Product variants that inherit from this parent product\n- `deliveryTime` - Estimated delivery time for the product\n- `tax` - Tax configuration (rate and calculation rules)\n- `manufacturer` - Product manufacturer or brand information\n- `unit` - Product unit of measure (e.g., piece, liter, kg)\n- `cover` - Main product image displayed in listings and detail pages\n- `cmsPage` - Custom CMS page layout for the product detail page\n- `canonicalProduct` - Canonical product reference for variant consolidation and SEO purposes\n- `media` - Product images and media gallery\n- `crossSellings` - Cross-selling configurations (related products, accessories, similar items)\n- `configuratorSettings` - Variant configurator settings defining available options for product variants\n- `productReviews` - Customer reviews and ratings for the product\n- `mainCategories` - Primary category assignments per sales channel for SEO and navigation\n- `seoUrls` - SEO-friendly URLs for the product across different sales channels\n- `options` - Product variant options (e.g., size, color) that define different variants\n- `properties` - Product properties and characteristics for filtering\n- `categories` - Categories this product is assigned to\n- `streams` - Dynamic product streams this product belongs to based on defined filters\n- `categoriesRo` - Read-only category tree including all parent categories for optimized queries\n- `tags` - Tags for organizing and filtering products\n- `seoCategory` - Main category used for SEO URL generation in the current sales channel",
|
|
12897
13101
|
"operationId": "readProduct",
|
|
12898
13102
|
"parameters": [
|
|
12899
13103
|
{
|
|
@@ -12929,7 +13133,7 @@
|
|
|
12929
13133
|
"get": {
|
|
12930
13134
|
"tags": ["Product", "Endpoints supporting Criteria "],
|
|
12931
13135
|
"summary": "Fetch a list of products",
|
|
12932
|
-
"description": "List products that match the given criteria. For performance reasons a limit should always be set.",
|
|
13136
|
+
"description": "List products that match the given criteria. For performance reasons a limit should always be set.\n\n**Available Associations:**\n- `downloads` - Downloadable files associated with the product (e.g., manuals, digital content)\n- `children` - Product variants that inherit from this parent product\n- `deliveryTime` - Estimated delivery time for the product\n- `tax` - Tax configuration (rate and calculation rules)\n- `manufacturer` - Product manufacturer or brand information\n- `unit` - Product unit of measure (e.g., piece, liter, kg)\n- `cover` - Main product image displayed in listings and detail pages\n- `cmsPage` - Custom CMS page layout for the product detail page\n- `canonicalProduct` - Canonical product reference for variant consolidation and SEO purposes\n- `media` - Product images and media gallery\n- `crossSellings` - Cross-selling configurations (related products, accessories, similar items)\n- `configuratorSettings` - Variant configurator settings defining available options for product variants\n- `productReviews` - Customer reviews and ratings for the product\n- `mainCategories` - Primary category assignments per sales channel for SEO and navigation\n- `seoUrls` - SEO-friendly URLs for the product across different sales channels\n- `options` - Product variant options (e.g., size, color) that define different variants\n- `properties` - Product properties and characteristics for filtering\n- `categories` - Categories this product is assigned to\n- `streams` - Dynamic product streams this product belongs to based on defined filters\n- `categoriesRo` - Read-only category tree including all parent categories for optimized queries\n- `tags` - Tags for organizing and filtering products\n- `seoCategory` - Main category used for SEO URL generation in the current sales channel",
|
|
12933
13137
|
"operationId": "readProductGet",
|
|
12934
13138
|
"parameters": [
|
|
12935
13139
|
{
|
|
@@ -13821,25 +14025,19 @@
|
|
|
13821
14025
|
"security": [{ "ApiKey": [] }]
|
|
13822
14026
|
}
|
|
13823
14027
|
},
|
|
13824
|
-
"/
|
|
14028
|
+
"/shopbite/config": {
|
|
13825
14029
|
"get": {
|
|
13826
14030
|
"tags": ["ShopBite"],
|
|
13827
14031
|
"summary": "Get ShopBite configuration",
|
|
13828
14032
|
"description": "Retrieves ShopBite configuration including checkout status and delivery time",
|
|
13829
|
-
"operationId": "
|
|
14033
|
+
"operationId": "shopbite.config.get",
|
|
13830
14034
|
"parameters": [],
|
|
13831
14035
|
"responses": {
|
|
13832
14036
|
"200": {
|
|
13833
14037
|
"description": "Returns ShopBite Information",
|
|
13834
14038
|
"content": {
|
|
13835
14039
|
"application/json": {
|
|
13836
|
-
"schema": {
|
|
13837
|
-
"type": "object",
|
|
13838
|
-
"properties": {
|
|
13839
|
-
"data": { "$ref": "#/components/schemas/ShopBite" }
|
|
13840
|
-
},
|
|
13841
|
-
"required": ["data"]
|
|
13842
|
-
}
|
|
14040
|
+
"schema": { "$ref": "#/components/schemas/ShopBiteConfig" }
|
|
13843
14041
|
}
|
|
13844
14042
|
}
|
|
13845
14043
|
},
|