From 4a44f56f51b3934f40b1081daf7b95b322ae19a9 Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Wed, 5 Feb 2025 09:06:37 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagCommercial-storeapi.json | 6918 ++++++++++++++------------ SwagCommercial-storeapi.summary.json | 2 + 2 files changed, 3721 insertions(+), 3199 deletions(-) diff --git a/SwagCommercial-storeapi.json b/SwagCommercial-storeapi.json index 975303b..61a8950 100644 --- a/SwagCommercial-storeapi.json +++ b/SwagCommercial-storeapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.9999999-dev" + "version": "6.7.9999999-dev" }, "servers": [ { @@ -1207,6 +1207,10 @@ "customFields": { "type": "object" }, + "default": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -1613,6 +1617,9 @@ "customFields": { "type": "object" }, + "status": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -3366,8 +3373,7 @@ "customerNumber", "firstName", "lastName", - "email", - "defaultPaymentMethodId" + "email" ], "properties": { "id": { @@ -3493,10 +3499,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -3577,9 +3579,6 @@ "$ref": "#/components/schemas/Tag" } }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, "apiAlias": { "type": "string", "enum": [ @@ -3978,7 +3977,6 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", "deepLinkCode" @@ -3992,9 +3990,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -4007,6 +4002,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -4068,6 +4067,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -7607,6 +7609,7 @@ { "required": [ "id", + "technicalName", "name" ], "properties": { @@ -7729,6 +7732,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "name" ], "properties": { @@ -10318,179 +10322,647 @@ }, "type": "object" }, - "Quote": { + "QuoteJsonApi": { "description": "Added since version: 6.5.3.0", - "required": [ - "id", - "stateId", - "currencyId", - "languageId", - "salesChannelId", - "customerId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteNumber": { - "type": "string" - }, - "expirationDate": { - "type": "string", - "format": "date-time" - }, - "sentAt": { - "type": "string", - "format": "date-time" + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "price": { + { "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" + "id", + "stateId", + "currencyId", + "languageId", + "salesChannelId", + "customerId" ], "properties": { - "netPrice": { - "type": "number", - "format": "float" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalPrice": { - "type": "number", - "format": "float" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "calculatedTaxes": { - "type": "object" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "taxRules": { - "type": "object" + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "positionPrice": { - "type": "number", - "format": "float" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "rawTotal": { - "type": "number", - "format": "float" + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalPrice": { - "type": "number", - "format": "float" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "integer", - "format": "int64" + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "calculatedTaxes": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "taxRules": { - "type": "object" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "referencePrice": { - "type": "object" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "listPrice": { + "quoteNumber": { + "type": "string" + }, + "expirationDate": { + "type": "string", + "format": "date-time" + }, + "sentAt": { + "type": "string", + "format": "date-time" + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], "properties": { - "price": { + "netPrice": { "type": "number", "format": "float" }, - "discount": { + "totalPrice": { "type": "number", "format": "float" }, - "percentage": { + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { "type": "number", "format": "float" + }, + "taxStatus": { + "type": "string" } }, "type": "object" }, - "regulationPrice": { + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "price": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { "type": "number", "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" } }, "type": "object" - } - }, - "type": "object" - }, - "discount": { - "properties": { - "type": { - "type": "string" }, - "value": { - "type": "number", - "format": "float" - } + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "subtotalNet": { + "type": "number", + "format": "float" + }, + "totalDiscount": { + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "lineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/lineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } + } + } + } + }, + "type": "object" + }, + "deliveries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/deliveries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_delivery" + }, + "id": { + "type": "string", + "example": "6fc31b6b9cd717cc0dcb81152308f8af" + } + } + } + } + }, + "type": "object" + }, + "transactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/transactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_transaction" + }, + "id": { + "type": "string", + "example": "c15b977dd99332ca8623fbdfb86827e8" + } + } + } + } + }, + "type": "object" + }, + "comments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/comments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "a5d491060952aa8ad5fdee071be752de" + } + } + } + } + }, + "type": "object" + }, + "documents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/documents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Quote": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "stateId", + "currencyId", + "languageId", + "salesChannelId", + "customerId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteNumber": { + "type": "string" + }, + "expirationDate": { + "type": "string", + "format": "date-time" + }, + "sentAt": { + "type": "string", + "format": "date-time" + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + } }, "type": "object" }, @@ -11910,6 +12382,7 @@ "required": [ "id", "deliveryTimeId", + "technicalName", "name" ], "properties": { @@ -12144,332 +12617,58 @@ "type": "object" } }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "ShippingMethod": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "deliveryTimeId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "deliveryTimeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxType": { - "type": "string" - }, - "description": { - "type": "string" - }, - "trackingUrl": { - "type": "string" - }, - "technicalName": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" - }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" - }, - "prices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "tax": { - "$ref": "#/components/schemas/Tax" - } - }, - "type": "object" - }, - "ShippingMethodPrice": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "shippingMethodId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "calculation": { - "type": "integer", - "format": "int64" - }, - "calculationRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantityStart": { - "type": "number", - "format": "float" - }, - "quantityEnd": { - "type": "number", - "format": "float" - }, - "currencyPrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Snippet": { - "description": "Added since version: 6.0.0.0", - "required": [ - "setId", - "translationKey", - "value" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "setId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationKey": { - "type": "string" - }, - "value": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SnippetSet": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name", - "iso" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "iso": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "snippets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - }, - "type": "object" - }, - "SpatialRenderConfigSize": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "type": "object" + } + }, + "type": "object" } - }, - "type": "object" + ] }, - "SpatialScene": { + "ShippingMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "deliveryTimeId", + "technicalName", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "name": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneCamera": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "position": { + "type": "integer", + "format": "int64" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneGroup": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "createdAt": { + "mediaId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneLight": { - "properties": { - "id": { + "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "taxType": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneMaterial": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" + }, + "trackingUrl": { + "type": "string" + }, + "technicalName": { + "type": "string" }, "createdAt": { "type": "string", @@ -12480,75 +12679,80 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule" + }, + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "tax": { + "$ref": "#/components/schemas/Tax" } }, "type": "object" }, - "SpatialSceneObject": { + "ShippingMethodPrice": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "shippingMethodId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "shippingMethodId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialScenePrimitive": { - "properties": { - "id": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "calculation": { + "type": "integer", + "format": "int64" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SsoProvider": { - "properties": { - "id": { + "calculationRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "quantityStart": { + "type": "number", + "format": "float" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "quantityEnd": { + "type": "number", + "format": "float" }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "SsoProviderCustomer": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "currencyPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -12563,50 +12767,30 @@ }, "type": "object" }, - "StateMachine": { + "Snippet": { "description": "Added since version: 6.0.0.0", "required": [ - "name" + "setId", + "translationKey", + "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { + "setId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "translationKey": { + "type": "string" }, - "states": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } + "value": { + "type": "string" }, - "transitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - }, - "type": "object" - }, - "StateMachineHistory": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -12617,31 +12801,25 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "fromStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "toStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" } }, "type": "object" }, - "StateMachineState": { + "SnippetSet": { "description": "Added since version: 6.0.0.0", "required": [ - "technicalName", - "name" + "name", + "iso" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { + "name": { "type": "string" }, - "name": { + "iso": { "type": "string" }, "customFields": { @@ -12657,14 +12835,16 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "snippets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } } }, "type": "object" }, - "StateMachineTransition": { - "description": "Added since version: 6.0.0.0", + "SpatialRenderConfigSize": { "properties": { "id": { "type": "string", @@ -12683,98 +12863,69 @@ }, "type": "object" }, - "Subscription": { - "required": [ - "id", - "convertedOrder", - "subscriptionNumber", - "nextSchedule", - "salesChannelId", - "subscriptionPlanName", - "subscriptionIntervalName", - "dateInterval", - "cronInterval", - "billingAddressId", - "shippingAddressId", - "shippingMethodId", - "paymentMethodId", - "currencyId", - "languageId" - ], + "SpatialScene": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "convertedOrder": { - "type": "object" - }, - "subscriptionNumber": { - "type": "string" - }, - "nextSchedule": { - "type": "string", - "format": "date-time" - }, - "salesChannelId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "subscriptionPlanId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionPlanName": { - "type": "string" - }, - "subscriptionIntervalId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SpatialSceneCamera": { + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscriptionIntervalName": { - "type": "string" - }, - "dateInterval": { - "type": "string" - }, - "cronInterval": { - "type": "string" - }, - "initialExecutionCount": { - "type": "integer", - "format": "int64" - }, - "remainingExecutionCount": { - "type": "integer", - "format": "int64" - }, - "billingAddressId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "shippingAddressId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SpatialSceneGroup": { + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "currencyId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SpatialSceneLight": { + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -12784,127 +12935,53 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "subscriptionPlan": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "subscriptionInterval": { - "$ref": "#/components/schemas/SubscriptionInterval" - }, - "subscriptionCustomer": { - "$ref": "#/components/schemas/SubscriptionCustomer" - }, - "billingAddress": { - "$ref": "#/components/schemas/SubscriptionAddress" - }, - "shippingAddress": { - "$ref": "#/components/schemas/SubscriptionAddress" - }, - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionAddress" - } - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "orders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "language": { - "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "SubscriptionAddress": { - "required": [ - "id", - "countryId", - "subscriptionId", - "firstName", - "lastName", - "street", - "city" - ], + "SpatialSceneMaterial": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "subscriptionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SpatialSceneObject": { + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "street": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { - "type": "string" - }, - "vatId": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "additionalAddressLine1": { - "type": "string" - }, - "additionalAddressLine2": { - "type": "string" + "format": "date-time", + "readOnly": true }, - "customFields": { - "type": "object" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SpatialScenePrimitive": { + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -12915,75 +12992,37 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "billingSubscription": { - "$ref": "#/components/schemas/Subscription" - }, - "shippingSubscription": { - "$ref": "#/components/schemas/Subscription" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - }, - "subscription": { - "$ref": "#/components/schemas/Subscription" } }, "type": "object" }, - "SubscriptionCustomer": { - "required": [ - "id", - "salutationId", - "email", - "firstName", - "lastName" - ], + "SsoProvider": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "salutationId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "email": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "company": { - "type": "string" - }, - "title": { - "type": "string" - }, - "customerNumber": { - "type": "string" - }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } + "format": "date-time", + "readOnly": true }, - "customFields": { - "type": "object" + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "SsoProviderCustomer": { + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -12994,16 +13033,13 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "SubscriptionInterval": { + "StateMachine": { + "description": "Added since version: 6.0.0.0", "required": [ - "id", "name" ], "properties": { @@ -13011,22 +13047,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "dateInterval": { - "type": "string" - }, - "cronInterval": { - "type": "string" - }, - "availabilityRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13040,159 +13060,66 @@ "translated": { "type": "object" }, - "subscriptions": { + "states": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/StateMachineState" + } + }, + "transitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" } } }, "type": "object" }, - "SubscriptionPlanJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "minimumExecutionCount": { - "type": "integer", - "format": "int64" - }, - "activeStorefrontLabel": { - "type": "boolean" - }, - "availabilityRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "discountPercentage": { - "type": "number", - "format": "float" - }, - "label": { - "type": "string" - }, - "discountPrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "subscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/subscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "SubscriptionPlan": { - "required": [ - "id", - "name" - ], + "StateMachineHistory": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "active": { - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "minimumExecutionCount": { - "type": "integer", - "format": "int64" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "activeStorefrontLabel": { - "type": "boolean" + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "availabilityRuleId": { + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "type": "object" + }, + "StateMachineState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "technicalName", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "discountPercentage": { - "type": "number", - "format": "float" + "technicalName": { + "type": "string" }, - "label": { + "name": { "type": "string" }, - "discountPrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -13206,58 +13133,64 @@ }, "translated": { "type": "object" - }, - "subscriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Subscription" - } } }, "type": "object" }, - "SubscriptionPlanIntervalMapping": { - "required": [ - "subscriptionIntervalId", - "subscriptionPlanId" - ], + "StateMachineTransition": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscriptionIntervalId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "subscriptionPlanId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionPlan": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "subscriptionInterval": { - "$ref": "#/components/schemas/SubscriptionInterval" + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "SubscriptionPlanProductMapping": { + "Subscription": { "required": [ - "productId", - "subscriptionPlanId" + "id", + "convertedOrder", + "subscriptionNumber", + "nextSchedule", + "salesChannelId", + "subscriptionPlanName", + "subscriptionIntervalName", + "dateInterval", + "cronInterval", + "billingAddressId", + "shippingAddressId", + "shippingMethodId", + "paymentMethodId", + "currencyId", + "languageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "convertedOrder": { + "type": "object" + }, + "subscriptionNumber": { + "type": "string" + }, + "nextSchedule": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "productVersionId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13265,59 +13198,188 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscriptionPlan": { - "$ref": "#/components/schemas/SubscriptionPlan" + "subscriptionPlanName": { + "type": "string" }, - "product": { - "$ref": "#/components/schemas/Product" - } - }, - "type": "object" - }, - "SubscriptionTagMapping": { - "required": [ - "subscriptionId", - "tagId" - ], - "properties": { - "id": { + "subscriptionIntervalId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscriptionId": { + "subscriptionIntervalName": { + "type": "string" + }, + "dateInterval": { + "type": "string" + }, + "cronInterval": { + "type": "string" + }, + "initialExecutionCount": { + "type": "integer", + "format": "int64" + }, + "remainingExecutionCount": { + "type": "integer", + "format": "int64" + }, + "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "shippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscription": { - "$ref": "#/components/schemas/Subscription" + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "subscriptionPlan": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "subscriptionInterval": { + "$ref": "#/components/schemas/SubscriptionInterval" + }, + "subscriptionCustomer": { + "$ref": "#/components/schemas/SubscriptionCustomer" + }, + "billingAddress": { + "$ref": "#/components/schemas/SubscriptionAddress" + }, + "shippingAddress": { + "$ref": "#/components/schemas/SubscriptionAddress" + }, + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "language": { + "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "SwagDelayAction": { + "SubscriptionAddress": { "required": [ - "id" + "id", + "countryId", + "subscriptionId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "subscriptionId": { + "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" + }, + "street": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13327,103 +13389,72 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "SystemConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "configurationKey", - "configurationValue" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "configurationKey": { - "type": "string" + "billingSubscription": { + "$ref": "#/components/schemas/Subscription" }, - "configurationValue": { - "properties": { - "_value": { - "type": "object" - } - }, - "type": "object" + "shippingSubscription": { + "$ref": "#/components/schemas/Subscription" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "country": { + "$ref": "#/components/schemas/Country" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salutation": { + "$ref": "#/components/schemas/Salutation" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "subscription": { + "$ref": "#/components/schemas/Subscription" } }, "type": "object" }, - "Tag": { - "description": "Added since version: 6.0.0.0", + "SubscriptionCustomer": { "required": [ "id", - "name" + "salutationId", + "email", + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "createdAt": { + "customerId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Tax": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "taxRate", - "name" - ], - "properties": { - "id": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "taxRate": { - "type": "number", - "format": "float" + "email": { + "type": "string" }, - "name": { + "firstName": { "type": "string" }, - "position": { - "description": "Added since version: 6.4.0.0.", - "type": "integer", - "format": "int64" + "lastName": { + "type": "string" + }, + "company": { + "type": "string" + }, + "title": { + "type": "string" + }, + "customerNumber": { + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" @@ -13437,15 +13468,16 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "TaxProvider": { - "description": "Added since version: 6.5.0.0", + "SubscriptionInterval": { "required": [ "id", - "priority", "name" ], "properties": { @@ -13453,26 +13485,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, "active": { "type": "boolean" }, - "name": { + "dateInterval": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" - }, - "processUrl": { + "cronInterval": { "type": "string" }, - "appId": { + "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13485,106 +13513,160 @@ }, "translated": { "type": "object" - } - }, - "type": "object" - }, - "TaxRule": { - "description": "Added since version: 6.1.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } } }, "type": "object" }, - "TaxRuleType": { - "description": "Added since version: 6.1.0.0", - "required": [ - "typeName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "SubscriptionPlanJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "translated": { + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "minimumExecutionCount": { + "type": "integer", + "format": "int64" + }, + "activeStorefrontLabel": { + "type": "boolean" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "discountPercentage": { + "type": "number", + "format": "float" + }, + "label": { + "type": "string" + }, + "discountPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, "type": "object" } - }, - "type": "object" + ] }, - "Theme": { - "description": "Added since version: 6.0.0.0", + "SubscriptionPlan": { "required": [ "id", - "name", - "author", - "active" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" - }, "name": { "type": "string" }, - "author": { - "type": "string" - }, "description": { "type": "string" }, - "labels": { - "type": "object" - }, - "helpTexts": { - "type": "object" + "active": { + "type": "boolean" }, - "customFields": { - "type": "object" + "minimumExecutionCount": { + "type": "integer", + "format": "int64" }, - "previewMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "activeStorefrontLabel": { + "type": "boolean" }, - "parentThemeId": { + "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "baseConfig": { - "type": "object" + "discountPercentage": { + "type": "number", + "format": "float" }, - "configValues": { - "type": "object" + "label": { + "type": "string" }, - "active": { - "type": "boolean" + "discountPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -13599,79 +13681,117 @@ "translated": { "type": "object" }, - "media": { + "subscriptions": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Subscription" } } }, "type": "object" }, - "Unit": { - "description": "Added since version: 6.0.0.0", + "SubscriptionPlanIntervalMapping": { "required": [ - "id", - "shortCode", - "name" + "subscriptionIntervalId", + "subscriptionPlanId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "type": "string" + "subscriptionIntervalId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "subscriptionPlanId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "subscriptionPlan": { + "$ref": "#/components/schemas/SubscriptionPlan" }, - "createdAt": { + "subscriptionInterval": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + }, + "type": "object" + }, + "SubscriptionPlanProductMapping": { + "required": [ + "productId", + "subscriptionPlanId" + ], + "properties": { + "id": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "productId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "subscriptionPlanId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "subscriptionPlan": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "User": { - "description": "Added since version: 6.0.0.0", + "SubscriptionTagMapping": { + "required": [ + "subscriptionId", + "tagId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "subscriptionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "tagId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" + }, + "subscription": { + "$ref": "#/components/schemas/Subscription" + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "UserAccessKey": { - "description": "Added since version: 6.0.0.0", + "SwagDelayAction": { + "required": [ + "id" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13685,13 +13805,33 @@ }, "type": "object" }, - "UserConfig": { - "description": "Added since version: 6.3.5.0", + "SystemConfig": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "configurationKey", + "configurationValue" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "configurationKey": { + "type": "string" + }, + "configurationValue": { + "properties": { + "_value": { + "type": "object" + } + }, + "type": "object" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13701,17 +13841,27 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "UserRecovery": { + "Tag": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13725,12 +13875,33 @@ }, "type": "object" }, - "Warehouse": { + "Tax": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "taxRate", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Added since version: 6.4.0.0.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13744,12 +13915,38 @@ }, "type": "object" }, - "WarehouseGroup": { + "TaxProvider": { + "description": "Added since version: 6.5.0.0", + "required": [ + "id", + "priority", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "processUrl": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13759,12 +13956,15 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "Webhook": { - "description": "Added since version: 6.3.1.0", + "TaxRule": { + "description": "Added since version: 6.1.0.0", "properties": { "id": { "type": "string", @@ -13783,8 +13983,11 @@ }, "type": "object" }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.0", + "TaxRuleType": { + "description": "Added since version: 6.1.0.0", + "required": [ + "typeName" + ], "properties": { "id": { "type": "string", @@ -13799,337 +14002,280 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "CrossSellingElementCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CrossSellingElement" - } - }, - "FindProductVariantRouteResponse": { - "type": "object", - "properties": { - "foundCombination": { - "type": "object", - "properties": { - "variantId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "options": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "Breadcrumb": { - "type": "object", + "Theme": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "author", + "active" + ], "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, "name": { "type": "string" }, - "categoryId": { + "author": { + "type": "string" + }, + "description": { + "type": "string" + }, + "labels": { + "type": "object" + }, + "helpTexts": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "parentThemeId": { "type": "string", - "enum": [ - "page", - "link", - "folder" - ] + "pattern": "^[0-9a-f]{32}$" }, - "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" - } - } + "baseConfig": { + "type": "object" }, - "path": { - "type": "string" + "configValues": { + "type": "object" }, - "seoUrls": { + "active": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Media" } - }, - "apiAlias": { - "type": "string", - "enum": [ - "breadcrumb" - ] } }, - "required": [ - "name", - "categoryId", - "type", - "translated", - "path", - "apiAlias" - ] + "type": "object" }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", + "Unit": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "shortCode", + "name" + ], "properties": { - "unitPrice": { - "type": "number" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "number" + "shortCode": { + "type": "string" }, - "rawTotal": { - "type": "number" + "name": { + "type": "string" }, - "totalPrice": { - "type": "number" + "customFields": { + "type": "object" }, - "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" - ] - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "User": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "positionPrice": { - "type": "number" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "netPrice": { - "type": "number" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "UserAccessKey": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "hasRange": { - "type": "boolean" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "UserConfig": { + "description": "Added since version: 6.3.5.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "variantId": { + "createdAt": { "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "format": "date-time", + "readOnly": true }, - "apiAlias": { + "updatedAt": { "type": "string", - "enum": [ - "calculated_price" - ] + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "UserRecovery": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] + "type": "object" }, - "CrossSellingElement": { - "type": "object", + "Warehouse": { "properties": { - "crossSelling": { - "$ref": "#/components/schemas/ProductCrossSelling" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "total": { - "type": "integer", - "format": "int32" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "WarehouseGroup": { + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "streamId": { + "createdAt": { "type": "string", - "format": "uuid" + "format": "date-time", + "readOnly": true }, - "apiAlias": { + "updatedAt": { "type": "string", - "enum": [ - "cross_selling_element" - ] + "format": "date-time", + "readOnly": true } }, - "required": [ - "crossSelling", - "products", - "total", - "apiAlias" - ] + "type": "object" }, - "CartDelivery": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "Webhook": { + "description": "Added since version: 6.3.1.0", "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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" - } - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } - } + }, + "type": "object" }, "ShippingMethodPageRouteResponse": { "type": "array", @@ -14473,73 +14619,259 @@ } } }, - "CartDeliveryPosition": { + "NavigationRouteResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "CartPriceReference": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { "type": "object", "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "price": { + "type": "number" }, - "latest": { + "apiAlias": { "type": "string", - "format": "date-time" + "enum": [ + "cart_regulation_price" + ] } - } - }, - "identifier": { - "type": "string" + }, + "nullable": true }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "hasRange": { + "type": "boolean" }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true } - } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] }, - "CustomerAddressRead": { + "ProductDetailResponse": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "product": { + "$ref": "#/components/schemas/Product" }, - "customerId": { + "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" + ] + }, + "CustomerAddressBody": { + "description": "Added since version: 6.0.0.0", + "required": [ + "countryId", + "firstName", + "lastName", + "city", + "street" + ], + "properties": { + "countryId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "countryStateId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "salutationId": { "type": "string", - "format": "date-time", - "nullable": true + "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", - "nullable": true + "$ref": "#/components/schemas/CountryState" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, + "type": "object" + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" + } + }, "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" + "name", + "type", + "field" + ] + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "SuccessResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" ] }, "EntitySearchResult": { @@ -14569,467 +14901,408 @@ } } }, - "Sitemap": { + "ProductListingFlags": { "type": "object", + "description": "Additional flags for product listings", "properties": { - "filename": { - "type": "string" + "no-aggregations": { + "description": "Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.", + "type": "string", + "nullable": true }, - "created": { + "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", - "format": "date-time" - } - }, - "required": [ - "filename", - "created" - ] - }, - "SuccessResponse": { - "type": "object", - "properties": { - "success": { - "type": "boolean" + "nullable": true } } }, - "Criteria": { + "Cart": { "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", + "name": { + "description": "Name of the cart - for example `guest-cart`", "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": { - "type": "array", - "description": "List of ids to search for", - "items": { - "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" - } - }, - "associations": { - "$ref": "#/components/schemas/Associations" - }, - "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" - } - ] - } + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" - } + "price": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "aggregations": { + "lineItems": { + "description": "All items within the cart", "type": "array", "items": { - "$ref": "#/components/schemas/Aggregation" + "$ref": "#/components/schemas/LineItem" } }, - "fields": { + "errors": { "type": "array", - "description": "Fields which should be returned in the search result.", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { - "type": "string", - "description": "Name of a field" + "$ref": "#/components/schemas/CartError" } }, - "grouping": { + "deliveries": { "type": "array", - "description": "Perform groupings over certain fields", "items": { - "type": "string", - "description": "Name of a field" - } - }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" - }, - "includes": { - "$ref": "#/components/schemas/Includes" - } - } - }, - "Associations": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Criteria" - } - }, - "Includes": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "Aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "title": "AggregationEntity", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationFilter", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationTerms", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationHistogram", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationHistogram" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationRange", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationRange" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - } - ] - }, - "SubAggregations": { - "type": "object", - "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/AggregationHistogram" - }, - { - "$ref": "#/components/schemas/AggregationRange" - } - ] - } - } - }, - "TotalCountMode": { - "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", - "type": "string", - "default": "none", - "enum": [ - "none", - "exact", - "next-pages" - ] - }, - "Query": { - "type": "object", - "properties": { - "score": { - "type": "number" + "$ref": "#/components/schemas/CartDelivery" + } }, - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", + "type": "array", + "items": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" + }, + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" + } } - ] + } + }, + "modified": { + "type": "boolean" + }, + "customerComment": { + "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 } - }, - "additionalProperties": true + } }, - "Sort": { + "CartPriceQuantity": { "type": "object", "properties": { - "field": { - "type": "string" - }, - "order": { + "apiAlias": { "type": "string", "enum": [ - "ASC", - "DESC" + "cart_price_quantity" ] }, - "naturalSorting": { + "isCalculated": { "type": "boolean" }, + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + }, "type": { "type": "string" } }, "required": [ - "field", - "order" + "apiAlias" ] }, - "Filters": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity" + ] }, - "SimpleFilter": { + "LineItem": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" - ] + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "field": { + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "dataContextHash": { "type": "string" }, - "value": { + "dataTimestamp": { "type": "string" - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "EqualsFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "equals" - ] }, - "field": { + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { "type": "string" }, - "value": { - "oneOf": [ - { - "type": "string" + "good": { + "type": "boolean" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "$ref": "#/components/schemas/ProductJsonApi" + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true }, - { + "totalPrice": { "type": "number" }, - { - "type": "boolean" + "unitPrice": { + "type": "number" }, - { - "type": "null" + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } - ] - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "MultiNotFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "multi", - "not" - ] - }, - "operator": { - "type": "string", - "enum": [ - "and", - "or", - "nor", - "nand" + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" ] }, - "queries": { - "$ref": "#/components/schemas/Filters" - } - }, - "required": [ - "type", - "operator", - "queries" - ] - }, - "RangeFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "range" - ] + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" }, - "field": { - "type": "string" + "quantity": { + "type": "number" }, - "parameters": { + "quantityInformation": { "type": "object", "properties": { - "gte": { - "type": "number" - }, - "gt": { + "maxPurchase": { "type": "number" }, - "lte": { + "minPurchase": { "type": "number" }, - "lt": { + "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": [ - "type", - "field", - "parameters" + "id", + "type" ] }, - "CartPriceReference": { + "CalculatedPrice": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "purchaseUnit": { + "unitPrice": { "type": "number" }, - "referenceUnit": { + "quantity": { "type": "number" }, - "unitName": { - "type": "string" + "rawTotal": { + "type": "number" }, - "price": { + "totalPrice": { "type": "number" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" + "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" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } ] }, "listPrice": { @@ -15042,6 +15315,12 @@ } ] }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, "regulationPrice": { "type": "object", "properties": { @@ -15064,6 +15343,28 @@ "type": "string", "format": "^[0-9a-f]{32}$", "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, "required": [ @@ -15071,710 +15372,795 @@ "hasRange", "regulationPrice", "listPrice", + "referencePrice", "calculatedTaxes", "totalPrice", "quantity", - "unitName" + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" ] }, - "CartPriceQuantity": { + "FindProductVariantRouteResponse": { "type": "object", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_quantity" - ] - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" + "foundCombination": { + "type": "object", + "properties": { + "variantId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "options": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "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" }, - "quantity": { - "type": "number" + "term": { + "description": "Search term", + "type": "string" }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "taxRules": { + "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": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "name": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - } + ] } }, - "type": { - "type": "string" - } - }, - "required": [ - "apiAlias" - ] - }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" - ] - }, - "LineItem": { - "type": "object", - "properties": { - "children": { + "ids": { "type": "array", + "description": "List of ids to search for", "items": { - "$ref": "#/components/schemas/LineItem" + "type": "string" } }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" + "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" + } }, - "dataContextHash": { - "type": "string" + "associations": { + "$ref": "#/components/schemas/Associations" }, - "dataTimestamp": { - "type": "string" + "post-filter": { + "type": "array", + "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "$ref": "#/components/schemas/Sort" + } }, - "description": { - "type": "string" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } }, - "good": { - "type": "boolean" + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "id": { - "type": "string" + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "label": { - "type": "string" + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" }, - "modified": { - "type": "boolean" + "includes": { + "$ref": "#/components/schemas/Includes" + } + } + }, + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Includes": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "modifiedByApp": { - "type": "boolean" + { + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] }, - "price": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "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" - ] - } + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" }, - "quantity": { - "type": "number" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + { + "$ref": "#/components/schemas/AggregationEntity" }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true + { + "$ref": "#/components/schemas/AggregationFilter" }, - "totalPrice": { - "type": "number" + { + "$ref": "#/components/schemas/AggregationTerms" }, - "unitPrice": { - "type": "number" + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "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/AggregationRange" } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { + } + } + }, + "TotalCountMode": { + "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", + "type": "string", + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" + ] + }, + "Query": { + "type": "object", + "properties": { + "score": { "type": "number" }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" + "query": { + "oneOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "minPurchase": { - "type": "number" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "purchaseSteps": { - "type": "number" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - } - }, - "referencedId": { + ] + } + }, + "additionalProperties": true + }, + "Sort": { + "type": "object", + "properties": { + "field": { "type": "string" }, - "removable": { - "type": "boolean" + "order": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] }, - "stackable": { + "naturalSorting": { "type": "boolean" }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } - }, "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { "type": "string" } }, "required": [ - "id", - "type" + "field", + "order" ] }, - "AggregationMetrics": { + "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": { - "name": { + "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": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" + "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", + "or", + "nor", + "nand" + ] + }, + "queries": { + "$ref": "#/components/schemas/Filters" } }, "required": [ - "name", "type", - "field" + "operator", + "queries" ] }, - "CartError": { + "RangeFilter": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "items": { + "type": { + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "type": "string" + }, + "parameters": { "type": "object", "properties": { - "key": { - "type": "string" + "gte": { + "type": "number" }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + "gt": { + "type": "number" }, - "message": { - "type": "string" + "lte": { + "type": "number" }, - "messageKey": { - "type": "string" + "lt": { + "type": "number" } } } - } + }, + "required": [ + "type", + "field", + "parameters" + ] }, - "ProductDetailResponse": { + "CartItems": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "product": { - "$ref": "#/components/schemas/Product" - }, - "configurator": { + "items": { "type": "array", - "description": "List of property groups with their corresponding options and information on how to display them.", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/LineItem" } } - }, - "required": [ - "product" - ] - }, - "NavigationRouteResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" } }, - "Cart": { + "CartDeliveryPosition": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" - }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } - }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", - "type": "array", - "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" } } }, - "modified": { - "type": "boolean" - }, - "customerComment": { - "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true + "identifier": { + "type": "string" }, - "affiliateCode": { - "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "lineItem": { + "$ref": "#/components/schemas/LineItem" }, - "campaignCode": { - "type": "string", - "description": "A campaign tracking code", - "nullable": true + "price": { + "$ref": "#/components/schemas/CalculatedPrice" } } }, - "AccountNewsletterRecipient": { + "AggregationEntity": { + "title": "AggregationEntity", "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "undefined", - "notSet", - "direct", - "optIn", - "optOut" - ] + "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": [ - "account_newsletter_recipient" + "entity" ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" } }, "required": [ - "status", - "apiAlias" + "name", + "type", + "field", + "definition" ] }, - "OrderRouteResponse": { + "AggregationFilter": { + "title": "AggregationFilter", "type": "object", "properties": { - "orders": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - }, - { - "$ref": "#/components/schemas/EntitySearchResult" - } + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "filter" ] }, - "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" + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" } } }, "required": [ - "orders" + "name", + "type", + "filter" ] }, - "ProductListingFlags": { + "AggregationTerms": { + "title": "AggregationTerms", "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 + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "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": { + "description": "The type of aggregation", "type": "string", - "nullable": true + "enum": [ + "terms" + ] + }, + "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": [ + "name", + "type", + "field" + ] }, - "CartDeliveryInformation": { + "AggregationHistogram": { + "title": "AggregationHistogram", "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" + "histogram" ] }, - "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" + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "stock": { - "type": "integer" + "interval": { + "description": "The interval of the histogram", + "type": "number" }, - "weight": { - "type": "integer" + "format": { + "description": "The format of the histogram", + "type": "string" }, - "width": { - "type": "integer" + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" } }, "required": [ - "apiAlias" + "name", + "type", + "field" ] }, - "WishlistLoadRouteResponse": { + "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": { - "wishlist": { - "type": "object", - "properties": { - "customerId": { - "type": "string" - }, - "salesChannelId": { - "type": "string" - } - } + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "products": { - "$ref": "#/components/schemas/ProductListingResult" - } - } - }, - "ProductListingResult": { - "allOf": [ - { - "$ref": "#/components/schemas/EntitySearchResult" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "range" + ] }, - { - "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 - } + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "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" }, - "required": [ - "min", - "max" - ] - }, - "rating": { - "type": "integer", - "nullable": true - }, - "shipping-free": { - "type": "boolean", - "default": false + "to": { + "type": "number", + "description": "The upper bound of the range" + } }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", "properties": { - "type": "array", - "items": { + "from": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "The lower bound of the range" } }, - "search": { - "type": "string" - } + "required": [ + "from" + ] }, - "required": [ - "manufacturer", - "navigationId", - "price", - "properties", - "rating", - "shipping-free" - ] - }, - "availableSortings": { - "type": "array", - "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", - "items": { + { "type": "object", + "title": "To only", "properties": { - "label": { - "type": "string" - }, - "translated": { - "type": "object", - "properties": { - "label": { - "type": "string" - } - }, - "required": [ - "label" - ] - }, - "key": { - "type": "string" - }, - "priority": { - "type": "number" - }, - "apiAlias": { + "to": { "type": "string", - "enum": [ - "product_sorting" - ] + "description": "The upper bound of the range" } }, - "required": [ - "label", - "translated", - "key", - "priority", - "apiAlias" - ] - } - }, - "sorting": { - "type": "string" - }, - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "entity": { - "type": "string", - "enum": [ - "product" - ] - }, - "apiAlias": { - "type": "string", - "enum": [ - "product_listing" - ] - } - }, - "required": [ - "elements", - "availableSortings", - "currentFilters", - "apiAlias" + "required": [ + "to" + ] + } + ] + } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AccountNewsletterRecipient": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "undefined", + "notSet", + "direct", + "optIn", + "optOut" + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "account_newsletter_recipient" + ] + } + }, + "required": [ + "status", + "apiAlias" + ] + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "CrossSellingElementCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CrossSellingElement" + } + }, + "CrossSellingElement": { + "type": "object", + "properties": { + "crossSelling": { + "$ref": "#/components/schemas/ProductCrossSelling" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "total": { + "type": "integer", + "format": "int32" + }, + "streamId": { + "type": "string", + "format": "uuid" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cross_selling_element" ] } + }, + "required": [ + "crossSelling", + "products", + "total", + "apiAlias" ] }, "Price": { @@ -15856,294 +16242,385 @@ "net" ] }, - "SalesChannelContext": { + "Breadcrumb": { "type": "object", "properties": { - "token": { - "description": "Context the user session", + "name": { "type": "string" }, - "currentCustomerGroup": { - "type": "object", - "description": "Customer group of the current user", - "properties": { - "name": { - "type": "string" - }, - "displayGross": { - "type": "boolean" - } - } - }, - "fallbackCustomerGroup": { - "description": "Fallback group if the default customer group is not applicable", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayGross": { - "type": "boolean" - } - } + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "currency": { - "$ref": "#/components/schemas/Currency" + "type": { + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, - "salesChannel": { - "description": "Information about the current sales channel", + "translated": { "type": "object", + "additionalProperties": true, "properties": { - "typeId": { - "type": "string" - }, - "languageId": { - "type": "string" - }, - "currencyId": { - "type": "string" + "customFields": { + "type": "object" }, - "paymentMethodId": { - "type": "string" + "slotConfig": { + "type": "object" }, - "shippingMethodId": { - "type": "string" + "linkType": { + "type": "string", + "enum": [ + "external", + "category", + "product", + "landing_page" + ] }, - "countryId": { + "internalLink": { "type": "string" }, - "navigationCategoryId": { + "externalLink": { "type": "string" }, - "navigationCategoryDepth": { - "type": "integer", - "format": "int32" - }, - "footerCategoryId": { - "type": "string" + "linkNewTab": { + "type": "boolean" }, - "serviceCategoryId": { + "description": { "type": "string" }, - "name": { + "metaTitle": { "type": "string" }, - "shortName": { + "metaDescription": { "type": "string" }, - "accessKey": { + "keywords": { "type": "string" - }, - "active": { - "type": "boolean" - }, - "maintenance": { - "type": "boolean" - }, - "maintenanceIpWhitelist": { + } + } + }, + "path": { + "type": "string" + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "breadcrumb" + ] + } + }, + "required": [ + "name", + "categoryId", + "type", + "translated", + "path", + "apiAlias" + ] + }, + "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" }, - "mailHeaderFooterId": { - "type": "string" + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" }, - "customerGroupId": { + "message": { "type": "string" }, - "hreflangActive": { - "type": "boolean" - }, - "hreflangDefaultDomainId": { + "messageKey": { "type": "string" + } + } + } + } + }, + "OrderRouteResponse": { + "type": "object", + "properties": { + "orders": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } }, - "analyticsId": { - "type": "string" + { + "$ref": "#/components/schemas/EntitySearchResult" } - } + ] }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "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" + ] + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "freeDelivery": { + "type": "boolean" }, - "shippingLocation": { + "deliveryTime": { "type": "object", "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, "apiAlias": { "type": "string", "enum": [ - "cart_delivery_shipping_location" + "cart_delivery_time" ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" } } }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "height": { + "type": "integer" }, - "context": { - "description": "Core context with general configuration values and state", + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" + } + }, + "required": [ + "apiAlias" + ] + }, + "CustomerAddressRead": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState", + "nullable": true + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "required": [ + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" + ] + }, + "ProductListingResult": { + "allOf": [ + { + "$ref": "#/components/schemas/EntitySearchResult" + }, + { "type": "object", "properties": { - "versionId": { - "type": "string" - }, - "currencyId": { - "type": "string" - }, - "currencyFactor": { - "type": "integer" - }, - "currencyPrecision": { - "type": "integer", - "format": "int32" + "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" + ] }, - "languageIdChain": { + "availableSortings": { "type": "array", + "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", "items": { - "type": "string" + "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" + ] } }, - "scope": { + "sorting": { "type": "string" }, - "source": { - "type": "string" + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "taxState": { - "type": "string" + "entity": { + "type": "string", + "enum": [ + "product" + ] }, - "useCache": { - "type": "boolean" + "apiAlias": { + "type": "string", + "enum": [ + "product_listing" + ] } - } - } - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - } - } - }, - "CustomerAddressBody": { - "description": "Added since version: 6.0.0.0", - "required": [ - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "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" - }, - "title": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "additionalAddressLine1": { - "type": "string" - }, - "additionalAddressLine2": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" + }, + "required": [ + "elements", + "availableSortings", + "currentFilters", + "apiAlias" ] } - }, - "required": [ - "apiAlias" ] }, "ProductListingCriteria": { @@ -16189,324 +16666,321 @@ "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 + "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 + } + } + } + ] + }, + "SalesChannelContext": { + "type": "object", + "properties": { + "token": { + "description": "Context the user session", + "type": "string" + }, + "currentCustomerGroup": { + "type": "object", + "description": "Customer group of the current user", + "properties": { + "name": { + "type": "string" + }, + "displayGross": { + "type": "boolean" + } + } + }, + "fallbackCustomerGroup": { + "description": "Fallback group if the default customer group is not applicable", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayGross": { + "type": "boolean" + } + } + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "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" }, - "properties": { - "description": "Filters products by their properties. List of property identifiers separated by a `|`.", + "accessKey": { "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 + "active": { + "type": "boolean" }, - "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 + "maintenance": { + "type": "boolean" }, - "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 + "maintenanceIpWhitelist": { + "type": "string" }, - "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 + "mailHeaderFooterId": { + "type": "string" }, - "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 + "customerGroupId": { + "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.", + "hreflangActive": { + "type": "boolean" + }, + "hreflangDefaultDomainId": { "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 + "analyticsId": { + "type": "string" } } - } - ] - }, - "AggregationEntity": { - "title": "AggregationEntity", - "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": [ - "entity" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "definition": { - "description": "The entity definition e.g \"product_manufacturer\".", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field", - "definition" - ] - }, - "AggregationFilter": { - "title": "AggregationFilter", - "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": [ - "filter" - ] }, - "filter": { + "taxRules": { "type": "array", + "description": "Currently active tax rules and/or rates", "items": { - "$ref": "#/components/schemas/Filters" + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } } - } - }, - "required": [ - "name", - "type", - "filter" - ] - }, - "AggregationTerms": { - "title": "AggregationTerms", - "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" - ] + "customer": { + "$ref": "#/components/schemas/Customer" }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" }, - "limit": { - "description": "The number of terms to return", - "type": "number" + "shippingLocation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + } + } }, - "sort": { - "type": "array", - "description": "Sorting the aggregation result.", - "items": { - "$ref": "#/components/schemas/Sort" + "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" + } } } - }, - "required": [ - "name", - "type", - "field" - ] + } }, - "AggregationHistogram": { - "title": "AggregationHistogram", + "WishlistLoadRouteResponse": { "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": [ - "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": [ - "name", - "type", - "field" - ] + "wishlist": { + "type": "object", + "properties": { + "customerId": { + "type": "string" + }, + "salesChannelId": { + "type": "string" + } + } + }, + "products": { + "$ref": "#/components/schemas/ProductListingResult" + } + } }, - "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)", + "Sitemap": { "type": "object", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + "filename": { "type": "string" }, - "type": { - "description": "The type of aggregation", + "created": { "type": "string", - "enum": [ - "range" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "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" - ] - } - ] - } + "format": "date-time" } }, "required": [ - "name", - "type", - "field", - "ranges" - ] - }, - "NavigationType": { - "type": "string", - "enum": [ - "main-navigation", - "footer-navigation", - "service-navigation" + "filename", + "created" ] }, - "NaturalLanguageSearchTermResponse": { + "SearchByImageSearchTermResponse": { "type": "array", "items": { "type": "object", "required": [ "term", - "reason", "apiAlias" ], "properties": { "term": { "type": "string" }, - "reason": { - "type": "string" - }, "apiAlias": { "type": "string", "enum": [ - "product_natural_language_search_term" + "product_image_upload_search_term" ] + }, + "extensions": { + "type": "array", + "items": { + "type": "object" + } } } } }, - "SearchByImageSearchTermResponse": { + "NaturalLanguageSearchTermResponse": { "type": "array", "items": { "type": "object", "required": [ "term", + "reason", "apiAlias" ], "properties": { "term": { "type": "string" }, + "reason": { + "type": "string" + }, "apiAlias": { "type": "string", "enum": [ - "product_image_upload_search_term" + "product_natural_language_search_term" ] - }, - "extensions": { - "type": "array", - "items": { - "type": "object" - } } } } @@ -16793,30 +17267,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": { @@ -17005,6 +17455,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": { @@ -17050,14 +17524,14 @@ } ], "paths": { - "/role/create": { + "/employee/create": { "post": { "tags": [ "B2B Employee Management" ], - "summary": "Create a single role and return the role", - "description": "This route is used to create and return an role", - "operationId": "createRole", + "summary": "Create a single employee and return the employee", + "description": "This route is used to create and return an employee", + "operationId": "createEmployee", "parameters": [], "requestBody": { "required": true, @@ -17065,22 +17539,35 @@ "application/json": { "schema": { "properties": { - "name": { - "description": "Name of the new role", + "firstName": { + "description": "First name of the new employee", "type": "string" }, - "permissions": { - "description": "Permissions of the new role", - "type": "array", - "items": { - "type": "string" - } + "lastName": { + "description": "Last name of the new employee", + "type": "string" }, - "isDefaultRole": { - "description": "Ability to set the new role as default", - "type": "boolean" + "email": { + "description": "Email of the new employee", + "type": "string" + }, + "languageId": { + "description": "Identifier of the [language](#/System%20%26%20Context/readLanguages) to be set for the new employee.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "roleId": { + "description": "Id of the role of the new employee", + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, + "required": [ + "firstName", + "lastName", + "email", + "languageId" + ], "type": "object" } } @@ -17088,11 +17575,11 @@ }, "responses": { "200": { - "description": "Role entity", + "description": "Employee entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -17105,14 +17592,14 @@ ] } }, - "/role": { + "/employee": { "get": { "tags": [ "B2B Employee Management" ], - "summary": "Fetch a list of roles", - "description": "This route is used to load roles", - "operationId": "readRoles", + "summary": "Fetch a list of employees", + "description": "This route is used to load employees", + "operationId": "readEmployees", "parameters": [], "requestBody": { "required": false, @@ -17130,7 +17617,7 @@ }, "responses": { "200": { - "description": "Entity search result containing roles", + "description": "Entity search result containing employees", "content": { "application/json": { "schema": { @@ -17141,7 +17628,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } }, @@ -17166,9 +17653,9 @@ "tags": [ "B2B Employee Management" ], - "summary": "Fetch a list of roles", - "description": "This route is used to load roles", - "operationId": "readRolesPOST", + "summary": "Fetch a list of employees", + "description": "This route is used to load employees", + "operationId": "readEmployeesPOST", "parameters": [], "requestBody": { "required": false, @@ -17186,7 +17673,7 @@ }, "responses": { "200": { - "description": "Entity search result containing roles", + "description": "Entity search result containing employees", "content": { "application/json": { "schema": { @@ -17197,7 +17684,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } }, @@ -17219,19 +17706,19 @@ ] } }, - "/role/{id}": { + "/employee/{id}": { "get": { "tags": [ "B2B Employee Management" ], - "summary": "Fetch one role by id", - "description": "This route is used to fetch one role by id", - "operationId": "readRole", + "summary": "Fetch one employee by id", + "description": "This route is used to fetch one employee by id", + "operationId": "readEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the role to be fetched", + "description": "Identifier of the employee to be fetched", "required": true, "schema": { "type": "string", @@ -17241,11 +17728,11 @@ ], "responses": { "200": { - "description": "Role entity", + "description": "Employee entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -17261,14 +17748,14 @@ "tags": [ "B2B Employee Management" ], - "summary": "Update one role by id", - "description": "This route is used to update one role by id", - "operationId": "updateRole", + "summary": "Update one employee by id", + "description": "This route is used to update one employee by id", + "operationId": "updateEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the role to be updated", + "description": "Identifier of the employee to be updated", "required": true, "schema": { "type": "string", @@ -17282,20 +17769,21 @@ "application/json": { "schema": { "properties": { - "name": { - "description": "New name of the role", + "firstName": { + "description": "New first name of the employee", "type": "string" }, - "permissions": { - "description": "New permissions of the role", - "type": "array", - "items": { - "type": "string" - } + "lastName": { + "description": "New last name of the employee", + "type": "string" }, - "isDefaultRole": { - "description": "Ability to set the role as default", - "type": "boolean" + "email": { + "description": "New email of the employee", + "type": "string" + }, + "roleId": { + "description": "New id of the role of the employee", + "type": "string" } }, "type": "object" @@ -17305,11 +17793,11 @@ }, "responses": { "200": { - "description": "Role entity", + "description": "Employee entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -17325,14 +17813,14 @@ "tags": [ "B2B Employee Management" ], - "summary": "Delete one role by id", - "description": "This route is used to delete one role by id", - "operationId": "deleteRole", + "summary": "Delete one employee by id", + "description": "This route is used to delete one employee by id", + "operationId": "deleteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the role to be fetched", + "description": "Identifier of the employee to be deleted", "required": true, "schema": { "type": "string", @@ -17352,125 +17840,35 @@ ] } }, - "/role/default": { + "/employee/reinvite/{id}": { "post": { "tags": [ "B2B Employee Management" ], - "summary": "Sets the default role Id for new employees", - "description": "This route is used to update the defaultRoleId for new employees", - "operationId": "updateDefaultRoleId", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "description": "Id of the roleId to be set as default", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "No content response" - } - }, - "security": [ + "summary": "Reinvite employee by id", + "description": "This route is used to reinvite an employee via email by id", + "operationId": "reinviteEmployee", + "parameters": [ { - "ApiKey": [] - } - ] - } - }, - "/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" - } - ] - } - } + "name": "id", + "in": "path", + "description": "Identifier of the employee to be reinvited", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, - "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", + "storefrontUrl": { + "description": "URL of the storefront domain", "type": "string" - }, - "dependencies": { - "description": "Optional dependencies for the new permission", - "type": "array", - "items": { - "type": "string" - } } }, "type": "object" @@ -17478,44 +17876,13 @@ } } }, - "parameters": [], "responses": { "200": { - "description": "Permission collection", + "description": "Employee entity", "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" - } - ] + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -17528,14 +17895,14 @@ ] } }, - "/employee/create": { + "/role/create": { "post": { "tags": [ "B2B Employee Management" ], - "summary": "Create a single employee and return the employee", - "description": "This route is used to create and return an employee", - "operationId": "createEmployee", + "summary": "Create a single role and return the role", + "description": "This route is used to create and return an role", + "operationId": "createRole", "parameters": [], "requestBody": { "required": true, @@ -17543,35 +17910,22 @@ "application/json": { "schema": { "properties": { - "firstName": { - "description": "First name of the new employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the new employee", - "type": "string" - }, - "email": { - "description": "Email of the new employee", + "name": { + "description": "Name of the new role", "type": "string" }, - "languageId": { - "description": "Identifier of the [language](#/System%20%26%20Context/readLanguages) to be set for the new employee.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "permissions": { + "description": "Permissions of the new role", + "type": "array", + "items": { + "type": "string" + } }, - "roleId": { - "description": "Id of the role of the new employee", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isDefaultRole": { + "description": "Ability to set the new role as default", + "type": "boolean" } }, - "required": [ - "firstName", - "lastName", - "email", - "languageId" - ], "type": "object" } } @@ -17579,11 +17933,11 @@ }, "responses": { "200": { - "description": "Employee entity", + "description": "Role entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -17596,14 +17950,14 @@ ] } }, - "/employee": { + "/role": { "get": { "tags": [ "B2B Employee Management" ], - "summary": "Fetch a list of employees", - "description": "This route is used to load employees", - "operationId": "readEmployees", + "summary": "Fetch a list of roles", + "description": "This route is used to load roles", + "operationId": "readRoles", "parameters": [], "requestBody": { "required": false, @@ -17621,7 +17975,7 @@ }, "responses": { "200": { - "description": "Entity search result containing employees", + "description": "Entity search result containing roles", "content": { "application/json": { "schema": { @@ -17632,7 +17986,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } }, @@ -17657,9 +18011,9 @@ "tags": [ "B2B Employee Management" ], - "summary": "Fetch a list of employees", - "description": "This route is used to load employees", - "operationId": "readEmployeesPOST", + "summary": "Fetch a list of roles", + "description": "This route is used to load roles", + "operationId": "readRolesPOST", "parameters": [], "requestBody": { "required": false, @@ -17677,7 +18031,7 @@ }, "responses": { "200": { - "description": "Entity search result containing employees", + "description": "Entity search result containing roles", "content": { "application/json": { "schema": { @@ -17688,7 +18042,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } }, @@ -17710,19 +18064,19 @@ ] } }, - "/employee/{id}": { - "post": { + "/role/{id}": { + "get": { "tags": [ "B2B Employee Management" ], - "summary": "Fetch a one employee by id", - "description": "This route is used to fetch one employee by id", - "operationId": "readEmployee", + "summary": "Fetch one role by id", + "description": "This route is used to fetch one role by id", + "operationId": "readRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be fetched", + "description": "Identifier of the role to be fetched", "required": true, "schema": { "type": "string", @@ -17732,11 +18086,11 @@ ], "responses": { "200": { - "description": "Employee entity", + "description": "Role entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -17752,14 +18106,14 @@ "tags": [ "B2B Employee Management" ], - "summary": "Update one employee by id", - "description": "This route is used to update one employee by id", - "operationId": "updateEmployee", + "summary": "Update one role by id", + "description": "This route is used to update one role by id", + "operationId": "updateRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be updated", + "description": "Identifier of the role to be updated", "required": true, "schema": { "type": "string", @@ -17773,21 +18127,20 @@ "application/json": { "schema": { "properties": { - "firstName": { - "description": "New first name of the employee", - "type": "string" - }, - "lastName": { - "description": "New last name of the employee", + "name": { + "description": "New name of the role", "type": "string" }, - "email": { - "description": "New email of the employee", - "type": "string" + "permissions": { + "description": "New permissions of the role", + "type": "array", + "items": { + "type": "string" + } }, - "roleId": { - "description": "New id of the role of the employee", - "type": "string" + "isDefaultRole": { + "description": "Ability to set the role as default", + "type": "boolean" } }, "type": "object" @@ -17797,11 +18150,11 @@ }, "responses": { "200": { - "description": "Employee entity", + "description": "Role entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -17817,14 +18170,14 @@ "tags": [ "B2B Employee Management" ], - "summary": "Delete one employee by id", - "description": "This route is used to delete one employee by id", - "operationId": "deleteEmployee", + "summary": "Delete one role by id", + "description": "This route is used to delete one role by id", + "operationId": "deleteRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be deleted", + "description": "Identifier of the role to be fetched", "required": true, "schema": { "type": "string", @@ -17844,35 +18197,125 @@ ] } }, - "/employee/reinvite/{id}": { + "/role/default": { "post": { "tags": [ "B2B Employee Management" ], - "summary": "Reinvite employee by id", - "description": "This route is used to reinvite an employee via email by id", - "operationId": "reinviteEmployee", - "parameters": [ + "summary": "Sets the default role Id for new employees", + "description": "This route is used to update the defaultRoleId for new employees", + "operationId": "updateDefaultRoleId", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the roleId to be set as default", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + }, + "security": [ { - "name": "id", - "in": "path", - "description": "Identifier of the employee to be reinvited", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "ApiKey": [] + } + ] + } + }, + "/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": { - "storefrontUrl": { - "description": "URL of the storefront domain", + "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" @@ -17880,13 +18323,44 @@ } } }, + "parameters": [], "responses": { "200": { - "description": "Employee entity", + "description": "Permission collection", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "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" + } + ] } } } @@ -18363,15 +18837,62 @@ ] } }, + "/quote/{id}/send-message": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Send a message to the merchant in the quote", + "description": "This route is used to send a message to the merchant in the quote", + "operationId": "sendMessageInQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier of the quote to be reinvited", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { + "description": "Message content", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + }, "/product/natural-language/search-term": { "post": { "tags": [ "Natural language search", - "AI Search", - "Experimental" + "AI Search" ], "summary": "Fetch search terms by natural language search query", - "description": "Experimental until v6.7.0\n\nFetch search terms by natural search language query", + "description": "Fetch search terms by natural search language query", "operationId": "naturalLanguageSearchTerm", "requestBody": { "required": true, @@ -18408,11 +18929,10 @@ "post": { "tags": [ "Search by Image", - "AI Search", - "Experimental" + "AI Search" ], "summary": "Fetch product search terms by uploading an image.", - "description": "Experimental until v6.7.0\n\nFetch product search terms by uploading an image.", + "description": "Fetch product search terms by uploading an image.", "operationId": "searchByImageSearchTerm", "requestBody": { "required": true, diff --git a/SwagCommercial-storeapi.summary.json b/SwagCommercial-storeapi.summary.json index 318fb70..3f33f2c 100644 --- a/SwagCommercial-storeapi.summary.json +++ b/SwagCommercial-storeapi.summary.json @@ -22,6 +22,7 @@ "/quote/{id}/configure", "/quote/{id}/decline", "/quote/{id}/request-change", + "/quote/{id}/send-message", "/quotes", "/role", "/role/create", @@ -239,6 +240,7 @@ "QuoteDeliveryPosition", "QuoteDocument", "QuoteEmployee", + "QuoteJsonApi", "QuoteLineItem", "QuoteTransaction", "RangeFilter",