· 4 years ago · May 27, 2021, 01:58 PM
1{
2"openapi": "3.0.0",
3"info": {
4"title": "Portal Management API",
5"description": "The Portal Management API for CommerceTools",
6"version": "1.0.0",
7"contact": {}
8},
9"tags": [],
10"servers": [],
11"components": {
12"securitySchemes": {
13"bearer": {
14"scheme": "bearer",
15"bearerFormat": "JWT",
16"type": "http"
17}
18},
19"schemas": {
20"VersionDto": {
21"type": "object",
22"properties": {
23"applicationName": {
24"type": "string",
25"description": "Name of this application"
26},
27"version": {
28"type": "string",
29"description": "Version of this application"
30}
31},
32"required": [
33"applicationName",
34"version"
35]
36},
37"TaxCategoryDto": {
38"type": "object",
39"properties": {
40"id": {
41"type": "string",
42"example": "vat-uk-20"
43},
44"name": {
45"type": "string",
46"example": "20% VAT"
47}
48},
49"required": [
50"id",
51"name"
52]
53},
54"BaristaSetupDto": {
55"type": "object",
56"properties": {
57"canHaveVariants": {
58"type": "boolean"
59},
60"iceMachineRequired": {
61"type": "boolean"
62},
63"blenderRequired": {
64"type": "boolean"
65},
66"canBeDecaf": {
67"type": "boolean"
68},
69"canAddSyrup": {
70"type": "boolean"
71},
72"canAddExtraCoffeeShot": {
73"type": "boolean"
74},
75"canAddWhippedCream": {
76"type": "boolean"
77},
78"canBeWithoutMilk": {
79"type": "boolean"
80},
81"canBeWithSemiSkimmedMilk": {
82"type": "boolean"
83},
84"canBeWithSkimmedMilk": {
85"type": "boolean"
86},
87"canBeWithOatMilk": {
88"type": "boolean"
89},
90"canBeWithRiceCoconutMilk": {
91"type": "boolean"
92},
93"canBeWithSoyMilk": {
94"type": "boolean"
95}
96},
97"required": [
98"canHaveVariants",
99"iceMachineRequired",
100"blenderRequired",
101"canBeDecaf",
102"canAddSyrup",
103"canAddExtraCoffeeShot",
104"canAddWhippedCream",
105"canBeWithoutMilk",
106"canBeWithSemiSkimmedMilk",
107"canBeWithSkimmedMilk",
108"canBeWithOatMilk",
109"canBeWithRiceCoconutMilk",
110"canBeWithSoyMilk"
111]
112},
113"BaristaAttributes": {
114"type": "object",
115"properties": {
116"withDecafPods": {
117"type": "boolean"
118},
119"withMilk": {
120"type": "boolean"
121},
122"withSemiSkimmedMilk": {
123"type": "boolean"
124},
125"withSkimmedMilk": {
126"type": "boolean"
127},
128"withOatMilk": {
129"type": "boolean"
130},
131"withRiceCoconutMilk": {
132"type": "boolean"
133},
134"withSoyMilk": {
135"type": "boolean"
136},
137"isDecaf": {
138"type": "boolean"
139}
140},
141"required": [
142"withDecafPods",
143"withMilk",
144"withSemiSkimmedMilk",
145"withSkimmedMilk",
146"withOatMilk",
147"withRiceCoconutMilk",
148"withSoyMilk",
149"isDecaf"
150]
151},
152"AvailabilityDto": {
153"type": "object",
154"properties": {
155"isLive": {
156"type": "boolean"
157},
158"visibleOnDeliveryWebsite": {
159"type": "boolean"
160},
161"availableForPretDelivers": {
162"type": "boolean"
163},
164"availableForClickAndCollect": {
165"type": "boolean"
166},
167"availableForOutposts": {
168"type": "boolean"
169},
170"isChefsSpecial": {
171"type": "boolean"
172},
173"displayAsNew": {
174"type": "object",
175"properties": {
176"isDisplayed": {
177"type": "boolean",
178"nullable": true
179},
180"until": {
181"type": "string",
182"nullable": true,
183"description": "Date",
184"example": "2022-05-03"
185}
186}
187},
188"liveSchedule": {
189"type": "object",
190"properties": {
191"on": {
192"type": "string",
193"nullable": true,
194"example": "2022-05-03"
195},
196"off": {
197"type": "string",
198"nullable": true,
199"example": "2022-05-05"
200}
201}
202}
203},
204"required": [
205"isLive",
206"visibleOnDeliveryWebsite",
207"availableForPretDelivers",
208"availableForClickAndCollect",
209"availableForOutposts",
210"isChefsSpecial",
211"displayAsNew",
212"liveSchedule"
213]
214},
215"HamiltonGrantCuisineDto": {
216"type": "object",
217"properties": {
218"isVegan": {
219"type": "boolean"
220},
221"isVegetarian": {
222"type": "boolean"
223}
224},
225"required": [
226"isVegan",
227"isVegetarian"
228]
229},
230"NutritionItemDto": {
231"type": "object",
232"properties": {
233"name": {
234"type": "string"
235},
236"localisedLabel": {
237"type": "string"
238},
239"per100g": {
240"type": "number"
241},
242"perServing": {
243"type": "number"
244}
245},
246"required": [
247"name",
248"localisedLabel",
249"per100g",
250"perServing"
251]
252},
253"MultiLangStringDto": {
254"type": "object",
255"properties": {
256"zh-HK": {
257"type": "string"
258},
259"en-US": {
260"type": "string"
261},
262"fr-FR": {
263"type": "string"
264},
265"en-GB": {
266"type": "string"
267},
268"en-HK": {
269"type": "string"
270}
271},
272"required": [
273"zh-HK",
274"en-US",
275"fr-FR",
276"en-GB",
277"en-HK"
278]
279},
280"HamiltonGrantDto": {
281"type": "object",
282"properties": {
283"cuisine": {
284"$ref": "#/components/schemas/HamiltonGrantCuisineDto"
285},
286"productCode": {
287"type": "string"
288},
289"lastSyncedAt": {
290"type": "string",
291"format": "date-time",
292"description": "ISO string"
293},
294"nutrition": {
295"type": "array",
296"items": {
297"$ref": "#/components/schemas/NutritionItemDto"
298}
299},
300"allergens": {
301"$ref": "#/components/schemas/MultiLangStringDto"
302}
303},
304"required": [
305"cuisine",
306"productCode",
307"lastSyncedAt",
308"nutrition",
309"allergens"
310]
311},
312"EnumOption": {
313"type": "object",
314"properties": {
315"key": {
316"type": "string"
317},
318"label": {
319"type": "string"
320}
321},
322"required": [
323"key",
324"label"
325]
326},
327"ImageDto": {
328"type": "object",
329"properties": {
330"default": {
331"type": "string",
332"example": "https://path-to-image.com",
333"description": "Default size image"
334},
335"thumbnail": {
336"type": "string",
337"example": "https://path-to-image.com",
338"description": "Thumbnail size image"
339}
340},
341"required": [
342"default",
343"thumbnail"
344]
345},
346"PriceDto": {
347"type": "object",
348"properties": {
349"currency": {
350"type": "string",
351"enum": [
352"$",
353"£"
354]
355},
356"value": {
357"type": "number"
358}
359},
360"required": [
361"currency",
362"value"
363]
364},
365"VenuePriceDto": {
366"type": "object",
367"properties": {
368"venueName": {
369"type": "string"
370},
371"takeaway": {
372"$ref": "#/components/schemas/PriceDto"
373},
374"dineIn": {
375"$ref": "#/components/schemas/PriceDto"
376},
377"taTax": {
378"$ref": "#/components/schemas/PriceDto"
379},
380"EITax": {
381"$ref": "#/components/schemas/PriceDto"
382}
383},
384"required": [
385"venueName",
386"takeaway",
387"dineIn",
388"taTax",
389"EITax"
390]
391},
392"ProductVariantDto": {
393"type": "object",
394"properties": {
395"attributes": {
396"nullable": true,
397"allOf": [
398{
399"$ref": "#/components/schemas/BaristaAttributes"
400}
401]
402},
403"availability": {
404"$ref": "#/components/schemas/AvailabilityDto"
405},
406"hamiltonGrant": {
407"$ref": "#/components/schemas/HamiltonGrantDto"
408},
409"howToDisplay": {
410"type": "array",
411"items": {
412"$ref": "#/components/schemas/EnumOption"
413}
414},
415"image": {
416"nullable": true,
417"allOf": [
418{
419"$ref": "#/components/schemas/ImageDto"
420}
421]
422},
423"pluReportingName": {
424"type": "object",
425"nullable": true
426},
427"pluPrimaryCategoryID": {
428"type": "object",
429"nullable": true
430},
431"pluSecondaryCategoryID": {
432"type": "object",
433"nullable": true
434},
435"starKisProductCategoryID": {
436"type": "object",
437"nullable": true
438},
439"starKisProductSubCategoryID": {
440"type": "object",
441"nullable": true
442},
443"posID": {
444"type": "object",
445"nullable": true
446},
447"prices": {
448"type": "array",
449"items": {
450"$ref": "#/components/schemas/VenuePriceDto"
451}
452},
453"name": {
454"$ref": "#/components/schemas/MultiLangStringDto"
455},
456"description": {
457"type": "object"
458},
459"sku": {
460"type": "string",
461"example": "UK12345",
462"nullable": false
463},
464"status": {
465"type": "string",
466"enum": [
467"ACTIVE",
468"INACTIVE"
469]
470},
471"isMaster": {
472"type": "boolean"
473},
474"size": {
475"examples": [
476"300g",
477300
478],
479"oneOf": [
480{
481"type": "number"
482},
483{
484"type": "string"
485}
486]
487}
488},
489"required": [
490"attributes",
491"availability",
492"hamiltonGrant",
493"howToDisplay",
494"image",
495"pluReportingName",
496"pluPrimaryCategoryID",
497"pluSecondaryCategoryID",
498"starKisProductCategoryID",
499"starKisProductSubCategoryID",
500"posID",
501"prices",
502"name",
503"description",
504"sku",
505"status",
506"isMaster",
507"size"
508]
509},
510"ProductDto": {
511"type": "object",
512"properties": {
513"country": {
514"type": "string",
515"nullable": false,
516"example": "France",
517"description": "Country name"
518},
519"countryCode": {
520"type": "string",
521"enum": [
522"UK",
523"US",
524"FR",
525"HK"
526],
527"nullable": false
528},
529"categories": {
530"type": "array",
531"items": {
532"type": "array",
533"items": {
534"type": "string"
535}
536},
537"description": "List of lists of IDs",
538"example": [
539[
540"UK",
541"Coffee",
542"Cold"
543],
544[
545"UK",
546"Cold Drinks",
547"Coffee"
548]
549]
550},
551"taxCategory": {
552"nullable": true,
553"allOf": [
554{
555"$ref": "#/components/schemas/TaxCategoryDto"
556}
557]
558},
559"setUp": {
560"nullable": true,
561"allOf": [
562{
563"$ref": "#/components/schemas/BaristaSetupDto"
564}
565]
566},
567"variants": {
568"type": "array",
569"items": {
570"$ref": "#/components/schemas/ProductVariantDto"
571}
572}
573},
574"required": [
575"country",
576"countryCode",
577"categories",
578"taxCategory",
579"setUp",
580"variants"
581]
582},
583"VariantReportingOptionsDto": {
584"type": "object",
585"properties": {
586"pluPrimaryCategoryOptions": {
587"type": "array",
588"items": {
589"$ref": "#/components/schemas/EnumOption"
590}
591},
592"pluSecondaryCategoryOptions": {
593"type": "array",
594"items": {
595"$ref": "#/components/schemas/EnumOption"
596}
597},
598"starKisProductCategoryOptions": {
599"type": "array",
600"items": {
601"$ref": "#/components/schemas/EnumOption"
602}
603},
604"starKisProductSubCategoryOptions": {
605"type": "array",
606"items": {
607"$ref": "#/components/schemas/EnumOption"
608}
609}
610},
611"required": [
612"pluPrimaryCategoryOptions",
613"pluSecondaryCategoryOptions",
614"starKisProductCategoryOptions",
615"starKisProductSubCategoryOptions"
616]
617},
618"ProductVariantDraftChangesDto": {
619"type": "object",
620"properties": {
621"attributes": {
622"nullable": true,
623"allOf": [
624{
625"$ref": "#/components/schemas/BaristaAttributes"
626}
627]
628},
629"availability": {
630"$ref": "#/components/schemas/AvailabilityDto"
631},
632"hamiltonGrant": {
633"$ref": "#/components/schemas/HamiltonGrantDto"
634},
635"howToDisplay": {
636"type": "array",
637"items": {
638"$ref": "#/components/schemas/EnumOption"
639}
640},
641"image": {
642"nullable": true,
643"allOf": [
644{
645"$ref": "#/components/schemas/ImageDto"
646}
647]
648},
649"pluReportingName": {
650"type": "object",
651"nullable": true
652},
653"pluPrimaryCategoryID": {
654"type": "object",
655"nullable": true
656},
657"pluSecondaryCategoryID": {
658"type": "object",
659"nullable": true
660},
661"starKisProductCategoryID": {
662"type": "object",
663"nullable": true
664},
665"starKisProductSubCategoryID": {
666"type": "object",
667"nullable": true
668},
669"posID": {
670"type": "object",
671"nullable": true
672},
673"prices": {
674"type": "array",
675"items": {
676"$ref": "#/components/schemas/VenuePriceDto"
677}
678},
679"name": {
680"$ref": "#/components/schemas/MultiLangStringDto"
681},
682"description": {
683"type": "object"
684},
685"sku": {
686"type": "string",
687"example": "UK12345",
688"nullable": false
689},
690"status": {
691"type": "string",
692"enum": [
693"ACTIVE",
694"INACTIVE"
695]
696},
697"isMaster": {
698"type": "boolean"
699},
700"size": {
701"examples": [
702"300g",
703300
704],
705"oneOf": [
706{
707"type": "number"
708},
709{
710"type": "string"
711}
712]
713}
714},
715"required": [
716"attributes",
717"availability",
718"hamiltonGrant",
719"howToDisplay",
720"image",
721"pluReportingName",
722"pluPrimaryCategoryID",
723"pluSecondaryCategoryID",
724"starKisProductCategoryID",
725"starKisProductSubCategoryID",
726"posID",
727"prices",
728"name",
729"description",
730"sku",
731"status",
732"isMaster",
733"size"
734]
735},
736"ProductDraftChangesDto": {
737"type": "object",
738"properties": {
739"lastEdit": {
740"type": "string",
741"format": "date-time"
742},
743"taxCategory": {
744"type": "object",
745"nullable": true,
746"properties": {
747"id": {
748"type": "string"
749}
750}
751},
752"variants": {
753"type": "array",
754"items": {
755"$ref": "#/components/schemas/ProductVariantDraftChangesDto"
756}
757}
758},
759"required": [
760"lastEdit",
761"taxCategory",
762"variants"
763]
764},
765"GetProductDto": {
766"type": "object",
767"properties": {
768"product": {
769"$ref": "#/components/schemas/ProductDto"
770},
771"availableHowToDisplayOptions": {
772"type": "array",
773"items": {
774"$ref": "#/components/schemas/EnumOption"
775}
776},
777"taxCategories": {
778"type": "array",
779"items": {
780"$ref": "#/components/schemas/TaxCategoryDto"
781}
782},
783"variantReportingOptions": {
784"deprecated": true,
785"allOf": [
786{
787"$ref": "#/components/schemas/VariantReportingOptionsDto"
788}
789]
790},
791"draftChanges": {
792"$ref": "#/components/schemas/ProductDraftChangesDto"
793}
794},
795"required": [
796"product",
797"availableHowToDisplayOptions",
798"taxCategories",
799"variantReportingOptions",
800"draftChanges"
801]
802},
803"UpdateTaxationDto": {
804"type": "object",
805"properties": {
806"taxCategoryId": {
807"type": "string",
808"example": "uk-vat-20",
809"description": " Tax category ID"
810}
811},
812"required": [
813"taxCategoryId"
814]
815},
816"UpdateProductMarketingDto": {
817"type": "object",
818"properties": {
819"name": {
820"description": "Product group/all variants name",
821"allOf": [
822{
823"$ref": "#/components/schemas/MultiLangStringDto"
824}
825]
826},
827"description": {
828"description": "Product group/all variants description",
829"allOf": [
830{
831"$ref": "#/components/schemas/MultiLangStringDto"
832}
833]
834}
835},
836"required": [
837"name",
838"description"
839]
840},
841"LiveScheduleDto": {
842"type": "object",
843"properties": {
844"on": {
845"type": "object",
846"example": "2021-05-10T00:00:00.000Z"
847},
848"off": {
849"type": "object",
850"example": null
851}
852},
853"required": [
854"on",
855"off"
856]
857},
858"DisplayAsNewDto": {
859"type": "object",
860"properties": {
861"isDisplayed": {
862"type": "boolean"
863},
864"until": {
865"type": "object",
866"example": "2021-05-25T00:00:00.000Z"
867}
868},
869"required": [
870"isDisplayed",
871"until"
872]
873},
874"UpdateVariantMarketing": {
875"type": "object",
876"properties": {
877"name": {
878"$ref": "#/components/schemas/MultiLangStringDto"
879},
880"description": {
881"$ref": "#/components/schemas/MultiLangStringDto"
882},
883"availableForClickAndCollect": {
884"type": "boolean"
885},
886"availableForPretDelivers": {
887"type": "boolean"
888},
889"availableForOutposts": {
890"type": "boolean"
891},
892"isLive": {
893"type": "boolean"
894},
895"visibleOnDeliveryWebsite": {
896"type": "boolean"
897},
898"liveSchedule": {
899"$ref": "#/components/schemas/LiveScheduleDto"
900},
901"isChefsSpecial": {
902"type": "boolean"
903},
904"displayAsNew": {
905"$ref": "#/components/schemas/DisplayAsNewDto"
906},
907"howToDisplay": {
908"type": "string"
909}
910},
911"required": [
912"name",
913"description",
914"availableForClickAndCollect",
915"availableForPretDelivers",
916"availableForOutposts",
917"isLive",
918"visibleOnDeliveryWebsite",
919"liveSchedule",
920"isChefsSpecial",
921"displayAsNew",
922"howToDisplay"
923]
924},
925"UpdateReportingDto": {
926"type": "object",
927"properties": {
928"pluReportingName": {
929"type": "object",
930"nullable": true
931},
932"pluPrimaryCategoryID": {
933"type": "object",
934"nullable": true
935},
936"pluSecondaryCategoryID": {
937"type": "object",
938"nullable": true
939},
940"starKisProductCategoryID": {
941"type": "object",
942"nullable": true
943},
944"starKisProductSubCategoryID": {
945"type": "object",
946"nullable": true
947}
948},
949"required": [
950"pluReportingName",
951"pluPrimaryCategoryID",
952"pluSecondaryCategoryID",
953"starKisProductCategoryID",
954"starKisProductSubCategoryID"
955]
956}
957}
958},
959"paths": {
960"/portal/v1/version": {
961"get": {
962"operationId": "VersionController_get",
963"summary": "Version endpoint",
964"parameters": [],
965"responses": {
966"200": {
967"description": "Success.",
968"content": {
969"application/json": {
970"schema": {
971"$ref": "#/components/schemas/VersionDto"
972}
973}
974}
975}
976}
977}
978},
979"/portal/v1/health": {
980"get": {
981"operationId": "HealthController_check",
982"parameters": [],
983"responses": {
984"200": {
985"description": "The Health Check is successful",
986"content": {
987"application/json": {
988"schema": {
989"type": "object",
990"properties": {
991"status": {
992"type": "string",
993"example": "ok"
994},
995"info": {
996"type": "object",
997"example": {
998"database": {
999"status": "up"
1000}
1001},
1002"additionalProperties": {
1003"type": "object",
1004"properties": {
1005"status": {
1006"type": "string"
1007}
1008},
1009"additionalProperties": {
1010"type": "string"
1011}
1012},
1013"nullable": true
1014},
1015"error": {
1016"type": "object",
1017"example": {},
1018"additionalProperties": {
1019"type": "object",
1020"properties": {
1021"status": {
1022"type": "string"
1023}
1024},
1025"additionalProperties": {
1026"type": "string"
1027}
1028},
1029"nullable": true
1030},
1031"details": {
1032"type": "object",
1033"example": {
1034"database": {
1035"status": "up"
1036}
1037},
1038"additionalProperties": {
1039"type": "object",
1040"properties": {
1041"status": {
1042"type": "string"
1043}
1044},
1045"additionalProperties": {
1046"type": "string"
1047}
1048}
1049}
1050}
1051}
1052}
1053}
1054},
1055"503": {
1056"description": "The Health Check is not successful",
1057"content": {
1058"application/json": {
1059"schema": {
1060"type": "object",
1061"properties": {
1062"status": {
1063"type": "string",
1064"example": "error"
1065},
1066"info": {
1067"type": "object",
1068"example": {
1069"database": {
1070"status": "up"
1071}
1072},
1073"additionalProperties": {
1074"type": "object",
1075"properties": {
1076"status": {
1077"type": "string"
1078}
1079},
1080"additionalProperties": {
1081"type": "string"
1082}
1083},
1084"nullable": true
1085},
1086"error": {
1087"type": "object",
1088"example": {
1089"redis": {
1090"status": "down",
1091"message": "Could not connect"
1092}
1093},
1094"additionalProperties": {
1095"type": "object",
1096"properties": {
1097"status": {
1098"type": "string"
1099}
1100},
1101"additionalProperties": {
1102"type": "string"
1103}
1104},
1105"nullable": true
1106},
1107"details": {
1108"type": "object",
1109"example": {
1110"database": {
1111"status": "up"
1112},
1113"redis": {
1114"status": "down",
1115"message": "Could not connect"
1116}
1117},
1118"additionalProperties": {
1119"type": "object",
1120"properties": {
1121"status": {
1122"type": "string"
1123}
1124},
1125"additionalProperties": {
1126"type": "string"
1127}
1128}
1129}
1130}
1131}
1132}
1133}
1134}
1135}
1136}
1137},
1138"/portal/v3/products/{sku}": {
1139"get": {
1140"operationId": "GetProductController_getBySku",
1141"parameters": [
1142{
1143"name": "sku",
1144"required": true,
1145"in": "path",
1146"description": "SKU for product group, which equals to master SKU",
1147"example": "UK12345",
1148"schema": {
1149"type": "string"
1150}
1151}
1152],
1153"responses": {
1154"200": {
1155"description": "Returns entire product group with its variants",
1156"content": {
1157"application/json": {
1158"schema": {
1159"$ref": "#/components/schemas/GetProductDto"
1160}
1161}
1162}
1163},
1164"404": {
1165"description": "No product found"
1166}
1167},
1168"security": [
1169{
1170"bearer": []
1171}
1172],
1173"tags": [
1174"Product Group"
1175]
1176}
1177},
1178"/portal/v3/products/{masterSku}/taxation": {
1179"put": {
1180"operationId": "UpdateProductTaxationController_updateTaxation",
1181"parameters": [
1182{
1183"name": "masterSku",
1184"required": true,
1185"in": "path",
1186"schema": {
1187"type": "string"
1188}
1189}
1190],
1191"requestBody": {
1192"required": true,
1193"content": {
1194"application/json": {
1195"schema": {
1196"$ref": "#/components/schemas/UpdateTaxationDto"
1197}
1198}
1199}
1200},
1201"responses": {
1202"204": {
1203"description": ""
1204}
1205},
1206"security": [
1207{
1208"bearer": []
1209}
1210],
1211"tags": [
1212"Product Group"
1213]
1214}
1215},
1216"/portal/v3/products/{masterSku}/marketing": {
1217"put": {
1218"operationId": "UpdateProductMarketingController_updateMarketing",
1219"parameters": [
1220{
1221"name": "masterSku",
1222"required": true,
1223"in": "path",
1224"schema": {
1225"type": "string"
1226}
1227}
1228],
1229"requestBody": {
1230"required": true,
1231"content": {
1232"application/json": {
1233"schema": {
1234"$ref": "#/components/schemas/UpdateProductMarketingDto"
1235}
1236}
1237}
1238},
1239"responses": {
1240"204": {
1241"description": ""
1242}
1243},
1244"security": [
1245{
1246"bearer": []
1247}
1248],
1249"tags": [
1250"Product Group"
1251]
1252}
1253},
1254"/portal/v3/products": {
1255"get": {
1256"operationId": "SearchProductsController_search",
1257"parameters": [
1258{
1259"name": "query",
1260"required": true,
1261"in": "query",
1262"description": "Search product name, Product SKU or Hamilton Grant ID",
1263"example": "UK000001",
1264"schema": {
1265"type": "string"
1266}
1267}
1268],
1269"responses": {
1270"200": {
1271"description": ""
1272}
1273},
1274"security": [
1275{
1276"bearer": []
1277}
1278],
1279"tags": [
1280"Product Group"
1281]
1282}
1283},
1284"/portal/v3/products/{masterSku}/variants/{variantSku}/marketing": {
1285"put": {
1286"operationId": "UpdateVariantMarketingController_updateVariantMarketing",
1287"parameters": [
1288{
1289"name": "masterSku",
1290"required": true,
1291"in": "path",
1292"schema": {
1293"type": "string"
1294}
1295},
1296{
1297"name": "variantSku",
1298"required": true,
1299"in": "path",
1300"schema": {
1301"type": "string"
1302}
1303}
1304],
1305"requestBody": {
1306"required": true,
1307"content": {
1308"application/json": {
1309"schema": {
1310"$ref": "#/components/schemas/UpdateVariantMarketing"
1311}
1312}
1313}
1314},
1315"responses": {
1316"204": {
1317"description": ""
1318}
1319},
1320"security": [
1321{
1322"bearer": []
1323}
1324],
1325"tags": [
1326"Product Variant"
1327]
1328}
1329},
1330"/portal/v3/products/{masterSku}/variants/{variantSku}/reporting": {
1331"put": {
1332"operationId": "UpdateVariantReportingController_updateVariantReporting",
1333"parameters": [
1334{
1335"name": "masterSku",
1336"required": true,
1337"in": "path",
1338"schema": {
1339"type": "string"
1340}
1341},
1342{
1343"name": "variantSku",
1344"required": true,
1345"in": "path",
1346"schema": {
1347"type": "string"
1348}
1349}
1350],
1351"requestBody": {
1352"required": true,
1353"content": {
1354"application/json": {
1355"schema": {
1356"$ref": "#/components/schemas/UpdateReportingDto"
1357}
1358}
1359}
1360},
1361"responses": {
1362"204": {
1363"description": ""
1364}
1365},
1366"security": [
1367{
1368"bearer": []
1369}
1370],
1371"tags": [
1372"Product Variant"
1373]
1374}
1375},
1376"/portal/v3/product-types/{type}/reporting": {
1377"get": {
1378"operationId": "GetAvailableReportingOptionsController_getAvailableReportingOptions",
1379"parameters": [
1380{
1381"name": "type",
1382"required": true,
1383"in": "path",
1384"schema": {
1385"type": "string",
1386"enum": [
1387"food",
1388"barista_beverage"
1389]
1390}
1391}
1392],
1393"requestBody": {
1394"required": true,
1395"content": {
1396"application/json": {
1397"schema": {
1398"$ref": "#/components/schemas/VariantReportingOptionsDto"
1399}
1400}
1401}
1402},
1403"responses": {
1404"200": {
1405"description": ""
1406}
1407},
1408"security": [
1409{
1410"bearer": []
1411}
1412],
1413"tags": [
1414"Product Type"
1415]
1416}
1417}
1418}
1419}