From 517979602d2425b7204427fe9491512374840fc3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 14 Nov 2024 08:21:34 +0100 Subject: [PATCH] [create-pull-request] automated change (#287) Co-authored-by: shopwareBot --- SwagCommercial-storeapi.json | 4344 ++++++++++++-------------- SwagCommercial-storeapi.summary.json | 26 +- 2 files changed, 2034 insertions(+), 2336 deletions(-) diff --git a/SwagCommercial-storeapi.json b/SwagCommercial-storeapi.json index 9afda33..ad3f197 100644 --- a/SwagCommercial-storeapi.json +++ b/SwagCommercial-storeapi.json @@ -368,9 +368,6 @@ }, "AclRole": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -390,9 +387,6 @@ "type": "object" }, "AdvancedSearchAction": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -412,9 +406,6 @@ "type": "object" }, "AdvancedSearchActionSearchTerm": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -434,9 +425,6 @@ "type": "object" }, "AdvancedSearchBoosting": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -456,9 +444,6 @@ "type": "object" }, "AdvancedSearchConfig": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -522,9 +507,6 @@ "type": "object" }, "AdvancedSearchConfigField": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -544,9 +526,6 @@ "type": "object" }, "AdvancedSearchEntityStream": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -566,9 +545,6 @@ "type": "object" }, "AdvancedSearchEntityStreamFilter": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -588,9 +564,6 @@ "type": "object" }, "AdvancedSearchSynonym": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -612,7 +585,6 @@ "App": { "description": "Added since version: 6.3.1.0", "required": [ - "createdAt", "label" ], "properties": { @@ -639,7 +611,6 @@ "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": [ - "createdAt", "label" ], "properties": { @@ -668,8 +639,7 @@ "required": [ "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -703,7 +673,6 @@ "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": [ - "createdAt", "label" ], "properties": { @@ -730,7 +699,6 @@ "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": [ - "createdAt", "label" ], "properties": { @@ -756,9 +724,6 @@ }, "AppFlowEvent": { "description": "Added since version: 6.5.2.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -779,9 +744,6 @@ }, "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -803,7 +765,6 @@ "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": [ - "createdAt", "name" ], "properties": { @@ -829,9 +790,6 @@ }, "AppShippingMethod": { "description": "Added since version: 6.5.7.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -852,9 +810,6 @@ }, "AppTemplate": { "description": "Added since version: 6.3.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -874,9 +829,6 @@ "type": "object" }, "B2bBusinessPartner": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -900,9 +852,6 @@ }, "B2bComponentsApprovalRule": { "description": "Added since version: 6.6.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -938,7 +887,6 @@ "B2bComponentsApprovalRuleAppScriptCondition": { "description": "Added since version: 6.6.3.0", "required": [ - "createdAt", "name" ], "properties": { @@ -974,8 +922,7 @@ "salesChannelId", "shippingMethodId", "paymentMethodId", - "languageId", - "createdAt" + "languageId" ], "properties": { "id": { @@ -1158,8 +1105,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -1241,8 +1187,7 @@ "B2bComponentsRole": { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -1285,8 +1230,7 @@ "required": [ "id", "salesChannelId", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -1442,8 +1386,7 @@ "required": [ "id", "salesChannelId", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -1519,8 +1462,7 @@ { "required": [ "id", - "quantity", - "createdAt" + "quantity" ], "properties": { "id": { @@ -1598,8 +1540,7 @@ "description": "Added since version: 6.6.2.0", "required": [ "id", - "quantity", - "createdAt" + "quantity" ], "properties": { "id": { @@ -1646,8 +1587,7 @@ "languageId", "firstName", "lastName", - "email", - "createdAt" + "email" ], "properties": { "id": { @@ -1695,8 +1635,7 @@ "B2bOrderEmployee": { "required": [ "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -1726,8 +1665,7 @@ "required": [ "id", "name", - "group", - "createdAt" + "group" ], "properties": { "id": { @@ -1768,10 +1706,6 @@ { "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -2104,10 +2038,6 @@ "childCount", "translated", "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -2296,8 +2226,7 @@ "slots", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -2405,8 +2334,7 @@ "apiAlias", "sections", "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -2488,8 +2416,7 @@ "blocks", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -2587,8 +2514,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -2657,8 +2583,6 @@ { "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -2823,8 +2747,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -2964,7 +2886,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -3016,7 +2937,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -3074,7 +2994,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -3183,7 +3102,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -3283,9 +3201,6 @@ }, "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3306,9 +3221,6 @@ }, "CustomEntity": { "description": "Added since version: 6.4.9.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3329,9 +3241,6 @@ }, "CustomField": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3352,9 +3261,6 @@ }, "CustomFieldSet": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3375,9 +3281,6 @@ }, "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3400,8 +3303,7 @@ "required": [ "id", "productId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -3465,9 +3367,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -3710,8 +3610,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -3797,7 +3696,6 @@ "required": [ "translated", "id", - "createdAt", "name" ], "properties": { @@ -3861,9 +3759,6 @@ }, "CustomerRecovery": { "description": "Added since version: 6.1.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -3885,8 +3780,7 @@ "CustomerSpecificFeatures": { "required": [ "customerId", - "features", - "createdAt" + "features" ], "properties": { "id": { @@ -3945,8 +3839,7 @@ "description": "Added since version: 6.3.4.0", "required": [ "id", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -3977,8 +3870,7 @@ "description": "Added since version: 6.3.4.0", "required": [ "id", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -4013,8 +3905,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -4062,8 +3953,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -4159,9 +4049,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -4217,8 +4105,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -4255,7 +4142,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -4290,9 +4176,6 @@ }, "Flow": { "description": "Added since version: 6.4.6.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4313,9 +4196,6 @@ }, "FlowSequence": { "description": "Added since version: 6.4.6.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4336,9 +4216,6 @@ }, "FlowTemplate": { "description": "Added since version: 6.4.18.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4359,9 +4236,6 @@ }, "ImportExportFile": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4382,9 +4256,6 @@ }, "ImportExportLog": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4405,9 +4276,6 @@ }, "ImportExportProfile": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4431,9 +4299,6 @@ }, "Integration": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4461,7 +4326,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -4594,7 +4458,6 @@ "required": [ "apiAlias", "id", - "createdAt", "name", "url" ], @@ -4680,8 +4543,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -4849,8 +4711,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -4908,7 +4769,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -4947,9 +4807,6 @@ }, "LogEntry": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -4971,7 +4828,6 @@ "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -5019,7 +4875,6 @@ "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "subject", "contentHtml", "contentPlain" @@ -5109,7 +4964,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -5153,8 +5007,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -5202,8 +5055,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -5253,8 +5105,7 @@ "path", "private", "url", - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -5377,8 +5228,7 @@ }, "MediaAiTag": { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -5413,9 +5263,6 @@ }, "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5436,9 +5283,6 @@ }, "MediaFolder": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5459,9 +5303,6 @@ }, "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5515,8 +5356,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -5565,8 +5405,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -5604,9 +5443,6 @@ "$ref": "#/components/schemas/resource" }, { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5629,9 +5465,6 @@ }, "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5652,9 +5485,6 @@ }, "Notification": { "description": "Added since version: 6.4.7.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5676,7 +5506,6 @@ "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -5702,9 +5531,6 @@ }, "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5725,9 +5551,6 @@ }, "NumberRangeState": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -5749,7 +5572,6 @@ "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "typeName" ], "properties": { @@ -5785,8 +5607,7 @@ "languageId", "salesChannelId", "orderDateTime", - "currencyFactor", - "createdAt" + "currencyFactor" ], "properties": { "id": { @@ -6113,8 +5934,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -6200,8 +6020,7 @@ "id", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -6267,10 +6086,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -6412,8 +6229,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -6534,10 +6350,8 @@ "identifier", "quantity", "label", - "position", "states", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -6849,8 +6663,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -6903,9 +6716,6 @@ "type": "object" }, "OrderProductWarehouse": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -6930,8 +6740,7 @@ "orderId", "stateId", "returnNumber", - "requestedAt", - "createdAt" + "requestedAt" ], "properties": { "id": { @@ -7100,8 +6909,7 @@ "orderLineItemId", "reasonId", "quantity", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -7174,7 +6982,6 @@ "required": [ "id", "reasonKey", - "createdAt", "content" ], "properties": { @@ -7243,8 +7050,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -7365,8 +7171,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -7483,8 +7288,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -7604,8 +7408,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -7722,9 +7525,6 @@ "type": "object" }, "OrderWarehouseGroup": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -7752,7 +7552,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -7875,7 +7674,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -7964,7 +7762,6 @@ "Plugin": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "label" ], "properties": { @@ -8000,7 +7797,6 @@ "taxId", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -9030,7 +8826,6 @@ "taxId", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -9549,8 +9344,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -9607,10 +9401,7 @@ "description": "Added since version: 6.1.0.0", "required": [ "id", - "name", - "position", - "type", - "createdAt" + "name" ], "properties": { "id": { @@ -9658,9 +9449,6 @@ }, "ProductCrossSellingAssignedProducts": { "description": "Added since version: 6.2.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9684,8 +9472,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -9736,9 +9523,6 @@ }, "ProductExport": { "description": "Added since version: 6.1.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9760,7 +9544,6 @@ "ProductFeatureSet": { "description": "Added since version: 6.3.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -9809,7 +9592,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -9861,8 +9643,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -9913,9 +9694,6 @@ }, "ProductPrice": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -9943,8 +9721,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -10003,8 +9780,7 @@ "required": [ "id", "productId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -10049,9 +9825,6 @@ }, "ProductSearchConfig": { "description": "Added since version: 6.3.5.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10072,9 +9845,6 @@ }, "ProductSearchConfigField": { "description": "Added since version: 6.3.5.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10095,9 +9865,6 @@ }, "ProductSearchKeyword": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10121,7 +9888,6 @@ "required": [ "key", "priority", - "createdAt", "label" ], "properties": { @@ -10159,7 +9925,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -10194,9 +9959,6 @@ }, "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10217,9 +9979,6 @@ }, "ProductVisibility": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10239,9 +9998,6 @@ "type": "object" }, "ProductWarehouse": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10263,7 +10019,6 @@ "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -10292,9 +10047,6 @@ }, "PromotionDiscount": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10315,9 +10067,6 @@ }, "PromotionDiscountPrices": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10338,9 +10087,6 @@ }, "PromotionIndividualCode": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10361,9 +10107,6 @@ }, "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10384,9 +10127,6 @@ }, "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -10409,9 +10149,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -10473,7 +10210,6 @@ "option", "id", "groupId", - "createdAt", "name" ], "properties": { @@ -10535,8 +10271,7 @@ "currencyId", "languageId", "salesChannelId", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -10785,8 +10520,7 @@ "required": [ "id", "comment", - "quoteId", - "createdAt" + "quoteId" ], "properties": { "id": { @@ -10850,8 +10584,7 @@ "quoteId", "shippingMethodId", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -10969,8 +10702,7 @@ "required": [ "id", "quoteDeliveryId", - "quoteLineItemId", - "createdAt" + "quoteLineItemId" ], "properties": { "id": { @@ -11089,8 +10821,7 @@ "fileType", "quoteId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -11166,8 +10897,7 @@ "QuoteEmployee": { "required": [ "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -11203,8 +10933,7 @@ "states", "label", "quantity", - "position", - "createdAt" + "position" ], "properties": { "id": { @@ -11353,8 +11082,7 @@ "id", "quoteId", "paymentMethodId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -11456,8 +11184,7 @@ "Rule": { "description": "Added since version: 6.0.0.0", "required": [ - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -11524,9 +11251,6 @@ }, "RuleCondition": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -11556,7 +11280,6 @@ "shippingMethodId", "countryId", "navigationCategoryId", - "createdAt", "name", "homeEnabled" ], @@ -11700,9 +11423,6 @@ }, "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -11729,8 +11449,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -11787,7 +11506,6 @@ "SalesChannelType": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -11821,7 +11539,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -11865,7 +11582,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -11904,9 +11620,6 @@ }, "ScheduledTask": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -11927,9 +11640,6 @@ }, "Script": { "description": "Added since version: 6.4.7.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -11961,8 +11671,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -12033,8 +11742,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -12098,13 +11806,11 @@ "readOnly": true } }, - "type": "object" + "type": "object", + "title": "SeoUrlEntity" }, "SeoUrlTemplate": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12143,8 +11849,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -12391,8 +12095,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -12477,8 +12179,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -12536,8 +12237,7 @@ "required": [ "setId", "translationKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -12574,8 +12274,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "name", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -12611,9 +12310,6 @@ "type": "object" }, "SpatialRenderConfigSize": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12633,9 +12329,6 @@ "type": "object" }, "SpatialScene": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12655,9 +12348,6 @@ "type": "object" }, "SpatialSceneCamera": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12677,9 +12367,6 @@ "type": "object" }, "SpatialSceneLight": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12699,9 +12386,6 @@ "type": "object" }, "SpatialSceneObject": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12721,9 +12405,6 @@ "type": "object" }, "SsoProvider": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12746,9 +12427,6 @@ "type": "object" }, "SsoProviderCustomer": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12770,7 +12448,6 @@ "StateMachine": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", "name" ], "properties": { @@ -12808,9 +12485,6 @@ }, "StateMachineHistory": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12839,7 +12513,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "technicalName", - "createdAt", "name" ], "properties": { @@ -12874,9 +12547,6 @@ }, "StateMachineTransition": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -12906,15 +12576,12 @@ "subscriptionIntervalName", "dateInterval", "cronInterval", - "initialExecutionCount", - "remainingExecutionCount", "billingAddressId", "shippingAddressId", "shippingMethodId", "paymentMethodId", "currencyId", - "languageId", - "createdAt" + "languageId" ], "properties": { "id": { @@ -13059,8 +12726,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -13159,8 +12825,7 @@ "salutationId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -13221,11 +12886,7 @@ "SubscriptionInterval": { "required": [ "id", - "name", - "active", - "dateInterval", - "cronInterval", - "createdAt" + "name" ], "properties": { "id": { @@ -13278,10 +12939,7 @@ { "required": [ "id", - "name", - "active", - "activeStorefrontLabel", - "createdAt" + "name" ], "properties": { "id": { @@ -13378,10 +13036,7 @@ "SubscriptionPlan": { "required": [ "id", - "name", - "active", - "activeStorefrontLabel", - "createdAt" + "name" ], "properties": { "id": { @@ -13530,8 +13185,7 @@ }, "SwagDelayAction": { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -13564,8 +13218,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -13607,8 +13260,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -13636,9 +13288,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -13678,7 +13328,6 @@ "required": [ "id", "priority", - "createdAt", "name" ], "properties": { @@ -13724,9 +13373,6 @@ }, "TaxRule": { "description": "Added since version: 6.1.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -13748,7 +13394,6 @@ "TaxRuleType": { "description": "Added since version: 6.1.0.0", "required": [ - "createdAt", "typeName" ], "properties": { @@ -13778,8 +13423,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -13850,7 +13494,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -13886,9 +13529,6 @@ }, "User": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -13909,9 +13549,6 @@ }, "UserAccessKey": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -13932,9 +13569,6 @@ }, "UserConfig": { "description": "Added since version: 6.3.5.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -13955,9 +13589,6 @@ }, "UserRecovery": { "description": "Added since version: 6.0.0.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -13977,9 +13608,6 @@ "type": "object" }, "Warehouse": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -13999,9 +13627,6 @@ "type": "object" }, "WarehouseGroup": { - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -14022,9 +13647,6 @@ }, "Webhook": { "description": "Added since version: 6.3.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -14045,9 +13667,6 @@ }, "WebhookEventLog": { "description": "Added since version: 6.4.1.0", - "required": [ - "createdAt" - ], "properties": { "id": { "type": "string", @@ -14066,94 +13685,180 @@ }, "type": "object" }, - "AggregationEntity": { - "title": "AggregationEntity", + "Breadcrumb": { "type": "object", "properties": { "name": { - "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "type": { - "description": "The type of aggregation", "type": "string", "enum": [ - "entity" + "page", + "link", + "folder" ] }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "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" + } + } }, - "definition": { - "description": "The entity definition e.g \"product_manufacturer\".", + "path": { "type": "string" + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "breadcrumb" + ] } }, "required": [ "name", + "categoryId", "type", - "field", - "definition" + "translated", + "path", + "apiAlias" ] }, - "AggregationFilter": { - "title": "AggregationFilter", - "type": "object", + "CustomerAddressBody": { + "description": "Added since version: 6.0.0.0", + "required": [ + "countryId", + "firstName", + "lastName", + "city", + "street" + ], "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "type": { - "description": "The type of aggregation", + "countryStateId": { "type": "string", - "enum": [ - "filter" - ] + "pattern": "^[0-9a-f]{32}$" }, - "filter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Filters" - } + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "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" } }, - "required": [ - "name", - "type", - "filter" - ] + "type": "object" }, - "AggregationTerms": { - "title": "AggregationTerms", + "AggregationMetrics": { "type": "object", "properties": { "name": { - "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { - "description": "The type of aggregation", "type": "string", "enum": [ - "terms" + "avg", + "count", + "max", + "min", + "stats", + "sum" ] }, "field": { - "description": "The field you want to aggregate over.", "type": "string" - }, - "limit": { - "description": "The number of terms to return", - "type": "number" - }, - "sort": { - "type": "array", - "description": "Sorting the aggregation result.", - "items": { - "$ref": "#/components/schemas/Sort" - } } }, "required": [ @@ -14162,1091 +13867,827 @@ "field" ] }, - "AggregationHistogram": { - "title": "AggregationHistogram", + "FindProductVariantRouteResponse": { "type": "object", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", + "foundCombination": { + "type": "object", + "properties": { + "variantId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "options": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "CartPriceQuantity": { + "type": "object", + "properties": { + "apiAlias": { "type": "string", "enum": [ - "histogram" + "cart_price_quantity" ] }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "isCalculated": { + "type": "boolean" }, - "interval": { - "description": "The interval of the histogram", + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { "type": "number" }, - "format": { - "description": "The format of the histogram", - "type": "string" + "quantity": { + "type": "number" }, - "timeZone": { - "description": "The timezone of the histogram", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationRange": { - "title": "AggregationRange", - "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "range" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "ranges": { - "description": "The ranges of the aggregation", + "taxRules": { "type": "array", "items": { "type": "object", - "anyOf": [ - { - "type": "object", - "title": "From and to", - "properties": { - "from": { - "type": "number", - "description": "The lower bound of the range" - }, - "to": { - "type": "number", - "description": "The upper bound of the range" - } - }, - "required": [ - "from", - "to" - ] - }, - { - "type": "object", - "title": "From only", - "properties": { - "from": { - "type": "string", - "description": "The lower bound of the range" - } - }, - "required": [ - "from" - ] + "properties": { + "taxRate": { + "type": "number", + "format": "float" }, - { - "type": "object", - "title": "To only", - "properties": { - "to": { - "type": "string", - "description": "The upper bound of the range" - } - }, - "required": [ - "to" - ] + "name": { + "type": "string" } - ] + } } + }, + "type": { + "type": "string" } }, "required": [ - "name", - "type", - "field", - "ranges" + "apiAlias" ] }, - "WishlistLoadRouteResponse": { + "NavigationRouteResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "Price": { "type": "object", + "description": "Price object", "properties": { - "wishlist": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", "type": "object", "properties": { - "customerId": { - "type": "string" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string" + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } + }, + "required": [ + "gross", + "net" + ] }, - "products": { - "$ref": "#/components/schemas/ProductListingResult" + "regulationPrice": { + "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" + ] } - } + }, + "required": [ + "currencyId", + "gross", + "net" + ] }, - "SalesChannelContext": { + "CartDelivery": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "token": { - "description": "Context the user session", - "type": "string" - }, - "currentCustomerGroup": { + "deliveryDate": { "type": "object", - "description": "Customer group of the current user", "properties": { - "name": { - "type": "string" + "earliest": { + "type": "string", + "format": "date-time" }, - "displayGross": { - "type": "boolean" + "latest": { + "type": "string", + "format": "date-time" } } }, - "fallbackCustomerGroup": { - "description": "Fallback group if the default customer group is not applicable", + "location": { "type": "object", "properties": { - "name": { - "type": "string" + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] }, - "displayGross": { - "type": "boolean" + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" } } }, - "currency": { - "$ref": "#/components/schemas/Currency" + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } }, - "salesChannel": { - "description": "Information about the current sales channel", - "type": "object", - "properties": { - "typeId": { - "type": "string" - }, - "languageId": { - "type": "string" - }, - "currencyId": { - "type": "string" - }, - "paymentMethodId": { - "type": "string" - }, - "shippingMethodId": { - "type": "string" - }, - "countryId": { - "type": "string" - }, - "navigationCategoryId": { - "type": "string" - }, - "navigationCategoryDepth": { - "type": "integer", - "format": "int32" - }, - "footerCategoryId": { - "type": "string" - }, - "serviceCategoryId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "maintenance": { - "type": "boolean" - }, - "maintenanceIpWhitelist": { - "type": "string" - }, - "mailHeaderFooterId": { - "type": "string" - }, - "customerGroupId": { - "type": "string" - }, - "hreflangActive": { - "type": "boolean" - }, - "hreflangDefaultDomainId": { - "type": "string" - }, - "analyticsId": { - "type": "string" - } - } - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "shippingLocation": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - } - } + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "ProductDetailResponse": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "product": { + "$ref": "#/components/schemas/Product" }, - "context": { - "description": "Core context with general configuration values and state", - "type": "object", - "properties": { - "versionId": { - "type": "string" - }, - "currencyId": { - "type": "string" - }, - "currencyFactor": { - "type": "integer" - }, - "currencyPrecision": { - "type": "integer", - "format": "int32" - }, - "languageIdChain": { - "type": "array", - "items": { - "type": "string" - } - }, - "scope": { - "type": "string" - }, - "source": { - "type": "string" - }, - "taxState": { - "type": "string" - }, - "useCache": { - "type": "boolean" - } + "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": [ + "product" + ] }, - "Price": { + "CartPriceReference": { "type": "object", - "description": "Price object", "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "purchaseUnit": { + "type": "number" }, - "gross": { - "description": "", + "referenceUnit": { "type": "number" }, - "net": { - "description": "", + "unitName": { + "type": "string" + }, + "price": { "type": "number" }, - "linked": { - "description": "", - "type": "boolean" + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] }, "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" }, - "linked": { - "description": "", - "type": "boolean" + { + "type": "null" } - }, - "required": [ - "gross", - "net" ] }, "regulationPrice": { - "description": "", "type": "object", "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", + "price": { "type": "number" }, - "linked": { - "description": "", - "type": "boolean" + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } }, - "required": [ - "gross", - "net" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "Sitemap": { - "type": "object", - "properties": { - "filename": { - "type": "string" + "nullable": true }, - "created": { + "hasRange": { + "type": "boolean" + }, + "variantId": { "type": "string", - "format": "date-time" + "format": "^[0-9a-f]{32}$", + "nullable": true } }, "required": [ - "filename", - "created" + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" ] }, - "Breadcrumb": { + "Cart": { "type": "object", "properties": { "name": { + "description": "Name of the cart - for example `guest-cart`", "type": "string" }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "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", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "breadcrumb" - ] - } - }, - "required": [ - "name", - "categoryId", - "type", - "translated", - "path", - "apiAlias" - ] - }, - "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" + "token": { + "description": "Context token identifying the cart and the user session", + "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" - }, - "term": { - "description": "Search term", - "type": "string" - }, - "limit": { - "description": "Number of items per result page", - "type": "integer" - }, - "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" - } - ] - } }, - "ids": { + "lineItems": { + "description": "All items within the cart", "type": "array", - "description": "List of ids to search for", "items": { - "type": "string" + "$ref": "#/components/schemas/LineItem" } }, - "query": { + "errors": { "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)", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { - "$ref": "#/components/schemas/Query" + "$ref": "#/components/schemas/CartError" } }, - "associations": { + "deliveries": { "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" + "$ref": "#/components/schemas/CartDelivery" } }, - "post-filter": { + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", "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" + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" }, - { - "$ref": "#/components/schemas/RangeFilter" + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" } - ] - } - }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" + } } }, - "aggregations": { - "$ref": "#/components/schemas/Aggregations" - }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" - } + "modified": { + "type": "boolean" }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" - } + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true }, - "includes": { - "$ref": "#/components/schemas/Include" + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } } }, - "Association": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Criteria" - } - }, - "Include": { + "CartError": { "type": "object", - "additionalProperties": { - "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { "items": { - "type": "string" + "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" + } + } } } }, - "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" + "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": { + "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" + } }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - } - ] - } - }, - "SubAggregations": { - "type": "object", - "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" + "required": [ + "manufacturer", + "navigationId", + "price", + "properties", + "rating", + "shipping-free" + ] }, - { - "$ref": "#/components/schemas/AggregationEntity" + "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" + ] + } }, - { - "$ref": "#/components/schemas/AggregationFilter" + "sorting": { + "type": "string" }, - { - "$ref": "#/components/schemas/AggregationTerms" + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - { - "$ref": "#/components/schemas/AggregationHistogram" + "entity": { + "type": "string", + "enum": [ + "product" + ] }, - { - "$ref": "#/components/schemas/AggregationRange" + "apiAlias": { + "type": "string", + "enum": [ + "product_listing" + ] } + }, + "required": [ + "elements", + "availableSortings", + "currentFilters", + "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" ] }, - "Query": { + "SalesChannelContext": { "type": "object", "properties": { - "score": { - "type": "number" + "token": { + "description": "Context the user session", + "type": "string" }, - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" + "currentCustomerGroup": { + "type": "object", + "description": "Customer group of the current user", + "properties": { + "name": { + "type": "string" }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "displayGross": { + "type": "boolean" + } + } + }, + "fallbackCustomerGroup": { + "description": "Fallback group if the default customer group is not applicable", + "type": "object", + "properties": { + "name": { + "type": "string" }, - { - "$ref": "#/components/schemas/RangeFilter" + "displayGross": { + "type": "boolean" } - ] - } - }, - "additionalProperties": true - }, - "Sort": { - "type": "object", - "properties": { - "field": { - "type": "string" + } }, - "order": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] + "currency": { + "$ref": "#/components/schemas/Currency" }, - "naturalSorting": { - "type": "boolean" - }, - "type": { - "type": "string" - } - }, - "required": [ - "field", - "order" - ] - }, - "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": { - "type": { - "type": "string", - "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" - ] - }, - "field": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "EqualsFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "equals" - ] - }, - "field": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "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": { + "salesChannel": { + "description": "Information about the current sales channel", "type": "object", "properties": { - "gte": { - "type": "number" - }, - "gt": { - "type": "number" + "typeId": { + "type": "string" }, - "lte": { - "type": "number" + "languageId": { + "type": "string" }, - "lt": { - "type": "number" - } - } - } - }, - "required": [ - "type", - "field", - "parameters" - ] - }, - "NavigationRouteResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "SuccessResponse": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - } - } - }, - "ProductListingCriteria": { - "allOf": [ - { - "$ref": "#/components/schemas/Criteria" - }, - { - "type": "object", - "description": "Additional search parameters for product listings", - "properties": { - "order": { - "description": "Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.", + "currencyId": { "type": "string" }, - "limit": { - "description": "Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings.", - "type": "integer", - "minimum": 0 + "paymentMethodId": { + "type": "string" }, - "p": { - "description": "Search result page", - "type": "integer", - "default": 1 + "shippingMethodId": { + "type": "string" }, - "manufacturer": { - "description": "Filter by manufacturers. List of manufacturer identifiers separated by a `|`.", + "countryId": { "type": "string" }, - "min-price": { - "description": "Filters by a minimum product price. Has to be lower than the `max-price` filter.", - "type": "integer", - "minimum": 0, - "default": 0 + "navigationCategoryId": { + "type": "string" }, - "max-price": { - "description": "Filters by a maximum product price. Has to be higher than the `min-price` filter.", + "navigationCategoryDepth": { "type": "integer", - "minimum": 0, - "default": 0 + "format": "int32" }, - "rating": { - "description": "Filter products with a minimum average rating.", - "type": "integer" + "footerCategoryId": { + "type": "string" }, - "shipping-free": { - "description": "Filters products that are marked as shipping-free.", - "type": "boolean", - "default": false + "serviceCategoryId": { + "type": "string" }, - "properties": { - "description": "Filters products by their properties. List of property identifiers separated by a `|`.", + "name": { "type": "string" }, - "manufacturer-filter": { - "description": "Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.", - "type": "boolean", - "default": true + "shortName": { + "type": "string" }, - "price-filter": { - "description": "Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.", - "type": "boolean", - "default": true + "accessKey": { + "type": "string" }, - "rating-filter": { - "description": "Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.", - "type": "boolean", - "default": true + "active": { + "type": "boolean" }, - "shipping-free-filter": { - "description": "Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.", - "type": "boolean", - "default": true + "maintenance": { + "type": "boolean" }, - "property-filter": { - "description": "Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.", - "type": "boolean", - "default": true + "maintenanceIpWhitelist": { + "type": "string" }, - "property-whitelist": { - "description": "A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.", + "mailHeaderFooterId": { "type": "string" }, - "reduce-aggregations": { - "description": "By sending the parameter `reduce-aggregations` , the post-filters that were applied by the customer, are also applied to the aggregations. This has the consequence that only values are returned in the aggregations that would lead to further filter results. This parameter is a flag, the value has no effect.", + "customerGroupId": { + "type": "string" + }, + "hreflangActive": { + "type": "boolean" + }, + "hreflangDefaultDomainId": { + "type": "string" + }, + "analyticsId": { + "type": "string" + } + } + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingLocation": { + "type": "object", + "properties": { + "apiAlias": { "type": "string", - "nullable": true + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "context": { + "description": "Core context with general configuration values and state", + "type": "object", + "properties": { + "versionId": { + "type": "string" + }, + "currencyId": { + "type": "string" + }, + "currencyFactor": { + "type": "integer" + }, + "currencyPrecision": { + "type": "integer", + "format": "int32" + }, + "languageIdChain": { + "type": "array", + "items": { + "type": "string" + } + }, + "scope": { + "type": "string" + }, + "source": { + "type": "string" + }, + "taxState": { + "type": "string" + }, + "useCache": { + "type": "boolean" } } } - ] + } }, - "ProductDetailResponse": { + "ProductListingFlags": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", + "description": "Additional flags for product listings", "properties": { - "product": { - "$ref": "#/components/schemas/Product" + "no-aggregations": { + "description": "Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.", + "type": "string", + "nullable": true }, - "configurator": { - "type": "array", - "description": "List of property groups with their corresponding options and information on how to display them.", - "items": { - "$ref": "#/components/schemas/PropertyGroup" + "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 + } + } + }, + "ProductListingCriteria": { + "allOf": [ + { + "$ref": "#/components/schemas/Criteria" + }, + { + "type": "object", + "description": "Additional search parameters for product listings", + "properties": { + "order": { + "description": "Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.", + "type": "string" + }, + "limit": { + "description": "Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings.", + "type": "integer", + "minimum": 0 + }, + "p": { + "description": "Search result page", + "type": "integer", + "default": 1 + }, + "manufacturer": { + "description": "Filter by manufacturers. List of manufacturer identifiers separated by a `|`.", + "type": "string" + }, + "min-price": { + "description": "Filters by a minimum product price. Has to be lower than the `max-price` filter.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "max-price": { + "description": "Filters by a maximum product price. Has to be higher than the `min-price` filter.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "rating": { + "description": "Filter products with a minimum average rating.", + "type": "integer" + }, + "shipping-free": { + "description": "Filters products that are marked as shipping-free.", + "type": "boolean", + "default": false + }, + "properties": { + "description": "Filters products by their properties. List of property identifiers separated by a `|`.", + "type": "string" + }, + "manufacturer-filter": { + "description": "Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "price-filter": { + "description": "Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "rating-filter": { + "description": "Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "shipping-free-filter": { + "description": "Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "property-filter": { + "description": "Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "property-whitelist": { + "description": "A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.", + "type": "string" + }, + "reduce-aggregations": { + "description": "By sending the parameter `reduce-aggregations` , the post-filters that were applied by the customer, are also applied to the aggregations. This has the consequence that only values are returned in the aggregations that would lead to further filter results. This parameter is a flag, the value has no effect.", + "type": "string", + "nullable": true + } } } - }, - "required": [ - "product" ] }, "CalculatedPrice": { @@ -15381,14 +14822,41 @@ "taxRules" ] }, - "NavigationType": { - "type": "string", - "enum": [ - "main-navigation", - "footer-navigation", - "service-navigation" + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" ] }, + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, "ShippingMethodPageRouteResponse": { "type": "array", "items": { @@ -15731,1001 +15199,1148 @@ } } }, - "FindProductVariantRouteResponse": { + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" + ] + }, + "CrossSellingElement": { "type": "object", "properties": { - "foundCombination": { - "type": "object", + "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" + ] + } + }, + "required": [ + "crossSelling", + "products", + "total", + "apiAlias" + ] + }, + "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": { - "variantId": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "calculated_price" + ] }, - "options": { + "calculatedTaxes": { "type": "array", "items": { - "type": "string" + "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" + ] + } + }, + "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" + ] + }, + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" + } + } + }, + "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" + ] + }, + "AccountNewsletterRecipient": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "undefined", + "notSet", + "direct", + "optIn", + "optOut" + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "account_newsletter_recipient" + ] + } + }, + "required": [ + "status", + "apiAlias" + ] + }, + "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." + } + } + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] + }, + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" + ] + } + } + }, + "height": { + "type": "integer" + }, + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" + } + }, + "required": [ + "apiAlias" + ] + }, + "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" + ] + }, + "Sitemap": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "filename", + "created" + ] + }, + "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" } } }, - "ProductListingFlags": { + "WishlistLoadRouteResponse": { "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 + "wishlist": { + "type": "object", + "properties": { + "customerId": { + "type": "string" + }, + "salesChannelId": { + "type": "string" + } + } }, - "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 + "products": { + "$ref": "#/components/schemas/ProductListingResult" } } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" - ] - }, - "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": { - "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" + "page": { + "description": "Search result page", + "type": "integer" }, - "label": { + "term": { + "description": "Search term", "type": "string" }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { - "type": "boolean" - }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "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" - ] - } + "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" }, - "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" - } - } + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - } - }, - "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" - } + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" } }, - "referencedId": { - "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" + } }, - "removable": { - "type": "boolean" + "associations": { + "$ref": "#/components/schemas/Associations" }, - "stackable": { - "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" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, - "states": { + "sort": { "type": "array", + "description": "Sorting in the search result.", "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] + "$ref": "#/components/schemas/Sort" } }, - "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "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" - } + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" } }, - "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" - } + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" } }, - "positions": { + "grouping": { "type": "array", + "description": "Perform groupings over certain fields", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" + "type": "string", + "description": "Name of a field" } }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "includes": { + "$ref": "#/components/schemas/Includes" } } }, - "AggregationMetrics": { + "Associations": { "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" - ] - }, - "field": { + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Includes": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { "type": "string" } - }, - "required": [ - "name", - "type", - "field" - ] + } }, - "OrderRouteResponse": { - "type": "object", - "properties": { - "orders": { + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "title": "AggregationEntity", "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } + "$ref": "#/components/schemas/AggregationEntity" }, { - "$ref": "#/components/schemas/EntitySearchResult" + "$ref": "#/components/schemas/SubAggregations" } ] }, - "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" + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] }, { - "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" - ] + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "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" - ] - } + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "sorting": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" }, - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "entity": { - "type": "string", - "enum": [ - "product" - ] + { + "$ref": "#/components/schemas/AggregationEntity" }, - "apiAlias": { - "type": "string", - "enum": [ - "product_listing" - ] + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" } - }, - "required": [ - "elements", - "availableSortings", - "currentFilters", - "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" ] }, - "CustomerAddressBody": { - "description": "Added since version: 6.0.0.0", - "required": [ - "countryId", - "firstName", - "lastName", - "city", - "street" - ], + "Query": { + "type": "object", "properties": { - "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" - }, - "lastName": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "street": { - "type": "string" - }, - "department": { - "type": "string" + "score": { + "type": "number" }, - "title": { + "query": { + "oneOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "additionalProperties": true + }, + "Sort": { + "type": "object", + "properties": { + "field": { "type": "string" }, - "phoneNumber": { - "type": "string" + "order": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] }, - "additionalAddressLine1": { - "type": "string" + "naturalSorting": { + "type": "boolean" }, - "additionalAddressLine2": { + "type": { "type": "string" - }, - "customFields": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" } }, - "type": "object" + "required": [ + "field", + "order" + ] }, - "AccountNewsletterRecipient": { + "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": { - "status": { + "type": { "type": "string", "enum": [ - "undefined", - "notSet", - "direct", - "optIn", - "optOut" + "contains", + "equalsAny", + "prefix", + "suffix" ] }, - "apiAlias": { - "type": "string", - "enum": [ - "account_newsletter_recipient" - ] + "field": { + "type": "string" + }, + "value": { + "type": "string" } }, "required": [ - "status", - "apiAlias" + "type", + "field", + "value" ] }, - "CrossSellingElement": { + "EqualsFilter": { "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": { "type": "string", "enum": [ - "cross_selling_element" + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } ] } }, "required": [ - "crossSelling", - "products", - "total", - "apiAlias" + "type", + "field", + "value" ] }, - "CustomerAddressRead": { + "MultiNotFilter": { "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": { "type": "string", - "format": "date-time" + "enum": [ + "multi", + "not" + ] }, - "updatedAt": { + "operator": { "type": "string", - "format": "date-time", - "nullable": true - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState", - "nullable": true + "enum": [ + "and", + "or", + "nor", + "nand" + ] }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "queries": { + "$ref": "#/components/schemas/Filters" } }, "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" + "type", + "operator", + "queries" ] }, - "CartPriceQuantity": { + "RangeFilter": { "type": "object", "properties": { - "apiAlias": { + "type": { "type": "string", "enum": [ - "cart_price_quantity" + "range" ] }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "quantity": { - "type": "number" + "field": { + "type": "string" }, - "regulationPrice": { + "parameters": { + "type": "object", "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "gte": { + "type": "number" + }, + "gt": { + "type": "number" + }, + "lte": { + "type": "number" + }, + "lt": { + "type": "number" } } - }, - "type": { - "type": "string" } }, "required": [ - "apiAlias" + "type", + "field", + "parameters" ] }, - "EntitySearchResult": { + "AggregationEntity": { + "title": "AggregationEntity", "type": "object", "properties": { - "entity": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "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": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "entity" + ] }, - "page": { - "type": "integer", - "description": "The actual page. This can be used for pagination." + "field": { + "description": "The field you want to aggregate over.", + "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": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } - } + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" } - } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] }, - "Cart": { + "AggregationFilter": { + "title": "AggregationFilter", "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", + "description": "Give your aggregation an identifier, so you can find it easier", "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" - } + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "filter" + ] }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", + "filter": { "type": "array", "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } + "$ref": "#/components/schemas/Filters" } - }, - "modified": { - "type": "boolean" - }, - "customerComment": { - "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true - }, - "affiliateCode": { - "type": "string", - "description": "An affiliate tracking code", - "nullable": true - }, - "campaignCode": { - "type": "string", - "description": "A campaign tracking code", - "nullable": true } - } + }, + "required": [ + "name", + "type", + "filter" + ] }, - "CartPriceReference": { + "AggregationTerms": { + "title": "AggregationTerms", "type": "object", "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "price": { - "type": "number" - }, - "apiAlias": { + "type": { + "description": "The type of aggregation", "type": "string", "enum": [ - "cart_price_reference" - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } + "terms" ] }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "hasRange": { - "type": "boolean" + "limit": { + "description": "The number of terms to return", + "type": "number" }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" + "name", + "type", + "field" ] }, - "CartListPrice": { + "AggregationHistogram": { + "title": "AggregationHistogram", "type": "object", - "description": "", "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "apiAlias": { + "type": { + "description": "The type of aggregation", "type": "string", "enum": [ - "cart_list_price" + "histogram" ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "interval": { + "description": "The interval of the histogram", + "type": "number" + }, + "format": { + "description": "The format of the histogram", + "type": "string" + }, + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" } }, "required": [ - "apiAlias" + "name", + "type", + "field" ] }, - "CrossSellingElementCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CrossSellingElement" - } - }, - "CartDeliveryInformation": { + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", "type": "object", "properties": { - "apiAlias": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", "type": "string", "enum": [ - "cart_delivery_information" + "range" ] }, - "freeDelivery": { - "type": "boolean" + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { - "type": "string" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" - ] - } + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { + "type": "object", + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] + } + ] } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "CustomerAddressRead": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "restockTime": { - "type": "integer" + "createdAt": { + "type": "string", + "format": "date-time" }, - "stock": { - "type": "integer" + "updatedAt": { + "type": "string", + "format": "date-time", + "nullable": true }, - "weight": { - "type": "integer" + "country": { + "$ref": "#/components/schemas/Country" }, - "width": { - "type": "integer" + "countryState": { + "$ref": "#/components/schemas/CountryState", + "nullable": true + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "required": [ - "apiAlias" + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" ] }, + "SuccessResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "CrossSellingElementCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CrossSellingElement" + } + }, "SearchByImageSearchTermResponse": { "type": "array", "items": { @@ -17060,30 +16675,6 @@ "204": { "description": "No Content" }, - "ContextTokenResponse": { - "description": "Returns the context token. Use that as your `sw-context-token` header for subsequent requests. Redirect if getRedirectUrl is set.", - "headers": { - "sw-context-token": { - "description": "Contains sw-context-token value", - "schema": { - "type": "string" - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "redirectUrl": { - "description": "Define the URL which browser will be redirected to", - "type": "string" - } - } - } - } - } - }, "OpenApi3": { "description": "Returns information about the store API.", "content": { @@ -17272,6 +16863,30 @@ } } } + }, + "ContextTokenResponse": { + "description": "Returns the context token. Use that as your `sw-context-token` header for subsequent requests. Redirect if getRedirectUrl is set.", + "headers": { + "sw-context-token": { + "description": "Contains sw-context-token value", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "redirectUrl": { + "description": "Define the URL which browser will be redirected to", + "type": "string" + } + } + } + } + } } }, "parameters": { @@ -17317,6 +16932,146 @@ } ], "paths": { + "/permission": { + "get": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Fetch all available permissions", + "description": "This route is used to fetch all available permissions", + "operationId": "readPermissions", + "responses": { + "200": { + "description": "Permission collection", + "content": { + "application/json": { + "schema": { + "type": "object", + "allOf": [ + { + "properties": { + "elements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "permissionName": { + "type": "string" + }, + "permissionDependencies": { + "type": "array", + "items": { + "type": "string" + } + }, + "permissionGroupName": { + "type": "string" + } + } + } + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + }, + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Add a new permission", + "description": "This route is used to add a new permissions", + "operationId": "addPermission", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the new permission", + "type": "string" + }, + "group": { + "description": "Group of the new permission", + "type": "string" + }, + "dependencies": { + "description": "Optional dependencies for the new permission", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + } + } + } + }, + "parameters": [], + "responses": { + "200": { + "description": "Permission collection", + "content": { + "application/json": { + "schema": { + "type": "object", + "allOf": [ + { + "properties": { + "elements": { + "type": "array", + "items": { + "type": "object", + "properties": { + "permissionName": { + "type": "string" + }, + "permissionDependencies": { + "type": "array", + "items": { + "type": "string" + } + }, + "permissionGroupName": { + "type": "string" + } + } + } + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + }, "/role/create": { "post": { "tags": [ @@ -17619,63 +17374,6 @@ ] } }, - "/role/permissions": { - "get": { - "tags": [ - "B2B Employee Management" - ], - "summary": "Fetch a available permissions", - "description": "This route is used to fetch all available permissions", - "operationId": "readPermissions", - "responses": { - "200": { - "description": "Permission collection", - "content": { - "application/json": { - "schema": { - "type": "object", - "allOf": [ - { - "properties": { - "elements": { - "type": "array", - "items": { - "type": "object", - "properties": { - "permissionName": { - "type": "string" - }, - "permissionDependencies": { - "type": "array", - "items": { - "type": "string" - } - }, - "permissionGroupName": { - "type": "string" - } - } - } - } - }, - "type": "object" - }, - { - "$ref": "#/components/schemas/EntitySearchResult" - } - ] - } - } - } - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - }, "/role/default": { "post": { "tags": [ @@ -19147,7 +18845,7 @@ ] } }, - "/account/shopping-list": { + "/shopping-list": { "post": { "tags": [ "B2B Shopping Lists" @@ -19249,7 +18947,7 @@ ] } }, - "/account/shopping-lists": { + "/shopping-lists": { "post": { "tags": [ "B2B Shopping Lists" @@ -19301,7 +18999,7 @@ ] } }, - "/account/shopping-list/{id}": { + "/shopping-list/{id}": { "post": { "tags": [ "B2B Shopping Lists" @@ -19340,7 +19038,7 @@ ] } }, - "/account/shopping-list/{id}/change-name": { + "/shopping-list/{id}/change-name": { "patch": { "tags": [ "B2B Shopping Lists" @@ -19391,7 +19089,7 @@ ] } }, - "/account/shopping-list/{id}/duplicate": { + "/shopping-list/{id}/duplicate": { "post": { "tags": [ "B2B Shopping Lists" @@ -19455,7 +19153,7 @@ ] } }, - "/account/shopping-list/{id}/summary": { + "/shopping-list/{id}/summary": { "get": { "tags": [ "B2B Shopping Lists" @@ -19520,7 +19218,7 @@ ] } }, - "/account/shopping-list/line-item/{id}/add": { + "/shopping-list/{id}/add": { "post": { "tags": [ "B2B Shopping Lists" @@ -19588,7 +19286,7 @@ ] } }, - "/account/shopping-list/line-item/remove": { + "/shopping-list/line-item/remove": { "delete": { "tags": [ "B2B Shopping Lists" @@ -19632,7 +19330,7 @@ ] } }, - "/account/shopping-list/line-item/{id}/change-quantity": { + "/shopping-list/line-item/{id}/change-quantity": { "patch": { "tags": [ "B2B Shopping Lists" diff --git a/SwagCommercial-storeapi.summary.json b/SwagCommercial-storeapi.summary.json index b2de367..9774926 100644 --- a/SwagCommercial-storeapi.summary.json +++ b/SwagCommercial-storeapi.summary.json @@ -1,14 +1,5 @@ { "paths": [ - "/account/shopping-list", - "/account/shopping-list/line-item/remove", - "/account/shopping-list/line-item/{id}/add", - "/account/shopping-list/line-item/{id}/change-quantity", - "/account/shopping-list/{id}", - "/account/shopping-list/{id}/change-name", - "/account/shopping-list/{id}/duplicate", - "/account/shopping-list/{id}/summary", - "/account/shopping-lists", "/approval-rule", "/approval-rule/create", "/approval-rule/{id}", @@ -21,6 +12,7 @@ "/pending-order/{id}/approve", "/pending-order/{id}/checkout/order", "/pending-order/{id}/decline", + "/permission", "/product/image-upload-search/search-term", "/product/natural-language/search-term", "/quote/detail/{id}", @@ -34,8 +26,16 @@ "/role", "/role/create", "/role/default", - "/role/permissions", "/role/{id}", + "/shopping-list", + "/shopping-list/line-item/remove", + "/shopping-list/line-item/{id}/change-quantity", + "/shopping-list/{id}", + "/shopping-list/{id}/add", + "/shopping-list/{id}/change-name", + "/shopping-list/{id}/duplicate", + "/shopping-list/{id}/summary", + "/shopping-lists", "/shopping-lists/add-to-cart", "/sso/auth/{providerId}", "/sso/redirect/{providerId}" @@ -51,13 +51,13 @@ "AdvancedSearchEntityStream", "AdvancedSearchEntityStreamFilter", "AdvancedSearchSynonym", + "Aggregation", "AggregationEntity", "AggregationFilter", "AggregationHistogram", "AggregationMetrics", "AggregationRange", "AggregationTerms", - "Aggregations", "App", "AppActionButton", "AppAdministrationSnippet", @@ -69,7 +69,7 @@ "AppShippingMethod", "AppTemplate", "ApprovalRule", - "Association", + "Associations", "B2bBusinessPartner", "B2bComponentsApprovalRule", "B2bComponentsApprovalRuleAppScriptCondition", @@ -140,7 +140,7 @@ "ImportExportFile", "ImportExportLog", "ImportExportProfile", - "Include", + "Includes", "Integration", "LandingPage", "LandingPageJsonApi",