diff --git a/SwagGuidedShopping-storeapi.json b/SwagGuidedShopping-storeapi.json index 24f6fb1..c46d84e 100644 --- a/SwagGuidedShopping-storeapi.json +++ b/SwagGuidedShopping-storeapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.6.1" + "version": "6.6.7.0" }, "servers": [ { @@ -368,9 +368,6 @@ }, "AclRole": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -392,7 +389,6 @@ "App": { "description": "Added since version: 6.3.1.0", "required": [ - "createdAt", "label" ], "properties": { @@ -419,7 +415,6 @@ "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": [ - "createdAt", "label" ], "properties": { @@ -448,8 +443,7 @@ "required": [ "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -483,7 +477,6 @@ "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": [ - "createdAt", "label" ], "properties": { @@ -510,7 +503,6 @@ "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": [ - "createdAt", "label" ], "properties": { @@ -536,9 +528,6 @@ }, "AppFlowEvent": { "description": "Added since version: 6.5.2.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -559,9 +548,6 @@ }, "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -583,7 +569,6 @@ "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": [ - "createdAt", "name" ], "properties": { @@ -609,9 +594,6 @@ }, "AppShippingMethod": { "description": "Added since version: 6.5.7.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -632,9 +614,6 @@ }, "AppTemplate": { "description": "Added since version: 6.3.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -662,10 +641,6 @@ { "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -998,10 +973,6 @@ "childCount", "translated", "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -1190,8 +1161,7 @@ "slots", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -1299,8 +1269,7 @@ "apiAlias", "sections", "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -1382,8 +1351,7 @@ "blocks", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -1481,8 +1449,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -1551,8 +1518,6 @@ { "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -1717,8 +1682,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -1858,7 +1821,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -1910,7 +1872,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -1968,7 +1929,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -2077,7 +2037,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -2177,9 +2136,6 @@ }, "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -2200,9 +2156,6 @@ }, "CustomEntity": { "description": "Added since version: 6.4.9.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -2223,9 +2176,6 @@ }, "CustomField": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -2246,9 +2196,6 @@ }, "CustomFieldSet": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -2269,9 +2216,6 @@ }, "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -2306,9 +2250,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -2517,8 +2459,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -2604,7 +2545,6 @@ "required": [ "translated", "id", - "createdAt", "name" ], "properties": { @@ -2668,9 +2608,6 @@ }, "CustomerRecovery": { "description": "Added since version: 6.1.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -2718,8 +2655,7 @@ "description": "Added since version: 6.3.4.0", "required": [ "id", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -2750,8 +2686,7 @@ "description": "Added since version: 6.3.4.0", "required": [ "id", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -2786,8 +2721,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -2835,8 +2769,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -2932,9 +2865,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -2990,8 +2921,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -3028,7 +2958,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -3063,9 +2992,6 @@ }, "Flow": { "description": "Added since version: 6.4.6.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3086,9 +3012,6 @@ }, "FlowSequence": { "description": "Added since version: 6.4.6.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3109,9 +3032,6 @@ }, "FlowTemplate": { "description": "Added since version: 6.4.18.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3132,9 +3052,6 @@ }, "ImportExportFile": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3155,9 +3072,6 @@ }, "ImportExportLog": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3178,9 +3092,6 @@ }, "ImportExportProfile": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3204,9 +3115,6 @@ }, "Integration": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3234,7 +3142,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -3367,7 +3274,6 @@ "required": [ "apiAlias", "id", - "createdAt", "name", "url" ], @@ -3453,8 +3359,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -3622,8 +3527,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -3681,7 +3585,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -3720,9 +3623,6 @@ }, "LogEntry": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3744,7 +3644,6 @@ "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -3792,7 +3691,6 @@ "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "subject", "contentHtml", "contentPlain" @@ -3882,7 +3780,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -3926,8 +3823,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -3975,8 +3871,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -4026,8 +3921,7 @@ "path", "private", "url", - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -4116,9 +4010,6 @@ }, "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4139,9 +4030,6 @@ }, "MediaFolder": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4162,9 +4050,6 @@ }, "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4218,8 +4103,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -4268,8 +4152,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -4307,9 +4190,6 @@ "$ref": "#/components/schemas/resource" }, { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4332,9 +4212,6 @@ }, "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4355,9 +4232,6 @@ }, "Notification": { "description": "Added since version: 6.4.7.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4379,7 +4253,6 @@ "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -4405,9 +4278,6 @@ }, "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4428,9 +4298,6 @@ }, "NumberRangeState": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4452,7 +4319,6 @@ "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "typeName" ], "properties": { @@ -4488,8 +4354,7 @@ "languageId", "salesChannelId", "orderDateTime", - "currencyFactor", - "createdAt" + "currencyFactor" ], "properties": { "id": { @@ -4751,8 +4616,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -4838,8 +4702,7 @@ "id", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -4905,10 +4768,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -5050,8 +4911,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -5172,10 +5032,8 @@ "identifier", "quantity", "label", - "position", "states", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -5425,8 +5283,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -5517,8 +5374,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -5639,8 +5495,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -5757,8 +5612,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -5878,8 +5732,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -6004,7 +5857,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -6127,7 +5979,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -6216,7 +6067,6 @@ "Plugin": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "label" ], "properties": { @@ -6252,7 +6102,6 @@ "taxId", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -7246,7 +7095,6 @@ "taxId", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -7729,8 +7577,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -7787,10 +7634,7 @@ "description": "Added since version: 6.1.0.0", "required": [ "id", - "name", - "position", - "type", - "createdAt" + "name" ], "properties": { "id": { @@ -7838,9 +7682,6 @@ }, "ProductCrossSellingAssignedProducts": { "description": "Added since version: 6.2.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -7864,8 +7705,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -7916,9 +7756,6 @@ }, "ProductExport": { "description": "Added since version: 6.1.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -7940,7 +7777,6 @@ "ProductFeatureSet": { "description": "Added since version: 6.3.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -7989,7 +7825,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -8041,8 +7876,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -8093,9 +7927,6 @@ }, "ProductPrice": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8123,8 +7954,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -8181,9 +8011,6 @@ }, "ProductSearchConfig": { "description": "Added since version: 6.3.5.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8204,9 +8031,6 @@ }, "ProductSearchConfigField": { "description": "Added since version: 6.3.5.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8227,9 +8051,6 @@ }, "ProductSearchKeyword": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8253,7 +8074,6 @@ "required": [ "key", "priority", - "createdAt", "label" ], "properties": { @@ -8291,7 +8111,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -8326,9 +8145,6 @@ }, "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8349,9 +8165,6 @@ }, "ProductVisibility": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8373,7 +8186,6 @@ "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -8402,9 +8214,6 @@ }, "PromotionDiscount": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8425,9 +8234,6 @@ }, "PromotionDiscountPrices": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8448,9 +8254,6 @@ }, "PromotionIndividualCode": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8471,9 +8274,6 @@ }, "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8494,9 +8294,6 @@ }, "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8519,9 +8316,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -8583,7 +8377,6 @@ "option", "id", "groupId", - "createdAt", "name" ], "properties": { @@ -8640,8 +8433,7 @@ "Rule": { "description": "Added since version: 6.0.0.0", "required": [ - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -8672,9 +8464,6 @@ }, "RuleCondition": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8704,7 +8493,6 @@ "shippingMethodId", "countryId", "navigationCategoryId", - "createdAt", "name", "homeEnabled" ], @@ -8848,9 +8636,6 @@ }, "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -8877,8 +8662,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -8935,7 +8719,6 @@ "SalesChannelType": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -8969,7 +8752,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -9013,7 +8795,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -9052,9 +8833,6 @@ }, "ScheduledTask": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9075,9 +8853,6 @@ }, "Script": { "description": "Added since version: 6.4.7.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9109,8 +8884,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -9181,8 +8955,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -9246,13 +9019,11 @@ "readOnly": true } }, - "type": "object" + "type": "object", + "title": "SeoUrlEntity" }, "SeoUrlTemplate": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9291,8 +9062,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -9539,8 +9308,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -9625,8 +9392,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -9658,7 +9424,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -9681,8 +9450,7 @@ "required": [ "setId", "translationKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -9719,8 +9487,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "name", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -9758,7 +9525,6 @@ "StateMachine": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -9796,9 +9562,6 @@ }, "StateMachineHistory": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9827,7 +9590,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "technicalName", - "createdAt", "name" ], "properties": { @@ -9862,9 +9624,6 @@ }, "StateMachineTransition": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9888,8 +9647,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -9931,8 +9689,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -9960,9 +9717,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -10002,7 +9757,6 @@ "required": [ "id", "priority", - "createdAt", "name" ], "properties": { @@ -10048,9 +9802,6 @@ }, "TaxRule": { "description": "Added since version: 6.1.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10072,7 +9823,6 @@ "TaxRuleType": { "description": "Added since version: 6.1.0.0", "required": [ - "createdAt", "typeName" ], "properties": { @@ -10102,8 +9852,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -10174,7 +9923,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -10210,9 +9958,6 @@ }, "User": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10233,9 +9978,6 @@ }, "UserAccessKey": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10256,9 +9998,6 @@ }, "UserConfig": { "description": "Added since version: 6.3.5.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10279,9 +10018,6 @@ }, "UserRecovery": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10302,9 +10038,6 @@ }, "Webhook": { "description": "Added since version: 6.3.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10325,9 +10058,6 @@ }, "WebhookEventLog": { "description": "Added since version: 6.4.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10561,33 +10291,219 @@ "ranges" ] }, - "WishlistLoadRouteResponse": { + "AccountNewsletterRecipient": { "type": "object", "properties": { - "wishlist": { - "type": "object", - "properties": { - "customerId": { - "type": "string" - }, - "salesChannelId": { - "type": "string" - } - } + "status": { + "type": "string", + "enum": [ + "undefined", + "notSet", + "direct", + "optIn", + "optOut" + ] }, - "products": { - "$ref": "#/components/schemas/ProductListingResult" + "apiAlias": { + "type": "string", + "enum": [ + "account_newsletter_recipient" + ] } - } + }, + "required": [ + "status", + "apiAlias" + ] }, - "SalesChannelContext": { - "type": "object", + "CustomerAddressBody": { + "description": "Added since version: 6.0.0.0", + "required": [ + "countryId", + "firstName", + "lastName", + "city", + "street" + ], "properties": { - "token": { - "description": "Context the user session", + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "currentCustomerGroup": { + "lastName": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "street": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "EntitySearchResult": { + "type": "object", + "properties": { + "entity": { + "type": "string" + }, + "total": { + "type": "integer", + "description": "The total number of found entities" + }, + "aggregations": { + "type": "array", + "description": "Contains aggregated data. A simple example is the determination of the average price from a product search query.", + "items": { + "type": "object" + } + }, + "page": { + "type": "integer", + "description": "The actual page. This can be used for pagination." + }, + "limit": { + "type": "integer", + "description": "The actual limit. This is used for pagination and goes together with the page." + } + } + }, + "Sitemap": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "filename", + "created" + ] + }, + "ProductListingFlags": { + "type": "object", + "description": "Additional flags for product listings", + "properties": { + "no-aggregations": { + "description": "Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.", + "type": "string", + "nullable": true + }, + "only-aggregations": { + "description": "If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.", + "type": "string", + "nullable": true + } + } + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "SalesChannelContext": { + "type": "object", + "properties": { + "token": { + "description": "Context the user session", + "type": "string" + }, + "currentCustomerGroup": { "type": "object", "description": "Customer group of the current user", "properties": { @@ -10765,497 +10681,387 @@ } } }, - "Sitemap": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "created": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "filename", - "created" + "NavigationRouteResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity" ] }, - "CartDeliveryPosition": { + "LineItem": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" } }, - "identifier": { + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "dataContextHash": { "type": "string" }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "dataTimestamp": { + "type": "string" }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - } - } - }, - "Criteria": { - "type": "object", - "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", - "properties": { - "page": { - "description": "Search result page", - "type": "integer" + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" }, - "term": { - "description": "Search term", + "description": { "type": "string" }, - "limit": { - "description": "Number of items per result page", - "type": "integer" + "good": { + "type": "boolean" }, - "filter": { - "type": "array", - "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "id": { + "type": "string" }, - "ids": { - "type": "array", - "description": "List of ids to search for", - "items": { - "type": "string" - } + "label": { + "type": "string" }, - "query": { - "type": "array", - "description": "List of queries to restrict the search result. For more information, see [Search Queries > Query](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#query)", - "items": { - "$ref": "#/components/schemas/Query" - } + "modified": { + "type": "boolean" }, - "associations": { - "type": "array", - "description": "Associations to include. For more information, see [Search Queries > Associations](https://shopware.stoplight.io/docs/store-api/cf710bf73d0cd-search-queries#associations)", - "items": { - "$ref": "#/components/schemas/Association" - } + "modifiedByApp": { + "type": "boolean" }, - "post-filter": { - "type": "array", - "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "payload": { + "$ref": "#/components/schemas/ProductJsonApi" + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } }, - { - "$ref": "#/components/schemas/RangeFilter" + "nullable": true + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } } - ] - } + } + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" - } + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" }, - "aggregations": { - "$ref": "#/components/schemas/Aggregations" + "quantity": { + "type": "number" }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" + } } }, - "grouping": { + "referencedId": { + "type": "string" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "states": { "type": "array", - "description": "Perform groupings over certain fields", "items": { "type": "string", - "description": "Name of a field" + "enum": [ + "is-physical", + "is-download" + ] } }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" + "type": { + "$ref": "#/components/schemas/LineItemType" }, - "includes": { - "$ref": "#/components/schemas/Include" - } - } - }, - "Association": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Criteria" - } - }, - "Include": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { + "uniqueIdentifier": { "type": "string" } - } + }, + "required": [ + "id", + "type" + ] }, - "Aggregations": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "title": "AggregationEntity", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationFilter", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationTerms", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationHistogram", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationHistogram" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationRange", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationRange" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - } - ] - } - }, - "SubAggregations": { + "CartDeliveryInformation": { "type": "object", "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/AggregationHistogram" - }, - { - "$ref": "#/components/schemas/AggregationRange" - } + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" ] - } - } - }, - "TotalCountMode": { - "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", - "type": "string", - "default": "none", - "enum": [ - "none", - "exact", - "next-pages" - ] - }, - "Query": { - "type": "object", - "properties": { - "score": { - "type": "number" }, - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - { - "$ref": "#/components/schemas/EqualsFilter" + "min": { + "type": "integer" }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "max": { + "type": "integer" }, - { - "$ref": "#/components/schemas/RangeFilter" + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" + ] } - ] - } - }, - "additionalProperties": true - }, - "Sort": { - "type": "object", - "properties": { - "field": { - "type": "string" + } }, - "order": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] + "height": { + "type": "integer" }, - "naturalSorting": { - "type": "boolean" + "length": { + "type": "integer" }, - "type": { - "type": "string" + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" } }, "required": [ - "field", - "order" + "apiAlias" ] }, - "Filters": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - }, - "SimpleFilter": { + "AggregationMetrics": { "type": "object", "properties": { + "name": { + "type": "string" + }, "type": { "type": "string", "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" + "avg", + "count", + "max", + "min", + "stats", + "sum" ] }, "field": { "type": "string" - }, - "value": { - "type": "string" } }, "required": [ + "name", "type", - "field", - "value" + "field" ] }, - "EqualsFilter": { + "Price": { "type": "object", + "description": "Price object", "properties": { - "type": { + "currencyId": { "type": "string", - "enum": [ - "equals" - ] + "pattern": "^[0-9a-f]{32}$" }, - "field": { - "type": "string" + "gross": { + "description": "", + "type": "number" }, - "value": { - "oneOf": [ - { - "type": "string" + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { + "gross": { + "description": "", "type": "number" }, - { + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } + }, + "required": [ + "gross", + "net" ] } }, "required": [ - "type", - "field", - "value" + "currencyId", + "gross", + "net" ] }, - "MultiNotFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "multi", - "not" - ] - }, - "operator": { - "type": "string", - "enum": [ - "AND", - "and", - "OR", - "or" - ] - }, - "queries": { - "$ref": "#/components/schemas/Filters" - } - }, - "required": [ - "type", - "operator", - "queries" - ] - }, - "RangeFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "range" - ] - }, - "field": { - "type": "string" - }, - "parameters": { - "type": "object", - "properties": { - "gte": { - "type": "number" - }, - "gt": { - "type": "number" - }, - "lte": { - "type": "number" - }, - "lt": { - "type": "number" - } - } - } - }, - "required": [ - "type", - "field", - "parameters" - ] - }, - "NavigationRouteResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "SuccessResponse": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - } - } - }, "ProductListingCriteria": { "allOf": [ { @@ -11346,259 +11152,652 @@ } ] }, - "ProductDetailResponse": { + "Cart": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "product": { - "$ref": "#/components/schemas/Product" + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" }, - "configurator": { + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "lineItems": { + "description": "All items within the cart", "type": "array", - "description": "List of property groups with their corresponding options and information on how to display them.", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/LineItem" } - } - }, - "required": [ - "product" - ] - }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" }, - "rawTotal": { - "type": "number" + "errors": { + "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "items": { + "$ref": "#/components/schemas/CartError" + } }, - "totalPrice": { - "type": "number" + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } }, - "calculatedTaxes": { + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", "type": "array", "items": { "type": "object", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" + "paymentMethodId": { + "type": "string" }, - "price": { - "type": "number" + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] + } } }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + "modified": { + "type": "boolean" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true }, - "positionPrice": { + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true + } + } + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { "type": "number" }, - "netPrice": { + "percentage": { "type": "number" }, - "regulationPrice": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "FindProductVariantRouteResponse": { + "type": "object", + "properties": { + "foundCombination": { "type": "object", "properties": { - "price": { - "type": "number" - }, - "apiAlias": { + "variantId": { "type": "string", - "enum": [ - "cart_regulation_price" - ] + "pattern": "^[0-9a-f]{32}$" + }, + "options": { + "type": "array", + "items": { + "type": "string" + } } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" + } + } + } + }, + "Breadcrumb": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "variantId": { + "categoryId": { "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "pattern": "^[0-9a-f]{32}$" }, - "apiAlias": { + "type": { "type": "string", "enum": [ - "calculated_price" + "page", + "link", + "folder" ] }, - "taxRules": { + "translated": { + "type": "object", + "additionalProperties": true, + "properties": { + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string", + "enum": [ + "external", + "category", + "product", + "landing_page" + ] + }, + "internalLink": { + "type": "string" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + } + } + }, + "path": { + "type": "string" + }, + "seoUrls": { "type": "array", - "description": "Currently active tax rules and/or rates", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "$ref": "#/components/schemas/SeoUrl" } + }, + "apiAlias": { + "type": "string", + "enum": [ + "breadcrumb" + ] } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] - }, - "NavigationType": { - "type": "string", - "enum": [ - "main-navigation", - "footer-navigation", - "service-navigation" + "name", + "categoryId", + "type", + "translated", + "path", + "apiAlias" ] }, - "ShippingMethodPageRouteResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "deliveryTimeId": { - "type": "string" - }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer", - "format": "int32" - }, - "max": { - "type": "integer", - "format": "int32" - }, - "unit": { - "type": "string" - } - } - }, - "translations": { - "type": "array", - "items": { + "ProductListingResult": { + "allOf": [ + { + "$ref": "#/components/schemas/EntitySearchResult" + }, + { + "type": "object", + "properties": { + "currentFilters": { "type": "object", + "description": "Contains the state of the filters. These can be used to create listing filters.", "properties": { - "shippingMethodId": { - "type": "string" - }, - "name": { + "navigationId": { "type": "string" }, - "description": { - "type": "string" - } - } - } - }, - "orderDeliveries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "orderId": { - "type": "string" + "manufacturer": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "shippingOrderAddressId": { - "type": "string" + "price": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "default": 0 + }, + "max": { + "type": "integer", + "default": 0 + } + }, + "required": [ + "min", + "max" + ] }, - "shippingMethodId": { - "type": "string" + "rating": { + "type": "integer", + "nullable": true }, - "shippingDateEarliest": { - "type": "string", - "format": "date-time" + "shipping-free": { + "type": "boolean", + "default": false }, - "shippingDateLatest": { - "type": "string", - "format": "date-time" + "properties": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "stateId": { + "search": { "type": "string" } - } - } - }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "typeId": { - "type": "string" - }, - "languageId": { - "type": "string" + }, + "required": [ + "manufacturer", + "navigationId", + "price", + "properties", + "rating", + "shipping-free" + ] + }, + "availableSortings": { + "type": "array", + "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "translated": { + "type": "object", + "properties": { + "label": { + "type": "string" + } + }, + "required": [ + "label" + ] + }, + "key": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "product_sorting" + ] + } }, - "currencyId": { - "type": "string" + "required": [ + "label", + "translated", + "key", + "priority", + "apiAlias" + ] + } + }, + "sorting": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "entity": { + "type": "string", + "enum": [ + "product" + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "product_listing" + ] + } + }, + "required": [ + "elements", + "availableSortings", + "currentFilters", + "apiAlias" + ] + } + ] + }, + "CustomerAddressRead": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState", + "nullable": true + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "required": [ + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" + ] + }, + "SuccessResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + }, + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" + ] + }, + "CartError": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + } + } + } + }, + "CrossSellingElementCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CrossSellingElement" + } + }, + "OrderRouteResponse": { + "type": "object", + "properties": { + "orders": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + }, + "paymentChangeable": { + "type": "object", + "description": "The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.", + "additionalProperties": { + "type": "boolean" + } + } + }, + "required": [ + "orders" + ] + }, + "ShippingMethodPageRouteResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "deliveryTimeId": { + "type": "string" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int32" + }, + "max": { + "type": "integer", + "format": "int32" + }, + "unit": { + "type": "string" + } + } + }, + "translations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "shippingMethodId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + }, + "orderDeliveries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "orderId": { + "type": "string" + }, + "shippingOrderAddressId": { + "type": "string" + }, + "shippingMethodId": { + "type": "string" + }, + "shippingDateEarliest": { + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "stateId": { + "type": "string" + } + } + } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "typeId": { + "type": "string" + }, + "languageId": { + "type": "string" + }, + "currencyId": { + "type": "string" }, "paymentMethodId": { "type": "string" @@ -11775,1070 +11974,765 @@ "type": "number", "format": "float" }, - "calculationRuleId": { - "type": "string" - } - } - } - }, - "mediaId": { - "type": "string" - }, - "media": { - "type": "object", - "properties": { - "userId": { - "type": "string" - }, - "mimeType": { - "type": "string" - }, - "fileExtension": { - "type": "string" - }, - "fileSize": { - "type": "integer", - "format": "int32" - }, - "title": { - "type": "string" - }, - "metaDataRaw": { - "type": "string" - }, - "mediaTypeRaw": { - "type": "string" - }, - "uploadedAt": { - "type": "string", - "format": "date-time" - }, - "alt": { - "type": "string" - }, - "url": { - "type": "string" - }, - "fileName": { - "type": "string" - }, - "mediaFolderId": { - "type": "string" - }, - "private": { - "type": "boolean" - }, - "thumbnailsRo": { - "type": "string" - } - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - } - } - } - } - }, - "FindProductVariantRouteResponse": { - "type": "object", - "properties": { - "foundCombination": { - "type": "object", - "properties": { - "variantId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "options": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "ProductListingFlags": { - "type": "object", - "description": "Additional flags for product listings", - "properties": { - "no-aggregations": { - "description": "Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.", - "type": "string", - "nullable": true - }, - "only-aggregations": { - "description": "If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.", - "type": "string", - "nullable": true - } - } - }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" - ] - }, - "LineItem": { - "type": "object", - "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" - }, - "good": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { - "type": "boolean" - }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" - }, - "price": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] + "calculationRuleId": { + "type": "string" } + } + } + }, + "mediaId": { + "type": "string" + }, + "media": { + "type": "object", + "properties": { + "userId": { + "type": "string" }, - "nullable": true - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "mimeType": { + "type": "string" + }, + "fileExtension": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string" + }, + "metaDataRaw": { + "type": "string" + }, + "mediaTypeRaw": { + "type": "string" + }, + "uploadedAt": { + "type": "string", + "format": "date-time" + }, + "alt": { + "type": "string" + }, + "url": { + "type": "string" + }, + "fileName": { + "type": "string" + }, + "mediaFolderId": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "thumbnailsRo": { + "type": "string" } } }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" - }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } } } - }, - "referencedId": { - "type": "string" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } - }, - "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { - "type": "string" } - }, - "required": [ - "id", - "type" - ] + } }, - "CartDelivery": { + "CalculatedPrice": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } + "unitPrice": { + "type": "number" }, - "location": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "state": { - "$ref": "#/components/schemas/CountryState" - } - } + "quantity": { + "type": "number" }, - "positions": { + "rawTotal": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "calculatedTaxes": { "type": "array", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] } }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - }, - "AggregationMetrics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" - ] - }, - "field": { - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "OrderRouteResponse": { - "type": "object", - "properties": { - "orders": { - "allOf": [ + "referencePrice": { + "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } + "$ref": "#/components/schemas/CartPriceReference" }, { - "$ref": "#/components/schemas/EntitySearchResult" + "type": "null" } ] }, - "paymentChangeable": { - "type": "object", - "description": "The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.", - "additionalProperties": { - "type": "boolean" - } - } - }, - "required": [ - "orders" - ] - }, - "ProductListingResult": { - "allOf": [ - { - "$ref": "#/components/schemas/EntitySearchResult" + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - { + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { "type": "object", "properties": { - "currentFilters": { - "type": "object", - "description": "Contains the state of the filters. These can be used to create listing filters.", - "properties": { - "navigationId": { - "type": "string" - }, - "manufacturer": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "price": { - "type": "object", - "properties": { - "min": { - "type": "integer", - "default": 0 - }, - "max": { - "type": "integer", - "default": 0 - } - }, - "required": [ - "min", - "max" - ] - }, - "rating": { - "type": "integer", - "nullable": true - }, - "shipping-free": { - "type": "boolean", - "default": false - }, - "properties": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "search": { - "type": "string" - } - }, - "required": [ - "manufacturer", - "navigationId", - "price", - "properties", - "rating", - "shipping-free" - ] - }, - "availableSortings": { - "type": "array", - "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", - "items": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "translated": { - "type": "object", - "properties": { - "label": { - "type": "string" - } - }, - "required": [ - "label" - ] - }, - "key": { - "type": "string" - }, - "priority": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "product_sorting" - ] - } - }, - "required": [ - "label", - "translated", - "key", - "priority", - "apiAlias" - ] - } - }, - "sorting": { - "type": "string" - }, - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "entity": { - "type": "string", - "enum": [ - "product" - ] + "price": { + "type": "number" }, "apiAlias": { "type": "string", "enum": [ - "product_listing" + "cart_regulation_price" ] } }, - "required": [ - "elements", - "availableSortings", - "currentFilters", - "apiAlias" + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" ] }, - "CustomerAddressBody": { - "description": "Added since version: 6.0.0.0", - "required": [ - "countryId", - "firstName", - "lastName", - "city", - "street" - ], + "Criteria": { + "type": "object", + "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", "properties": { - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "page": { + "description": "Search result page", + "type": "integer" }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "term": { + "description": "Search term", + "type": "string" }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "firstName": { - "type": "string" + "filter": { + "type": "array", + "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, - "lastName": { - "type": "string" + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } }, - "zipcode": { - "type": "string" + "query": { + "type": "array", + "description": "List of queries to restrict the search result. For more information, see [Search Queries > Query](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#query)", + "items": { + "$ref": "#/components/schemas/Query" + } }, - "city": { - "type": "string" + "associations": { + "type": "array", + "description": "Associations to include. For more information, see [Search Queries > Associations](https://shopware.stoplight.io/docs/store-api/cf710bf73d0cd-search-queries#associations)", + "items": { + "$ref": "#/components/schemas/Association" + } }, - "company": { - "type": "string" + "post-filter": { + "type": "array", + "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, - "street": { - "type": "string" + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "$ref": "#/components/schemas/Sort" + } }, - "department": { - "type": "string" + "aggregations": { + "$ref": "#/components/schemas/Aggregations" }, - "title": { - "type": "string" + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "phoneNumber": { - "type": "string" + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "additionalAddressLine1": { - "type": "string" + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" }, - "additionalAddressLine2": { + "includes": { + "$ref": "#/components/schemas/Include" + } + } + }, + "Association": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Include": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string" - }, - "customFields": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" } - }, - "type": "object" + } }, - "AccountNewsletterRecipient": { + "Aggregations": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + } + }, + "SubAggregations": { "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "undefined", - "notSet", - "direct", - "optIn", - "optOut" - ] - }, - "apiAlias": { - "type": "string", - "enum": [ - "account_newsletter_recipient" + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" + } ] } - }, - "required": [ - "status", - "apiAlias" + } + }, + "TotalCountMode": { + "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", + "type": "string", + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" ] }, - "CrossSellingElement": { + "Query": { "type": "object", "properties": { - "crossSelling": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "total": { - "type": "integer", - "format": "int32" - }, - "streamId": { - "type": "string", - "format": "uuid" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cross_selling_element" + "score": { + "type": "number" + }, + "query": { + "oneOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } ] } }, - "required": [ - "crossSelling", - "products", - "total", - "apiAlias" - ] + "additionalProperties": true }, - "CustomerAddressRead": { + "Sort": { "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "createdAt": { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - "updatedAt": { + "order": { "type": "string", - "format": "date-time", - "nullable": true - }, - "country": { - "$ref": "#/components/schemas/Country" + "enum": [ + "ASC", + "DESC" + ] }, - "countryState": { - "$ref": "#/components/schemas/CountryState", - "nullable": true + "naturalSorting": { + "type": "boolean" }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "type": { + "type": "string" } }, "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" + "field", + "order" ] }, - "CartPriceQuantity": { + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { "type": "object", "properties": { - "apiAlias": { + "type": { "type": "string", "enum": [ - "cart_price_quantity" + "contains", + "equalsAny", + "prefix", + "suffix" ] }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "field": { + "type": "string" }, - "type": { + "value": { "type": "string" } }, "required": [ - "apiAlias" + "type", + "field", + "value" ] }, - "EntitySearchResult": { + "EqualsFilter": { "type": "object", "properties": { - "entity": { - "type": "string" - }, - "total": { - "type": "integer", - "description": "The total number of found entities" - }, - "aggregations": { - "type": "array", - "description": "Contains aggregated data. A simple example is the determination of the average price from a product search query.", - "items": { - "type": "object" - } + "type": { + "type": "string", + "enum": [ + "equals" + ] }, - "page": { - "type": "integer", - "description": "The actual page. This can be used for pagination." + "field": { + "type": "string" }, - "limit": { - "type": "integer", - "description": "The actual limit. This is used for pagination and goes together with the page." - } - } - }, - "CartError": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "items": { - "type": "object", - "properties": { - "key": { + "value": { + "oneOf": [ + { "type": "string" }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + { + "type": "number" }, - "message": { - "type": "string" + { + "type": "boolean" }, - "messageKey": { - "type": "string" + { + "type": "null" } - } + ] } - } - }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" - }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } - }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", - "type": "array", - "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - } - }, - "modified": { - "type": "boolean" - }, - "customerComment": { + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true + "enum": [ + "multi", + "not" + ] }, - "affiliateCode": { + "operator": { "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "enum": [ + "AND", + "and", + "OR", + "or" + ] }, - "campaignCode": { - "type": "string", - "description": "A campaign tracking code", - "nullable": true + "queries": { + "$ref": "#/components/schemas/Filters" } - } + }, + "required": [ + "type", + "operator", + "queries" + ] }, - "CartPriceReference": { + "RangeFilter": { "type": "object", "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" + "type": { + "type": "string", + "enum": [ + "range" + ] }, - "unitName": { + "field": { "type": "string" }, - "price": { - "type": "number" - }, + "parameters": { + "type": "object", + "properties": { + "gte": { + "type": "number" + }, + "gt": { + "type": "number" + }, + "lte": { + "type": "number" + }, + "lt": { + "type": "number" + } + } + } + }, + "required": [ + "type", + "field", + "parameters" + ] + }, + "CartPriceQuantity": { + "type": "object", + "properties": { "apiAlias": { "type": "string", "enum": [ - "cart_price_reference" + "cart_price_quantity" ] }, + "isCalculated": { + "type": "boolean" + }, "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" + }, + "quantity": { + "type": "number" }, "regulationPrice": { - "type": "object", "properties": { "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] + "type": "number", + "format": "float" } }, - "nullable": true + "type": "object" }, - "hasRange": { - "type": "boolean" + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "type": { + "type": "string" } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" + "apiAlias" ] }, - "CartListPrice": { + "ProductDetailResponse": { "type": "object", - "description": "", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" + "product": { + "$ref": "#/components/schemas/Product" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] + "configurator": { + "type": "array", + "description": "List of property groups with their corresponding options and information on how to display them.", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } } }, "required": [ - "apiAlias" + "product" ] }, - "CrossSellingElementCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CrossSellingElement" + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } } }, - "CartDeliveryInformation": { + "WishlistLoadRouteResponse": { "type": "object", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_information" - ] - }, - "freeDelivery": { - "type": "boolean" - }, - "deliveryTime": { + "wishlist": { "type": "object", "properties": { - "name": { + "customerId": { "type": "string" }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { + "salesChannelId": { "type": "string" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" - ] } } }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" + "products": { + "$ref": "#/components/schemas/ProductListingResult" + } + } + }, + "CrossSellingElement": { + "type": "object", + "properties": { + "crossSelling": { + "$ref": "#/components/schemas/ProductCrossSelling" }, - "restockTime": { - "type": "integer" + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "stock": { - "type": "integer" + "total": { + "type": "integer", + "format": "int32" }, - "weight": { - "type": "integer" + "streamId": { + "type": "string", + "format": "uuid" }, - "width": { - "type": "integer" + "apiAlias": { + "type": "string", + "enum": [ + "cross_selling_element" + ] } }, "required": [ + "crossSelling", + "products", + "total", "apiAlias" ] }