From beddb3d37452c0721676eb0f5fa1e9e28e1cdbda Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Mon, 17 Mar 2025 09:06:38 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagCommercial-storeapi.json | 10611 ++++++++++++++----------- SwagCommercial-storeapi.summary.json | 7 + 2 files changed, 5917 insertions(+), 4701 deletions(-) diff --git a/SwagCommercial-storeapi.json b/SwagCommercial-storeapi.json index 975303b..9e27fdf 100644 --- a/SwagCommercial-storeapi.json +++ b/SwagCommercial-storeapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "info": { "title": "Shopware Store API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Store API", @@ -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": [ { @@ -910,6 +910,136 @@ }, "type": "object" }, + "B2bComponentsOrganization": { + "required": [ + "id", + "name", + "customerId", + "defaultShippingAddressId", + "defaultBillingAddressId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "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 + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "employees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "organizationCustomerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "B2bComponentsOrganizationCustomerAddress": { + "required": [ + "id", + "organizationId", + "customerAddressId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customerAddress": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "type": "object" + }, "B2bComponentsPendingOrder": { "description": "Added since version: 6.6.0.0", "required": [ @@ -1207,6 +1337,10 @@ "customFields": { "type": "object" }, + "default": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -1282,6 +1416,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "customer": { @@ -1438,6 +1606,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "customer": { "$ref": "#/components/schemas/Customer" }, @@ -1598,9 +1800,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" - }, "firstName": { "type": "string" }, @@ -1613,6 +1812,9 @@ "customFields": { "type": "object" }, + "status": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -2037,6 +2239,7 @@ "children", "childCount", "translated", + "type", "id", "name" ], @@ -2095,7 +2298,11 @@ "readOnly": true }, "type": { - "type": "string" + "type": "string", + "enum": [ + "page", + "link" + ] }, "productAssignmentType": { "type": "string" @@ -2233,6 +2440,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { "type": "integer", "format": "int64" @@ -2292,14 +2507,6 @@ "customFields": { "type": "object" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -2423,12 +2630,20 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { "type": "integer", "format": "int64" }, "type": { - "type": "string" + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "name": { "type": "string" @@ -2473,10 +2688,6 @@ "customFields": { "type": "object" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -2511,6 +2722,7 @@ "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": [ + "apiAlias", "id", "type", "slot", @@ -2525,6 +2737,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { "type": "string" }, @@ -2548,13 +2767,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -2570,6 +2782,12 @@ }, "block": { "$ref": "#/components/schemas/CmsBlock" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cms_slot" + ] } }, "type": "object" @@ -3366,8 +3584,7 @@ "customerNumber", "firstName", "lastName", - "email", - "defaultPaymentMethodId" + "email" ], "properties": { "id": { @@ -3493,10 +3710,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -3577,9 +3790,6 @@ "$ref": "#/components/schemas/Tag" } }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, "apiAlias": { "type": "string", "enum": [ @@ -3694,6 +3904,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -3707,18 +3921,54 @@ "format": "date-time", "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, + "extensions": { + "properties": { + "organizationCustomerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization_customer_address" + }, + "id": { + "type": "string", + "example": "ada6a19a929bea8dbec29edb3d68df58" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ @@ -3978,7 +4228,6 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", "deepLinkCode" @@ -3992,9 +4241,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -4007,6 +4253,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 +4318,12 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "fileType": { + "type": "string" } }, "type": "object" @@ -5162,7 +5418,17 @@ }, "metaData": { "type": "object", - "readOnly": true + "readOnly": true, + "properties": { + "height": { + "type": "integer", + "format": "int64" + }, + "width": { + "type": "integer", + "format": "int64" + } + } }, "config": { "type": "object" @@ -5627,6 +5893,7 @@ "documents", "orderDate", "stateMachineState", + "price", "id", "billingAddressId", "currencyId", @@ -5710,7 +5977,8 @@ "type": "string" } }, - "type": "object" + "type": "object", + "$ref": "#/components/schemas/CalculatedPrice" }, "amountTotal": { "type": "number", @@ -5895,6 +6163,37 @@ }, "type": "object" }, + "orderEmployee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_order_employee" + }, + "id": { + "type": "string", + "example": "5ea451c08a87db806089c4031601c29a" + } + } + } + } + }, + "type": "object" + }, "quote": { "properties": { "links": { @@ -5923,6 +6222,35 @@ } }, "type": "object" + }, + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -6044,6 +6372,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -7607,6 +7939,7 @@ { "required": [ "id", + "technicalName", "name" ], "properties": { @@ -7641,38 +7974,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "synchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "asynchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "prepared": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "refundable": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "recurring": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7729,6 +8037,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "name" ], "properties": { @@ -7763,38 +8072,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "synchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "asynchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "prepared": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "refundable": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "recurring": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7844,7 +8128,46 @@ "description": "Added since version: 6.0.0.0", "allOf": [ { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/resource", + "required": [ + "options" + ], + "properties": { + "options": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group", + "option", + "translated" + ], + "properties": { + "group": { + "type": "string" + }, + "option": { + "type": "string" + }, + "translated": { + "type": "object", + "properties": { + "group": { + "type": "string" + }, + "option": { + "type": "string" + } + }, + "required": [ + "group", + "option" + ] + } + } + } + } + } }, { "required": [ @@ -8877,6 +9200,7 @@ "calculatedPrice", "calculatedPrices", "seoCategory", + "translated", "id", "taxId", "productNumber", @@ -9143,71 +9467,75 @@ }, "calculatedCheapestPrice": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/CalculatedPrice" + "properties": { + "unitPrice": { + "type": "number" }, - { - "type": "object", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" + "quantity": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ReferencePrice" }, - "totalPrice": { - "type": "number" + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ListPrice" }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" + { + "type": "null" + } + ] + }, + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" } }, "required": [ "price" - ], - "nullable": true - }, - "hasRange": { - "type": "boolean" + ] }, - "variantId": { + { + "type": "null" + } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { "type": "string", - "format": "", - "nullable": true + "format": "" }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_cheapest_price" - ] + { + "type": "null" } - } + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_cheapest_price" + ] } - ] + } }, "isNew": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -9383,13 +9711,19 @@ ] }, "variantListingConfig": { - "nullable": true, - "type": "object", - "properties": { - "displayParent": { - "type": "boolean" + "oneOf": [ + { + "type": "object", + "properties": { + "displayParent": { + "type": "boolean" + } + } + }, + { + "type": "null" } - } + ] } }, "type": "object" @@ -9696,6 +10030,7 @@ "ProductMedia": { "description": "Added since version: 6.0.0.0", "required": [ + "media", "id", "productId", "mediaId" @@ -9740,9 +10075,6 @@ }, "media": { "$ref": "#/components/schemas/Media" - }, - "thumbnails": { - "$ref": "#/components/schemas/MediaThumbnail" } }, "type": "object" @@ -9827,6 +10159,12 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "customerId": { + "type": "string" + }, + "externalUser": { + "type": "string" } }, "type": "object" @@ -10263,6 +10601,7 @@ "required": [ "group", "option", + "translated", "id", "groupId", "name" @@ -10318,565 +10657,517 @@ }, "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" + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { "type": "number", "format": "float" } }, "type": "object" - } - }, - "type": "object" - }, - "discount": { - "properties": { - "type": { - "type": "string" }, - "value": { + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { "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 - }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteLineItem" - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDelivery" - } - }, - "transactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteTransaction" - } - }, - "comments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteComment" - } - }, - "documents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDocument" - } - } - }, - "type": "object" - }, - "QuoteComment": { - "required": [ - "id", - "comment", - "quoteId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "comment": { - "type": "string" - }, - "seenAt": { - "type": "string", - "format": "date-time" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - } - }, - "type": "object" - }, - "QuoteDelivery": { - "description": "Added since version: 6.5.3.0", - "required": [ - "id", - "quoteId", - "shippingMethodId", - "shippingDateEarliest", - "shippingDateLatest" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingDateEarliest": { - "type": "string", - "format": "date-time" - }, - "shippingDateLatest": { - "type": "string", - "format": "date-time" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { + "format": "float", + "readOnly": true + }, + "amountNet": { "type": "number", - "format": "float" + "format": "float", + "readOnly": true }, - "totalPrice": { + "subtotalNet": { "type": "number", "format": "float" }, - "quantity": { - "type": "integer", - "format": "int64" + "totalDiscount": { + "type": "number", + "format": "float" }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { + "customFields": { "type": "object" }, - "referencePrice": { - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "regulationPrice": { + "extensions": { "properties": { - "price": { - "type": "number", - "format": "float" + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" } }, "type": "object" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" - } - } - }, - "type": "object" - }, - "QuoteDeliveryPosition": { - "description": "Added since version: 6.5.3.0", - "required": [ - "id", - "quoteDeliveryId", - "quoteLineItemId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteDeliveryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteLineItemId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "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": { + "relationships": { "properties": { - "price": { - "type": "number", - "format": "float" + "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" }, - "discount": { - "type": "number", - "format": "float" + "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" }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "QuoteDocument": { - "required": [ - "id", - "documentTypeId", - "fileType", - "quoteId", - "config", - "deepLinkCode" + "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": { @@ -10887,286 +11178,95 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentNumber": { - "type": "string" - }, - "documentTypeId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, - "quoteId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteVersionId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" - }, - "sent": { - "type": "boolean" - }, - "static": { - "type": "boolean" - }, - "active": { - "type": "boolean" - }, - "deepLinkCode": { - "type": "string" - }, - "documentMediaFileId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, - "createdAt": { + "salesChannelId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "createdById": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quote": { - "$ref": "#/components/schemas/Quote" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "QuoteEmployee": { - "required": [ - "firstName", - "lastName" - ], - "properties": { - "id": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "lastName": { + "quoteNumber": { "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "QuoteLineItem": { - "description": "Added since version: 6.5.3.0", - "required": [ - "id", - "quoteId", - "identifier", - "children", - "states", - "label", - "quantity", - "position" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { - "type": "string" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "expirationDate": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "productVersionId": { + "sentAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" - }, - "payload": { - "type": "object" - }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "priceDefinition": { - "type": "object" - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "purchasePrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "format": "date-time" }, - "discount": { + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], "properties": { - "type": { - "type": "string" + "netPrice": { + "type": "number", + "format": "float" }, - "value": { - "type": "integer", - "format": "int64" + "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" }, - "good": { - "type": "boolean" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "referencedId": { - "type": "string" - }, - "coverId": { - "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 - }, - "parent": { - "$ref": "#/components/schemas/QuoteLineItem" - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteLineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/Media" - }, - "deliveryPositions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" - } - } - }, - "type": "object" - }, - "QuoteTransaction": { - "description": "Added since version: 6.5.3.0", - "required": [ - "id", - "quoteId", - "paymentMethodId", - "amount" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "amount": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -11223,40 +11323,39 @@ }, "type": "object" }, - "customFields": { + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + } + }, "type": "object" }, - "createdAt": { + "taxStatus": { "type": "string", - "format": "date-time", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "amountTotal": { + "type": "number", + "format": "float", "readOnly": true }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - } - }, - "type": "object" - }, - "Rule": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true }, - "name": { - "type": "string" + "subtotalNet": { + "type": "number", + "format": "float" }, - "description": { - "type": "string" + "totalDiscount": { + "type": "number", + "format": "float" }, "customFields": { "type": "object" @@ -11273,7 +11372,7 @@ }, "extensions": { "properties": { - "warehouseGroup": { + "organization": { "properties": { "links": { "type": "object", @@ -11281,23 +11380,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "1768e3071b62161d415e0c24332055ed" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" } } } @@ -11306,130 +11403,205 @@ } }, "type": "object" - } - }, - "type": "object" - }, - "RuleCondition": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + }, + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } } }, "type": "object" }, - "SalesChannel": { - "description": "Added since version: 6.0.0.0", + "QuoteComment": { "required": [ "id", - "languageId", - "customerGroupId", - "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "name", - "homeEnabled" + "comment", + "quoteId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "comment": { + "type": "string" }, - "currencyId": { + "seenAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "paymentMethodId": { + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "navigationCategoryId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "navigationCategoryVersionId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "navigationCategoryDepth": { - "type": "integer", - "format": "int64" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "footerCategoryId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "footerCategoryVersionId": { + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + } + }, + "type": "object" + }, + "QuoteDelivery": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "quoteId", + "shippingMethodId", + "shippingDateEarliest", + "shippingDateLatest" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "serviceCategoryId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "serviceCategoryVersionId": { + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailHeaderFooterId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hreflangDefaultDomainId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string" + "shippingDateEarliest": { + "type": "string", + "format": "date-time" }, - "taxCalculationType": { - "type": "string" + "shippingDateLatest": { + "type": "string", + "format": "date-time" }, - "configuration": { + "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" }, - "active": { - "type": "boolean" - }, - "hreflangActive": { - "type": "boolean" - }, - "maintenance": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -11443,52 +11615,122 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "domains": { + "positions": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } - }, - "navigationCategory": { - "$ref": "#/components/schemas/Category" - }, - "footerCategory": { - "$ref": "#/components/schemas/Category" - }, - "serviceCategory": { - "$ref": "#/components/schemas/Category" - }, - "hreflangDefaultDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" } }, "type": "object" }, - "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "QuoteDeliveryPosition": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "quoteDeliveryId", + "quoteLineItemId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "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" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11502,42 +11744,64 @@ }, "type": "object" }, - "SalesChannelDomain": { - "description": "Added since version: 6.0.0.0", + "QuoteDocument": { "required": [ "id", - "url", - "salesChannelId", - "languageId", - "currencyId", - "snippetSetId" + "documentTypeId", + "fileType", + "quoteId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentNumber": { "type": "string" }, - "salesChannelId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "fileType": { + "type": "string" + }, + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "snippetSetId": { + "config": { + "type": "object" + }, + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hreflangUseOnlyLocale": { - "type": "boolean" + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" @@ -11552,28 +11816,37 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "currency": { - "$ref": "#/components/schemas/Currency" + "quote": { + "$ref": "#/components/schemas/Quote" }, - "salesChannelDefaultHreflang": { - "$ref": "#/components/schemas/SalesChannel" + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "SalesChannelType": { - "description": "Added since version: 6.0.0.0", + "QuoteEmployee": { "required": [ - "name" + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11583,83 +11856,135 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" } }, "type": "object" }, - "SalutationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "QuoteLineItem": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "quoteId", + "identifier", + "children", + "states", + "label", + "quantity", + "position" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "required": [ - "id", - "salutationKey", - "displayName", - "letterName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationKey": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "letterName": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Salutation": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "salutationKey", - "displayName", - "letterName" - ], - "properties": { - "id": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationKey": { + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { "type": "string" }, - "displayName": { + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { "type": "string" }, - "letterName": { + "description": { "type": "string" }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "priceDefinition": { + "type": "object" + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "purchasePrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "good": { + "type": "boolean" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "referencedId": { + "type": "string" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -11673,19 +11998,116 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "parent": { + "$ref": "#/components/schemas/QuoteLineItem" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + }, + "cover": { + "$ref": "#/components/schemas/Media" + }, + "deliveryPositions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } } }, "type": "object" }, - "ScheduledTask": { - "description": "Added since version: 6.0.0.0", + "QuoteTransaction": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "quoteId", + "paymentMethodId", + "amount" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "amount": { + "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" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11695,17 +12117,32 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "Script": { - "description": "Added since version: 6.4.7.0", + "Rule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11715,173 +12152,164 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "SeoUrlJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { - "required": [ - "id", - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo" - ], + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "foreignKey": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "routeName": { - "type": "string" - }, - "pathInfo": { - "type": "string" - }, - "seoPathInfo": { - "type": "string" - }, - "isCanonical": { - "type": "boolean" - }, - "isModified": { - "type": "boolean" - }, - "isDeleted": { - "type": "boolean" - }, - "error": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "customFields": { + "warehouseGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "1768e3071b62161d415e0c24332055ed" + } + } + } + } + }, "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true } }, "type": "object" } - ] + }, + "type": "object" }, - "SeoUrl": { + "RuleCondition": { + "description": "Added since version: 6.0.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 + } + }, + "type": "object" + }, + "SalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo" + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "name", + "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "routeName": { + "paymentMethodId": { "type": "string", - "enum": [ - "frontend.navigation.page", - "frontend.landing.page", - "frontend.detail.page" - ] - }, - "pathInfo": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "seoPathInfo": { - "type": "string" + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isCanonical": { - "type": "boolean" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isModified": { - "type": "boolean" + "navigationCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isDeleted": { - "type": "boolean" + "navigationCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "error": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "navigationCategoryDepth": { + "type": "integer", + "format": "int64" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "footerCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "footerCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "serviceCategoryId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "serviceCategoryVersionId": { "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object", - "title": "SeoUrlEntity" - }, - "SeoUrlTemplate": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$" + }, + "mailHeaderFooterId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "hreflangDefaultDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "isValid": { + "name": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "taxCalculationType": { + "type": "string" + }, + "configuration": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "hreflangActive": { + "type": "boolean" + }, + "maintenance": { "type": "boolean" }, "customFields": { @@ -11896,59 +12324,183 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "ShippingMethodJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { - "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": { + "translated": { + "type": "object" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "domains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "navigationCategory": { + "$ref": "#/components/schemas/Category" + }, + "footerCategory": { + "$ref": "#/components/schemas/Category" + }, + "serviceCategory": { + "$ref": "#/components/schemas/Category" + }, + "hreflangDefaultDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "type": "object" + }, + "SalesChannelAnalytics": { + "description": "Added since version: 6.2.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 + } + }, + "type": "object" + }, + "SalesChannelDomain": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "url", + "salesChannelId", + "languageId", + "currencyId", + "snippetSetId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "url": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "snippetSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hreflangUseOnlyLocale": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "salesChannelDefaultHreflang": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], + "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 + }, + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "SalutationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salutationKey", + "displayName", + "letterName" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "taxType": { + "salutationKey": { "type": "string" }, - "description": { + "displayName": { "type": "string" }, - "trackingUrl": { + "letterName": { "type": "string" }, - "technicalName": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -11962,239 +12514,36 @@ }, "translated": { "type": "object" - }, - "relationships": { - "properties": { - "deliveryTime": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "delivery_time" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8c888ae25a7bd42057370e31f7e01044" - } - } - } - }, - "type": "object" - }, - "availabilityRule": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9fbb7961d1cb158094924c679e1b302c" - } - } - } - }, - "type": "object" - }, - "prices": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method_price" - }, - "id": { - "type": "string", - "example": "afae32efe0f84fece3f96b377b768b33" - } - } - } - } - }, - "type": "object" - }, - "media": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } - } - } - }, - "type": "object" - }, - "tags": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } - } - } - } - }, - "type": "object" - }, - "tax": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" - } - } - } - }, - "type": "object" - } - }, - "type": "object" } }, "type": "object" } ] }, - "ShippingMethod": { + "Salutation": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "deliveryTimeId", - "name" + "salutationKey", + "displayName", + "letterName" ], "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": { + "salutationKey": { "type": "string" }, - "description": { + "displayName": { "type": "string" }, - "trackingUrl": { + "letterName": { "type": "string" }, - "technicalName": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -12208,78 +12557,17 @@ }, "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": { + "ScheduledTask": { "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", @@ -12293,31 +12581,13 @@ }, "type": "object" }, - "Snippet": { - "description": "Added since version: 6.0.0.0", - "required": [ - "setId", - "translationKey", - "value" - ], + "Script": { + "description": "Added since version: 6.4.7.0", "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", @@ -12331,164 +12601,142 @@ }, "type": "object" }, - "SnippetSet": { + "SeoUrlJsonApi": { "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" + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "customFields": { + { + "required": [ + "id", + "languageId", + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "foreignKey": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "routeName": { + "type": "string" + }, + "pathInfo": { + "type": "string" + }, + "seoPathInfo": { + "type": "string" + }, + "isCanonical": { + "type": "boolean" + }, + "isModified": { + "type": "boolean" + }, + "isDeleted": { + "type": "boolean" + }, + "error": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, "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": { + "SeoUrl": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "languageId", + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo" + ], "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" - }, - "SpatialScene": { - "properties": { - "id": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "languageId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneCamera": { - "properties": { - "id": { + "foreignKey": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "routeName": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "frontend.navigation.page", + "frontend.landing.page", + "frontend.detail.page" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneGroup": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pathInfo": { + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "seoPathInfo": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneLight": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isCanonical": { + "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "isModified": { + "type": "boolean" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneMaterial": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isDeleted": { + "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "error": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneObject": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -12501,33 +12749,26 @@ "readOnly": true } }, - "type": "object" + "type": "object", + "title": "SeoUrlEntity" }, - "SpatialScenePrimitive": { + "SeoUrlTemplate": { + "description": "Added since version: 6.0.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 - } - }, - "type": "object" - }, - "SsoProvider": { - "properties": { - "id": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "isValid": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -12537,15 +12778,658 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "media": { - "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "SsoProviderCustomer": { - "properties": { + "ShippingMethodJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "deliveryTimeId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "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" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "deliveryTime": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "delivery_time" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c888ae25a7bd42057370e31f7e01044" + } + } + } + }, + "type": "object" + }, + "availabilityRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" + } + } + } + }, + "type": "object" + }, + "prices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method_price" + }, + "id": { + "type": "string", + "example": "afae32efe0f84fece3f96b377b768b33" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "tax": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ShippingMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "deliveryTimeId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "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" + }, + "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" + }, + "SpatialScene": { + "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" + }, + "SpatialSceneCamera": { + "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" + }, + "SpatialSceneGroup": { + "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" + }, + "SpatialSceneLight": { + "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" + }, + "SpatialSceneMaterial": { + "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" + }, + "SpatialSceneObject": { + "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" + }, + "SpatialScenePrimitive": { + "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" + }, + "SsoProvider": { + "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 + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "SsoProviderCustomer": { + "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -12630,6 +13514,7 @@ "StateMachineState": { "description": "Added since version: 6.0.0.0", "required": [ + "translated", "technicalName", "name" ], @@ -13707,397 +14592,162 @@ }, "UserRecovery": { "description": "Added since version: 6.0.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 - } - }, - "type": "object" - }, - "Warehouse": { - "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" - }, - "WarehouseGroup": { - "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" - }, - "Webhook": { - "description": "Added since version: 6.3.1.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 - } - }, - "type": "object" - }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.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 - } - }, - "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", - "properties": { - "name": { - "type": "string" - }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "translated": { - "type": "object", - "additionalProperties": true, - "properties": { - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "type": "string", - "enum": [ - "external", - "category", - "product", - "landing_page" - ] - }, - "internalLink": { - "type": "string" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - } - } - }, - "path": { - "type": "string" + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "seoUrls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "apiAlias": { + "updatedAt": { "type": "string", - "enum": [ - "breadcrumb" - ] + "format": "date-time", + "readOnly": true } }, - "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.", + "Warehouse": { "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "rawTotal": { - "type": "number" - }, - "totalPrice": { - "type": "number" - }, - "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": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "hasRange": { - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "variantId": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "WarehouseGroup": { + "properties": { + "id": { "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "pattern": "^[0-9a-f]{32}$" }, - "apiAlias": { + "createdAt": { "type": "string", - "enum": [ - "calculated_price" - ] + "format": "date-time", + "readOnly": true }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "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", + "Webhook": { + "description": "Added since version: 6.3.1.0", "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" + }, + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", + "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": { + "SalesChannelContext": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { + "token": { + "description": "Context the user session", + "type": "string" + }, + "currentCustomerGroup": { "type": "object", + "description": "Customer group of the current user", "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "name": { + "type": "string" }, - "latest": { - "type": "string", - "format": "date-time" + "displayGross": { + "type": "boolean" + } + } + }, + "fallbackCustomerGroup": { + "description": "Fallback group if the default customer group is not applicable", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayGross": { + "type": "boolean" } } }, - "location": { + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingLocation": { "type": "object", "properties": { "apiAlias": { @@ -14111,435 +14761,456 @@ }, "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" + }, + "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" + } + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "sales_channel_context" + ] } - } + }, + "required": [ + "salesChannel", + "apiAlias" + ] }, - "ShippingMethodPageRouteResponse": { + "NavigationRouteResponse": { "type": "array", "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "deliveryTimeId": { - "type": "string" - }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer", - "format": "int32" - }, - "max": { - "type": "integer", - "format": "int32" - }, - "unit": { - "type": "string" - } - } - }, - "translations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "shippingMethodId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - } - } - }, - "orderDeliveries": { - "type": "array", - "items": { - "type": "object", - "properties": { - "orderId": { - "type": "string" - }, - "shippingOrderAddressId": { - "type": "string" - }, - "shippingMethodId": { - "type": "string" - }, - "shippingDateEarliest": { - "type": "string", - "format": "date-time" - }, - "shippingDateLatest": { - "type": "string", - "format": "date-time" - }, - "stateId": { - "type": "string" - } - } - } - }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "typeId": { - "type": "string" - }, - "languageId": { - "type": "string" - }, - "currencyId": { - "type": "string" - }, - "paymentMethodId": { - "type": "string" - }, - "shippingMethodId": { - "type": "string" - }, - "countryId": { - "type": "string" - }, - "navigationCategoryId": { - "type": "string" - }, - "navigationCategoryDepth": { - "type": "integer", - "format": "int32" - }, - "footerCategoryId": { - "type": "string" - }, - "serviceCategoryId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "maintenance": { - "type": "boolean" - }, - "maintenanceIpWhitelist": { - "type": "string" - }, - "mailHeaderFooterId": { - "type": "string" - }, - "customerGroupId": { - "type": "string" - }, - "hreflangActive": { - "type": "boolean" - }, - "hreflangDefaultDomainId": { - "type": "string" - } - } + "$ref": "#/components/schemas/Category" + } + }, + "CartError": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + }, + "required": [ + "key", + "level", + "message", + "messageKey" + ] + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" } - }, - "salesChannels": { - "type": "array", - "items": { + ] + }, + "regulationPrice": { + "oneOf": [ + { "type": "object", "properties": { - "typeId": { - "type": "string" - }, - "languageId": { - "type": "string" - }, - "currencyId": { - "type": "string" - }, - "paymentMethodId": { - "type": "string" - }, - "shippingMethodId": { - "type": "string" - }, - "countryId": { - "type": "string" - }, - "navigationCategoryId": { - "type": "string" - }, - "navigationCategoryDepth": { - "type": "integer", - "format": "int32" - }, - "footerCategoryId": { - "type": "string" - }, - "serviceCategoryId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "maintenance": { - "type": "boolean" - }, - "maintenanceIpWhitelist": { - "type": "string" - }, - "mailHeaderFooterId": { - "type": "string" - }, - "customerGroupId": { - "type": "string" - }, - "hreflangActive": { - "type": "boolean" + "price": { + "type": "number" }, - "hreflangDefaultDomainId": { - "type": "string" + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } } + }, + { + "type": "null" } - }, - "availabilityRule": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "FindProductVariantRouteResponse": { + "type": "object", + "properties": { + "foundCombination": { + "type": "object", + "properties": { + "variantId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "options": { + "type": "array", + "items": { "type": "string" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "invalid": { - "type": "boolean" } } - }, - "availabilityRuleId": { - "type": "string" - }, - "prices": { - "type": "array", - "items": { + } + } + } + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "ProductListingResult": { + "allOf": [ + { + "$ref": "#/components/schemas/EntitySearchResult" + }, + { + "type": "object", + "properties": { + "currentFilters": { "type": "object", + "description": "Contains the state of the filters. These can be used to create listing filters.", "properties": { - "shippingMethodId": { - "type": "string" - }, - "currencyId": { + "navigationId": { "type": "string" }, - "ruleId": { - "type": "string" + "manufacturer": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "calculation": { - "type": "integer", - "format": "int32" + "price": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "default": 0 + }, + "max": { + "type": "integer", + "default": 0 + } + }, + "required": [ + "min", + "max" + ] }, - "quantityStart": { - "type": "number", - "format": "float" + "rating": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ] }, - "quantityEnd": { - "type": "number", - "format": "float" + "shipping-free": { + "type": "boolean", + "default": false }, - "price": { - "type": "number", - "format": "float" + "properties": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "calculationRuleId": { + "search": { "type": "string" } - } - } - }, - "mediaId": { - "type": "string" - }, - "media": { - "type": "object", - "properties": { - "userId": { - "type": "string" - }, - "mimeType": { - "type": "string" - }, - "fileExtension": { - "type": "string" - }, - "fileSize": { - "type": "integer", - "format": "int32" - }, - "title": { - "type": "string" - }, - "metaDataRaw": { - "type": "string" - }, - "mediaTypeRaw": { - "type": "string" - }, - "uploadedAt": { - "type": "string", - "format": "date-time" - }, - "alt": { - "type": "string" - }, - "url": { - "type": "string" - }, - "fileName": { - "type": "string" - }, - "mediaFolderId": { - "type": "string" }, - "private": { - "type": "boolean" - }, - "thumbnailsRo": { - "type": "string" + "required": [ + "manufacturer", + "navigationId", + "price", + "properties", + "rating", + "shipping-free" + ] + }, + "availableSortings": { + "type": "array", + "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "translated": { + "type": "object", + "properties": { + "label": { + "type": "string" + } + }, + "required": [ + "label" + ] + }, + "key": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "product_sorting" + ] + } + }, + "required": [ + "label", + "translated", + "key", + "priority", + "apiAlias" + ] } - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - } + }, + "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" + ] } + ] + }, + "CrossSellingElementCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CrossSellingElement" } }, - "CartDeliveryPosition": { + "CartPriceQuantity": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { - "type": "object", + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" + ] + }, + "isCalculated": { + "type": "boolean" + }, + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "regulationPrice": { "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } } } }, - "identifier": { + "type": { "type": "string" - }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" } - } + }, + "required": [ + "apiAlias" + ] }, - "CustomerAddressRead": { + "CrossSellingElement": { "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" + "crossSelling": { + "$ref": "#/components/schemas/ProductCrossSelling" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "nullable": true + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "country": { - "$ref": "#/components/schemas/Country" + "total": { + "type": "integer", + "format": "int32" }, - "countryState": { - "$ref": "#/components/schemas/CountryState", - "nullable": true + "streamId": { + "type": "string", + "format": "uuid" }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "apiAlias": { + "type": "string", + "enum": [ + "cross_selling_element" + ] } }, "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" + "crossSelling", + "products", + "total", + "apiAlias" ] }, "EntitySearchResult": { @@ -14569,829 +15240,1049 @@ } } }, - "Sitemap": { + "AggregationEntity": { + "title": "AggregationEntity", "type": "object", "properties": { - "filename": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "created": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time" + "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": [ - "filename", - "created" + "name", + "type", + "field", + "definition" ] }, - "SuccessResponse": { + "AggregationFilter": { + "title": "AggregationFilter", "type": "object", "properties": { - "success": { - "type": "boolean" + "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": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } } - } + }, + "required": [ + "name", + "type", + "filter" + ] }, - "Criteria": { + "AggregationTerms": { + "title": "AggregationTerms", "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" + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "term": { - "description": "Search term", + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "terms" + ] + }, + "field": { + "description": "The field you want to aggregate over.", "type": "string" }, "limit": { - "description": "Number of items per result page", - "type": "integer" + "description": "The number of terms to return", + "type": "number" }, - "filter": { + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "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" + ] + }, + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "ranges": { + "description": "The ranges of the aggregation", "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", "anyOf": [ { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" + "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" + ] }, { - "$ref": "#/components/schemas/MultiNotFilter" + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] }, { - "$ref": "#/components/schemas/RangeFilter" + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] } ] } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "CalculatedPrice": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "unitPrice": { + "type": "number" }, - "ids": { - "type": "array", - "description": "List of ids to search for", - "items": { - "type": "string" - } + "quantity": { + "type": "number" }, - "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" - } + "rawTotal": { + "type": "number" }, - "associations": { - "$ref": "#/components/schemas/Associations" + "totalPrice": { + "type": "number" + }, + "taxStatus": { + "type": "string", + "enum": [ + "net", + "tax-free" + ] }, - "post-filter": { + "calculatedTaxes": { "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" + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] }, - { - "$ref": "#/components/schemas/EqualsFilter" + "tax": { + "type": "number" }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "taxRate": { + "type": "number" }, - { - "$ref": "#/components/schemas/RangeFilter" + "price": { + "type": "number" } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" ] } }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" - } - }, - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" - } - }, - "grouping": { - "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": [ + "referencePrice": { + "oneOf": [ { - "$ref": "#/components/schemas/AggregationEntity" + "$ref": "#/components/schemas/CartPriceReference" }, { - "$ref": "#/components/schemas/SubAggregations" + "type": "null" } ] }, - { - "title": "AggregationFilter", - "allOf": [ + "listPrice": { + "oneOf": [ { - "$ref": "#/components/schemas/AggregationFilter" + "$ref": "#/components/schemas/CartListPrice" }, { - "$ref": "#/components/schemas/SubAggregations" + "type": "null" } ] }, - { - "title": "AggregationTerms", - "allOf": [ + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "oneOf": [ { - "$ref": "#/components/schemas/AggregationTerms" + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } }, { - "$ref": "#/components/schemas/SubAggregations" + "type": "null" } ] }, - { - "title": "AggregationHistogram", - "allOf": [ + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ { - "$ref": "#/components/schemas/AggregationHistogram" + "type": "string", + "format": "^[0-9a-f]{32}$" }, { - "$ref": "#/components/schemas/SubAggregations" + "type": "null" } ] }, - { - "title": "AggregationRange", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationRange" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules", + "rawTotal", + "taxStatus" ] }, - "SubAggregations": { + "CartDelivery": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/AggregationHistogram" + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" }, - { - "$ref": "#/components/schemas/AggregationRange" + "latest": { + "type": "string", + "format": "date-time" } - ] - } - } - }, - "TotalCountMode": { - "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", - "type": "string", - "default": "none", - "enum": [ - "none", - "exact", - "next-pages" - ] - }, - "Query": { - "type": "object", - "properties": { - "score": { - "type": "number" + } }, - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] }, - { - "$ref": "#/components/schemas/EqualsFilter" + "country": { + "$ref": "#/components/schemas/Country" }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "address": { + "$ref": "#/components/schemas/CustomerAddress" }, - { - "$ref": "#/components/schemas/RangeFilter" + "state": { + "$ref": "#/components/schemas/CountryState" } - ] + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" } - }, - "additionalProperties": true + } }, - "Sort": { + "SuccessResponse": { "type": "object", "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - "naturalSorting": { + "success": { "type": "boolean" - }, - "type": { - "type": "string" } - }, - "required": [ - "field", - "order" - ] - }, - "Filters": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] } }, - "SimpleFilter": { + "CartDeliveryPosition": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "type": { - "type": "string", - "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" - ] + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } }, - "field": { + "identifier": { "type": "string" }, - "value": { - "type": "string" + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" } - }, - "required": [ - "type", - "field", - "value" + } + }, + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity" ] }, - "EqualsFilter": { + "LineItem": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "equals" - ] + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "field": { + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "dataContextHash": { "type": "string" }, - "value": { - "oneOf": [ - { - "type": "string" + "dataTimestamp": { + "type": "string" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { + "type": "string" + }, + "good": { + "type": "boolean" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "$ref": "#/components/schemas/ProductJsonApi" + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] }, - { + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { "type": "number" }, - { - "type": "boolean" + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] }, - { - "type": "null" + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } + }, + { + "type": "null" + } + ] + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } - ] - } - }, - "required": [ - "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" } } - } - }, - "required": [ - "type", - "field", - "parameters" - ] - }, - "CartPriceReference": { - "type": "object", - "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" }, - "unitName": { + "referencedId": { "type": "string" }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] + "removable": { + "type": "boolean" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "stackable": { + "type": "boolean" }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true + "states": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } }, - "hasRange": { - "type": "boolean" + "type": { + "$ref": "#/components/schemas/LineItemType" }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "uniqueIdentifier": { + "type": "string" } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", + "id", + "type", + "deliveryInformation", + "payload", "quantity", - "unitName" + "states" ] }, - "CartPriceQuantity": { + "Association": { + "additionalProperties": { + "$ref": "#/components/schemas/Association" + } + }, + "AccountNewsletterRecipient": { "type": "object", "properties": { - "apiAlias": { + "status": { "type": "string", "enum": [ - "cart_price_quantity" + "undefined", + "notSet", + "direct", + "optIn", + "optOut" ] }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" + "apiAlias": { + "type": "string", + "enum": [ + "account_newsletter_recipient" + ] + } + }, + "required": [ + "status", + "apiAlias" + ] + }, + "ShippingMethodPageRouteResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "deliveryTimeId": { + "type": "string" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int32" + }, + "max": { + "type": "integer", + "format": "int32" + }, + "unit": { + "type": "string" + } + } + }, + "translations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "shippingMethodId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + }, + "orderDeliveries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "orderId": { + "type": "string" + }, + "shippingOrderAddressId": { + "type": "string" + }, + "shippingMethodId": { + "type": "string" + }, + "shippingDateEarliest": { + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "stateId": { + "type": "string" + } + } } }, - "type": "object" - }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "typeId": { + "type": "string" + }, + "languageId": { + "type": "string" + }, + "currencyId": { + "type": "string" + }, + "paymentMethodId": { + "type": "string" + }, + "shippingMethodId": { + "type": "string" + }, + "countryId": { + "type": "string" + }, + "navigationCategoryId": { + "type": "string" + }, + "navigationCategoryDepth": { + "type": "integer", + "format": "int32" + }, + "footerCategoryId": { + "type": "string" + }, + "serviceCategoryId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "maintenanceIpWhitelist": { + "type": "string" + }, + "mailHeaderFooterId": { + "type": "string" + }, + "customerGroupId": { + "type": "string" + }, + "hreflangActive": { + "type": "boolean" + }, + "hreflangDefaultDomainId": { + "type": "string" + } } } - } - }, - "type": { - "type": "string" - } - }, - "required": [ - "apiAlias" - ] - }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" - ] - }, - "LineItem": { - "type": "object", - "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" - }, - "good": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { - "type": "boolean" - }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" - }, - "price": { - "type": "object", - "properties": { - "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" - } + }, + "salesChannels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "typeId": { + "type": "string" }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" + "languageId": { + "type": "string" + }, + "currencyId": { + "type": "string" + }, + "paymentMethodId": { + "type": "string" + }, + "shippingMethodId": { + "type": "string" + }, + "countryId": { + "type": "string" + }, + "navigationCategoryId": { + "type": "string" + }, + "navigationCategoryDepth": { + "type": "integer", + "format": "int32" + }, + "footerCategoryId": { + "type": "string" + }, + "serviceCategoryId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "maintenanceIpWhitelist": { + "type": "string" + }, + "mailHeaderFooterId": { + "type": "string" + }, + "customerGroupId": { + "type": "string" }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" + "hreflangActive": { + "type": "boolean" }, - { - "type": "null" + "hreflangDefaultDomainId": { + "type": "string" } - ] - }, - "regulationPrice": { + } + } + }, + "availabilityRule": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "invalid": { + "type": "boolean" + } + } + }, + "availabilityRuleId": { + "type": "string" + }, + "prices": { + "type": "array", + "items": { "type": "object", "properties": { + "shippingMethodId": { + "type": "string" + }, + "currencyId": { + "type": "string" + }, + "ruleId": { + "type": "string" + }, + "calculation": { + "type": "integer", + "format": "int32" + }, + "quantityStart": { + "type": "number", + "format": "float" + }, + "quantityEnd": { + "type": "number", + "format": "float" + }, "price": { - "type": "number" + "type": "number", + "format": "float" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "calculationRuleId": { + "type": "string" } } } }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" - }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" + "mediaId": { + "type": "string" + }, + "media": { + "type": "object", + "properties": { + "userId": { + "type": "string" + }, + "mimeType": { + "type": "string" + }, + "fileExtension": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string" + }, + "metaDataRaw": { + "type": "string" + }, + "mediaTypeRaw": { + "type": "string" + }, + "uploadedAt": { + "type": "string", + "format": "date-time" + }, + "alt": { + "type": "string" + }, + "url": { + "type": "string" + }, + "fileName": { + "type": "string" + }, + "mediaFolderId": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "thumbnailsRo": { + "type": "string" + } } - } - }, - "referencedId": { - "type": "string" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } - }, - "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "AggregationMetrics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" - ] - }, - "field": { - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "CartError": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } } } } @@ -15416,736 +16307,804 @@ "product" ] }, - "NavigationRouteResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "Cart": { + "Breadcrumb": { "type": "object", "properties": { "name": { - "description": "Name of the cart - for example `guest-cart`", "type": "string" }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } + "type": { + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" + "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" + } } }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } + "path": { + "type": "string" }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", + "seoUrls": { "type": "array", "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } + "$ref": "#/components/schemas/SeoUrl" } }, - "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 - } - } - }, - "AccountNewsletterRecipient": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "undefined", - "notSet", - "direct", - "optIn", - "optOut" - ] - }, "apiAlias": { "type": "string", "enum": [ - "account_newsletter_recipient" + "breadcrumb" ] } }, "required": [ - "status", + "name", + "categoryId", + "type", + "translated", + "path", "apiAlias" ] }, - "OrderRouteResponse": { + "ProductListingFlags": { "type": "object", + "description": "Additional flags for product listings", "properties": { - "orders": { - "allOf": [ + "no-aggregations": { + "description": "Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.", + "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } + "type": "string" }, { - "$ref": "#/components/schemas/EntitySearchResult" + "type": "null" } ] }, - "paymentChangeable": { - "type": "object", - "description": "The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.", - "additionalProperties": { - "type": "boolean" - } - } - }, - "required": [ - "orders" - ] - }, - "ProductListingFlags": { - "type": "object", - "description": "Additional flags for product listings", - "properties": { - "no-aggregations": { - "description": "Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.", - "type": "string", - "nullable": true - }, "only-aggregations": { "description": "If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.", - "type": "string", - "nullable": true - } - } - }, - "CartDeliveryInformation": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_information" - ] - }, - "freeDelivery": { - "type": "boolean" - }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { + "oneOf": [ + { "type": "string" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" - ] + { + "type": "null" } - } - }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" - }, - "restockTime": { - "type": "integer" - }, - "stock": { - "type": "integer" - }, - "weight": { - "type": "integer" - }, - "width": { - "type": "integer" + ] } - }, - "required": [ - "apiAlias" - ] + } }, - "WishlistLoadRouteResponse": { + "Cart": { "type": "object", "properties": { - "wishlist": { - "type": "object", - "properties": { - "customerId": { - "type": "string" - }, - "salesChannelId": { - "type": "string" - } - } + "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" }, - "products": { - "$ref": "#/components/schemas/ProductListingResult" - } - } - }, - "ProductListingResult": { - "allOf": [ - { - "$ref": "#/components/schemas/EntitySearchResult" + "price": { + "$ref": "#/components/schemas/CalculatedPrice" }, - { + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + }, + "errors": { "type": "object", - "properties": { - "currentFilters": { - "type": "object", - "description": "Contains the state of the filters. These can be used to create listing filters.", - "properties": { - "navigationId": { - "type": "string" - }, - "manufacturer": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "price": { - "type": "object", - "properties": { - "min": { - "type": "integer", - "default": 0 - }, - "max": { - "type": "integer", - "default": 0 - } - }, - "required": [ - "min", - "max" - ] - }, - "rating": { - "type": "integer", - "nullable": true - }, - "shipping-free": { - "type": "boolean", - "default": false - }, - "properties": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "search": { - "type": "string" - } - }, - "required": [ - "manufacturer", - "navigationId", - "price", - "properties", - "rating", - "shipping-free" - ] - }, - "availableSortings": { + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "anyOf": [ + { "type": "array", - "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", "items": { + "$ref": "#/components/schemas/CartError" + } + }, + { + "type": "object", + "additionalProperties": { "type": "object", "properties": { - "label": { - "type": "string" - }, - "translated": { - "type": "object", - "properties": { - "label": { - "type": "string" - } - }, - "required": [ - "label" - ] + "code": { + "type": "number" }, "key": { "type": "string" }, - "priority": { + "level": { "type": "number" }, - "apiAlias": { - "type": "string", - "enum": [ - "product_sorting" - ] + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" } }, "required": [ - "label", - "translated", + "code", "key", - "priority", - "apiAlias" + "level", + "message", + "messageKey" ] } - }, - "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" ] - } - ] - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "gross": { - "description": "", - "type": "number" + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } }, - "net": { - "description": "", - "type": "number" + "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" + } + } + } }, - "linked": { - "description": "", + "modified": { "type": "boolean" }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "customerComment": { + "description": "A comment that can be added to the cart.", + "oneOf": [ + { + "type": "string" }, - "linked": { - "description": "", - "type": "boolean" + { + "type": "null" } - }, - "required": [ - "gross", - "net" ] }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" + "affiliateCode": { + "description": "An affiliate tracking code", + "oneOf": [ + { + "type": "string" }, - "net": { - "description": "", - "type": "number" + { + "type": "null" + } + ] + }, + "campaignCode": { + "description": "A campaign tracking code", + "oneOf": [ + { + "type": "string" }, - "linked": { - "description": "", - "type": "boolean" + { + "type": "null" } - }, - "required": [ - "gross", - "net" + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart" ] } }, "required": [ - "currencyId", - "gross", - "net" + "price", + "apiAlias" ] }, - "SalesChannelContext": { + "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": { - "token": { - "description": "Context the user session", + "page": { + "description": "Search result page", + "type": "integer" + }, + "term": { + "description": "Search term", "type": "string" }, - "currentCustomerGroup": { - "type": "object", - "description": "Customer group of the current user", - "properties": { - "name": { - "type": "string" - }, - "displayGross": { - "type": "boolean" - } + "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" + } + ] } }, - "fallbackCustomerGroup": { - "description": "Fallback group if the default customer group is not applicable", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayGross": { - "type": "boolean" - } + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" } }, - "currency": { - "$ref": "#/components/schemas/Currency" + "query": { + "type": "string", + "description": "The query string to search for" }, - "salesChannel": { - "description": "Information about the current sales channel", - "type": "object", - "properties": { - "typeId": { - "type": "string" - }, - "languageId": { - "type": "string" - }, - "currencyId": { - "type": "string" - }, - "paymentMethodId": { - "type": "string" - }, - "shippingMethodId": { - "type": "string" - }, - "countryId": { - "type": "string" - }, - "navigationCategoryId": { - "type": "string" - }, - "navigationCategoryDepth": { - "type": "integer", - "format": "int32" - }, - "footerCategoryId": { - "type": "string" - }, - "serviceCategoryId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "accessKey": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "maintenance": { - "type": "boolean" - }, - "maintenanceIpWhitelist": { - "type": "string" - }, - "mailHeaderFooterId": { - "type": "string" - }, - "customerGroupId": { - "type": "string" - }, - "hreflangActive": { - "type": "boolean" - }, - "hreflangDefaultDomainId": { - "type": "string" - }, - "analyticsId": { - "type": "string" - } - } + "associations": { + "$ref": "#/components/schemas/Associations" }, - "taxRules": { + "post-filter": { "type": "array", - "description": "Currently active tax rules and/or rates", + "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": { - "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" } - } + ] } }, - "customer": { - "$ref": "#/components/schemas/Customer" + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "$ref": "#/components/schemas/Sort" + } }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } }, - "shippingLocation": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } + }, + "grouping": { + "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" }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" + { + "$ref": "#/components/schemas/SubAggregations" } - } + ] }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] }, - "context": { - "description": "Core context with general configuration values and state", - "type": "object", - "properties": { - "versionId": { - "type": "string" + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "currencyId": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "currencyFactor": { - "type": "integer" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" }, - "currencyPrecision": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "languageIdChain": { - "type": "array", - "items": { - "type": "string" - } + { + "$ref": "#/components/schemas/AggregationEntity" }, - "scope": { - "type": "string" + { + "$ref": "#/components/schemas/AggregationFilter" }, - "source": { - "type": "string" + { + "$ref": "#/components/schemas/AggregationTerms" }, - "taxState": { - "type": "string" + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "useCache": { - "type": "boolean" + { + "$ref": "#/components/schemas/AggregationRange" } - } + ] } } }, - "CartItems": { + "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": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } + "score": { + "type": "number" + }, + "query": { + "oneOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] } - } + }, + "additionalProperties": true }, - "CustomerAddressBody": { - "description": "Added since version: 6.0.0.0", - "required": [ - "countryId", - "firstName", - "lastName", - "city", - "street" - ], + "Sort": { + "type": "object", "properties": { - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { + "field": { "type": "string" }, - "lastName": { - "type": "string" + "order": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] }, - "zipcode": { - "type": "string" + "naturalSorting": { + "type": "boolean" }, - "city": { + "type": { "type": "string" + } + }, + "required": [ + "field", + "order" + ] + }, + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] }, - "company": { + "field": { "type": "string" }, - "street": { + "value": { "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] }, - "department": { + "field": { "type": "string" }, - "title": { - "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" + ] }, - "phoneNumber": { - "type": "string" + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] }, - "additionalAddressLine1": { - "type": "string" + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "operator", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] }, - "additionalAddressLine2": { + "field": { "type": "string" }, - "customFields": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "parameters": { + "type": "object", + "properties": { + "gte": { + "type": "number" + }, + "gt": { + "type": "number" + }, + "lte": { + "type": "number" + }, + "lt": { + "type": "number" + } + } } }, - "type": "object" + "required": [ + "type", + "field", + "parameters" + ] }, - "CartListPrice": { + "Price": { "type": "object", - "description": "", + "description": "Price object", "properties": { - "discount": { - "type": "number" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "percentage": { + "gross": { + "description": "", "type": "number" }, - "price": { + "net": { + "description": "", "type": "number" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" ] } }, "required": [ - "apiAlias" + "currencyId", + "gross", + "net" + ] + }, + "OrderRouteResponse": { + "type": "object", + "properties": { + "orders": { + "type": "object", + "allOf": [ + { + "type": "object", + "required": [ + "elements" + ], + "properties": { + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + }, + "paymentChangeable": { + "type": "object", + "description": "The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.", + "additionalProperties": { + "type": "boolean" + } + } + }, + "required": [ + "orders" ] }, + "WishlistLoadRouteResponse": { + "type": "object", + "required": [ + "products" + ], + "properties": { + "wishlist": { + "type": "object", + "properties": { + "customerId": { + "type": "string" + }, + "salesChannelId": { + "type": "string" + } + } + }, + "products": { + "$ref": "#/components/schemas/ProductListingResult" + } + } + }, "ProductListingCriteria": { "allOf": [ { @@ -16229,234 +17188,364 @@ }, "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.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + ] + }, + "ListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" + ] + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] + }, + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { "type": "string", - "nullable": true + "enum": [ + "cart_delivery_time" + ] } } + }, + "height": { + "type": "integer" + }, + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" } + }, + "required": [ + "apiAlias" ] }, - "AggregationEntity": { - "title": "AggregationEntity", + "AggregationMetrics": { "type": "object", "properties": { "name": { - "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, "type": { - "description": "The type of aggregation", "type": "string", "enum": [ - "entity" + "avg", + "count", + "max", + "min", + "stats", + "sum" ] }, "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" + "field" ] }, - "AggregationFilter": { - "title": "AggregationFilter", + "CustomerAddressRead": { "type": "object", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "type": { - "description": "The type of aggregation", + "customerId": { "type": "string", - "enum": [ - "filter" + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } ] }, - "filter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Filters" - } + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "oneOf": [ + { + "$ref": "#/components/schemas/CountryState" + }, + { + "type": "null" + } + ] + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "required": [ - "name", - "type", - "filter" + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" ] }, - "AggregationTerms": { - "title": "AggregationTerms", - "type": "object", + "CustomerAddressBody": { + "description": "Added since version: 6.0.0.0", + "required": [ + "countryId", + "firstName", + "lastName", + "city", + "street" + ], "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "type": { - "description": "The type of aggregation", + "countryStateId": { "type": "string", - "enum": [ - "terms" - ] + "pattern": "^[0-9a-f]{32}$" }, - "field": { - "description": "The field you want to aggregate over.", + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "limit": { - "description": "The number of terms to return", - "type": "number" + "lastName": { + "type": "string" }, - "sort": { - "type": "array", - "description": "Sorting the aggregation result.", - "items": { - "$ref": "#/components/schemas/Sort" - } - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationHistogram": { - "title": "AggregationHistogram", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + "zipcode": { "type": "string" }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "histogram" - ] + "city": { + "type": "string" }, - "field": { - "description": "The field you want to aggregate over.", + "company": { "type": "string" }, - "interval": { - "description": "The interval of the histogram", - "type": "number" + "street": { + "type": "string" }, - "format": { - "description": "The format of the histogram", + "department": { "type": "string" }, - "timeZone": { - "description": "The timezone of the histogram", + "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" + }, + "Sitemap": { + "type": "object", + "properties": { + "filename": { "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" } }, "required": [ - "name", - "type", - "field" + "filename", + "created" ] }, - "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)", + "CartItems": { "type": "object", + "required": [ + "items" + ], "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "ReferencePrice": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { "type": "string" }, - "type": { - "description": "The type of aggregation", + "price": { + "type": "number" + }, + "apiAlias": { "type": "string", "enum": [ - "range" + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } + }, + { + "type": "null" + } ] }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "hasRange": { + "type": "boolean" }, - "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" - ] - } - ] - } + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] } }, "required": [ - "name", - "type", - "field", - "ranges" - ] - }, - "NavigationType": { - "type": "string", - "enum": [ - "main-navigation", - "footer-navigation", - "service-navigation" + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" ] }, "NaturalLanguageSearchTermResponse": { @@ -16511,44 +17600,6 @@ } } }, - "ApprovalRule": { - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "businessPartnerCustomerId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "priority": { - "type": "integer" - }, - "description": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "conditions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - } - }, - "type": "object" - }, "PendingOrder": { "type": "object", "properties": { @@ -16609,52 +17660,150 @@ "type": "string" }, "billingAddress": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "language": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "country": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "currency": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "salesChannel": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "approvalRuleId": { "type": "string" }, "itemRounding": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "totalRounding": { - "type": "object", - "nullable": true + "oneOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, "taxStatus": { "type": "string" }, "amountTotal": { - "type": "number", - "nullable": true + "oneOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] }, "amountNet": { - "type": "number", - "nullable": true + "oneOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] }, "originalPrice": { - "type": "number", - "nullable": true + "oneOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ] + } + } + }, + "ApprovalRule": { + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "businessPartnerCustomerId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "priority": { + "type": "integer" + }, + "description": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + } + } } - } + }, + "type": "object" } }, "responses": { @@ -17004,61 +18153,278 @@ ] } } - } - } - }, - "parameters": { - "contentType": { - "name": "Content-Type", - "in": "header", - "description": "Content type of the request", - "required": true, - "schema": { - "type": "string", - "default": "application/json" - } - }, - "accept": { - "name": "Accept", - "in": "header", - "description": "Accepted response content types", - "required": true, - "schema": { - "type": "string", - "default": "application/json" - } - } - }, - "securitySchemes": { - "ApiKey": { - "type": "apiKey", - "description": "Identifies the sales channel you want to access the API through", - "name": "sw-access-key", - "in": "header" + } + } + }, + "parameters": { + "contentType": { + "name": "Content-Type", + "in": "header", + "description": "Content type of the request", + "required": true, + "schema": { + "type": "string", + "default": "application/json" + } + }, + "accept": { + "name": "Accept", + "in": "header", + "description": "Accepted response content types", + "required": true, + "schema": { + "type": "string", + "default": "application/json" + } + } + }, + "securitySchemes": { + "ApiKey": { + "type": "apiKey", + "description": "Identifies the sales channel you want to access the API through", + "name": "sw-access-key", + "in": "header" + }, + "ContextToken": { + "type": "apiKey", + "description": "Identifies an anonymous or identified user session", + "name": "sw-context-token", + "in": "header" + } + } + }, + "security": [ + { + "ApiKey": [] + } + ], + "paths": { + "/role/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", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the new role", + "type": "string" + }, + "permissions": { + "description": "Permissions of the new role", + "type": "array", + "items": { + "type": "string" + } + }, + "isDefaultRole": { + "description": "Ability to set the new role as default", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Role entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + }, + "/role": { + "get": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Fetch a list of roles", + "description": "This route is used to load roles", + "operationId": "readRoles", + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Criteria" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Entity search result containing roles", + "content": { + "application/json": { + "schema": { + "type": "object", + "allOf": [ + { + "properties": { + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + }, + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Fetch a list of roles", + "description": "This route is used to load roles", + "operationId": "readRolesPOST", + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Criteria" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Entity search result containing roles", + "content": { + "application/json": { + "schema": { + "type": "object", + "allOf": [ + { + "properties": { + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + }, + "/role/{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", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier of the role to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Role entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] }, - "ContextToken": { - "type": "apiKey", - "description": "Identifies an anonymous or identified user session", - "name": "sw-context-token", - "in": "header" - } - } - }, - "security": [ - { - "ApiKey": [] - } - ], - "paths": { - "/role/create": { - "post": { + "patch": { "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", - "parameters": [], + "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 role to be updated", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "requestBody": { "required": true, "content": { @@ -17066,18 +18432,18 @@ "schema": { "properties": { "name": { - "description": "Name of the new role", + "description": "New name of the role", "type": "string" }, "permissions": { - "description": "Permissions of the new role", + "description": "New permissions of the role", "type": "array", "items": { "type": "string" } }, "isDefaultRole": { - "description": "Ability to set the new role as default", + "description": "Ability to set the role as default", "type": "boolean" } }, @@ -17103,16 +18469,150 @@ "ApiKey": [] } ] + }, + "delete": { + "tags": [ + "B2B Employee Management" + ], + "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 role to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "No content response" + } + }, + "security": [ + { + "ApiKey": [] + } + ] } }, - "/role": { + "/role/default": { + "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": [ + { + "ApiKey": [] + } + ] + } + }, + "/employee/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", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "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", + "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" + } + } + } + }, + "responses": { + "200": { + "description": "Employee entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + }, + "/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 +18630,7 @@ }, "responses": { "200": { - "description": "Entity search result containing roles", + "description": "Entity search result containing employees", "content": { "application/json": { "schema": { @@ -17141,7 +18641,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } }, @@ -17166,9 +18666,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 +18686,7 @@ }, "responses": { "200": { - "description": "Entity search result containing roles", + "description": "Entity search result containing employees", "content": { "application/json": { "schema": { @@ -17197,7 +18697,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } }, @@ -17219,33 +18719,33 @@ ] } }, - "/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": "readB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the role to be fetched", + "description": "Identifier of the employee to be read", "required": true, "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "uuid" } } ], "responses": { "200": { - "description": "Role entity", + "description": "Employee entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -17261,14 +18761,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 +18782,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 +18806,11 @@ }, "responses": { "200": { - "description": "Role entity", + "description": "Employee entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -17325,14 +18826,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,22 +18853,34 @@ ] } }, - "/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", + "summary": "Reinvite employee by id", + "description": "This route is used to reinvite an employee via email by id", + "operationId": "reinviteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier of the employee to be reinvited", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { - "id": { - "description": "Id of the roleId to be set as default", + "storefrontUrl": { + "description": "URL of the storefront domain", "type": "string" } }, @@ -17377,8 +18890,15 @@ } }, "responses": { - "204": { - "description": "No content response" + "200": { + "description": "Employee entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } } }, "security": [ @@ -17528,62 +19048,72 @@ ] } }, - "/employee/create": { + "/sso/auth/{providerId}": { "post": { "tags": [ - "B2B Employee Management" + "Sso" ], - "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, - "content": { - "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", - "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" + "summary": "Authenticates via SSO", + "description": "Authenticates login via a given SSO provider ID", + "operationId": "auth", + "parameters": [ + { + "name": "providerId", + "in": "path", + "description": "Identifier of the SSO provider used to authenticate", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "Successfully authenticated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuccessResponse" + } } } } }, + "security": [ + { + "ApiKey": [] + } + ] + } + }, + "/sso/redirect/{providerId}": { + "post": { + "tags": [ + "Sso" + ], + "summary": "Redirects after authentication", + "description": "Redirects after authenticated login via a given SSO provider ID", + "operationId": "redirect", + "parameters": [ + { + "name": "providerId", + "in": "path", + "description": "Identifier of the SSO provider used to authenticate", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { - "200": { - "description": "Employee entity", + "204": { + "description": "Successfully authenticated", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/SuccessResponse" } } } @@ -17596,52 +19126,38 @@ ] } }, - "/employee": { - "get": { + "/quote/request": { + "post": { "tags": [ - "B2B Employee Management" + "B2B Quote Management" ], - "summary": "Fetch a list of employees", - "description": "This route is used to load employees", - "operationId": "readEmployees", + "summary": "Request new quote", + "description": "This route is used to request a new quote from the store", + "operationId": "requestQuote", "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Criteria" + "properties": { + "comment": { + "description": "Message content", + "type": "string" } - ] + }, + "type": "object" } } } }, "responses": { "200": { - "description": "Entity search result containing employees", + "description": "Quote entity", "content": { "application/json": { "schema": { - "type": "object", - "allOf": [ - { - "properties": { - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bEmployee" - } - } - }, - "type": "object" - }, - { - "$ref": "#/components/schemas/EntitySearchResult" - } - ] + "$ref": "#/components/schemas/Quote" } } } @@ -17652,14 +19168,16 @@ "ApiKey": [] } ] - }, + } + }, + "/quotes": { "post": { "tags": [ - "B2B Employee Management" + "B2B Quote Management" ], - "summary": "Fetch a list of employees", - "description": "This route is used to load employees", - "operationId": "readEmployeesPOST", + "summary": "Fetch a list of quotes", + "description": "This route is used to load quotes", + "operationId": "readQuotes", "parameters": [], "requestBody": { "required": false, @@ -17677,7 +19195,7 @@ }, "responses": { "200": { - "description": "Entity search result containing employees", + "description": "Entity search result containing quotes", "content": { "application/json": { "schema": { @@ -17688,7 +19206,7 @@ "elements": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/Quote" } } }, @@ -17710,19 +19228,19 @@ ] } }, - "/employee/{id}": { + "/quote/detail/{id}": { "post": { "tags": [ - "B2B Employee Management" + "B2B Quote Management" ], - "summary": "Fetch a one employee by id", - "description": "This route is used to fetch one employee by id", - "operationId": "readEmployee", + "summary": "Fetch a one quote by id", + "description": "This route is used to fetch one quote by id", + "operationId": "readQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be fetched", + "description": "Identifier of the quote to be fetched", "required": true, "schema": { "type": "string", @@ -17730,13 +19248,27 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Criteria" + } + ] + } + } + } + }, "responses": { "200": { - "description": "Employee entity", + "description": "Quote entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -17746,20 +19278,22 @@ { "ApiKey": [] } - ] - }, - "patch": { + ] + } + }, + "/quote/{id}/decline": { + "post": { "tags": [ - "B2B Employee Management" + "B2B Quote Management" ], - "summary": "Update one employee by id", - "description": "This route is used to update one employee by id", - "operationId": "updateEmployee", + "summary": "Decline a quote by id", + "description": "This route is used to decline a quote from the store by id", + "operationId": "declineQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be updated", + "description": "Identifier of the quote to be reinvited", "required": true, "schema": { "type": "string", @@ -17768,25 +19302,13 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "properties": { - "firstName": { - "description": "New first name of the employee", - "type": "string" - }, - "lastName": { - "description": "New last name of the employee", - "type": "string" - }, - "email": { - "description": "New email of the employee", - "type": "string" - }, - "roleId": { - "description": "New id of the role of the employee", + "comment": { + "description": "Message content", "type": "string" } }, @@ -17796,15 +19318,8 @@ } }, "responses": { - "200": { - "description": "Employee entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/B2bEmployee" - } - } - } + "204": { + "description": "No content response" } }, "security": [ @@ -17812,19 +19327,21 @@ "ApiKey": [] } ] - }, - "delete": { + } + }, + "/quote/{id}/request-change": { + "post": { "tags": [ - "B2B Employee Management" + "B2B Quote Management" ], - "summary": "Delete one employee by id", - "description": "This route is used to delete one employee by id", - "operationId": "deleteEmployee", + "summary": "Request change a quote by id", + "description": "This route is used to request change a quote from the store by id", + "operationId": "requestChangeQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be deleted", + "description": "Identifier of the quote to be reinvited", "required": true, "schema": { "type": "string", @@ -17832,6 +19349,22 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { + "description": "Message content", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "204": { "description": "No content response" @@ -17844,19 +19377,19 @@ ] } }, - "/employee/reinvite/{id}": { + "/quote/{id}/configure": { "post": { "tags": [ - "B2B Employee Management" + "B2B Quote Management" ], - "summary": "Reinvite employee by id", - "description": "This route is used to reinvite an employee via email by id", - "operationId": "reinviteEmployee", + "summary": "Change payment or shipping method", + "description": "This route is used to change a payment or shipping method when place a order ", + "operationId": "switchPaymentOrShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the employee to be reinvited", + "description": "Identifier of the quote to be reinvited", "required": true, "schema": { "type": "string", @@ -17870,8 +19403,12 @@ "application/json": { "schema": { "properties": { - "storefrontUrl": { - "description": "URL of the storefront domain", + "paymentMethodId": { + "description": "Id of the payment method", + "type": "string" + }, + "shippingMethodId": { + "description": "Id of the shipping method", "type": "string" } }, @@ -17881,15 +19418,8 @@ } }, "responses": { - "200": { - "description": "Employee entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/B2bEmployee" - } - } - } + "204": { + "description": "No content response" } }, "security": [ @@ -17899,19 +19429,19 @@ ] } }, - "/sso/auth/{providerId}": { + "/quote/order/{id}": { "post": { "tags": [ - "Sso" + "B2B Quote Management" ], - "summary": "Authenticates via SSO", - "description": "Authenticates login via a given SSO provider ID", - "operationId": "auth", + "summary": "Create a order from a quote", + "description": "This route is used to create a order from a quote", + "operationId": "createOrderFromQuote", "parameters": [ { - "name": "providerId", + "name": "id", "in": "path", - "description": "Identifier of the SSO provider used to authenticate", + "description": "Identifier of the quote to be reinvited", "required": true, "schema": { "type": "string", @@ -17919,13 +19449,29 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "customerComment": { + "description": "Message content", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "Successfully authenticated", + "200": { + "description": "Order entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SuccessResponse" + "$ref": "#/components/schemas/Order" } } } @@ -17938,19 +19484,29 @@ ] } }, - "/sso/redirect/{providerId}": { + "/quote/document/download/{documentId}/{deepLinkCode}": { "post": { "tags": [ - "Sso" + "B2B Quote Management" ], - "summary": "Redirects after authentication", - "description": "Redirects after authenticated login via a given SSO provider ID", - "operationId": "redirect", + "summary": "Download a document", + "description": "This route is used to download a document", + "operationId": "downloadQuoteDocument", "parameters": [ { - "name": "providerId", + "name": "documentId", "in": "path", - "description": "Identifier of the SSO provider used to authenticate", + "description": "Identifier of the quote document to be reinvited", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "Deep link code of the quote document", "required": true, "schema": { "type": "string", @@ -17959,15 +19515,8 @@ } ], "responses": { - "204": { - "description": "Successfully authenticated", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SuccessResponse" - } - } - } + "200": { + "description": "Document content response" } }, "security": [ @@ -17977,15 +19526,26 @@ ] } }, - "/quote/request": { + "/quote/{id}/send-message": { "post": { "tags": [ "B2B Quote Management" ], - "summary": "Request new quote", - "description": "This route is used to request a new quote from the store", - "operationId": "requestQuote", - "parameters": [], + "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": { @@ -18003,15 +19563,8 @@ } }, "responses": { - "200": { - "description": "Quote entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Quote" - } - } - } + "204": { + "description": "No content response" } }, "security": [ @@ -18021,123 +19574,95 @@ ] } }, - "/quotes": { + "/product/natural-language/search-term": { "post": { "tags": [ - "B2B Quote Management" + "Natural language search", + "AI Search" ], - "summary": "Fetch a list of quotes", - "description": "This route is used to load quotes", - "operationId": "readQuotes", - "parameters": [], + "summary": "Fetch search terms by natural language search query", + "description": "Fetch search terms by natural search language query", + "operationId": "naturalLanguageSearchTerm", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "query": { + "description": "Natural language query", + "type": "string", + "example": "I'm looking for a present for my wife" } - ] + } } } } }, "responses": { "200": { - "description": "Entity search result containing quotes", + "description": "A collection of search terms, with an associated 'reason' based on search context", "content": { "application/json": { "schema": { - "type": "object", - "allOf": [ - { - "properties": { - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Quote" - } - } - }, - "type": "object" - }, - { - "$ref": "#/components/schemas/EntitySearchResult" - } - ] - } - } - } - } - }, - "security": [ - { - "ApiKey": [] + "$ref": "#/components/schemas/NaturalLanguageSearchTermResponse" + } + } + } } - ] + } } }, - "/quote/detail/{id}": { + "/product/image-upload-search/search-term": { "post": { "tags": [ - "B2B Quote Management" + "Search by Image", + "AI Search" ], - "summary": "Fetch a one quote by id", - "description": "This route is used to fetch one quote by id", - "operationId": "readQuote", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Fetch product search terms by uploading an image.", + "description": "Fetch product search terms by uploading an image.", + "operationId": "searchByImageSearchTerm", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file": { + "description": "Base-64 encoded image", + "type": "string", + "format": "binary" + } + } + } } } - ], + }, "responses": { "200": { - "description": "Quote entity", + "description": "A collection of search terms", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/SearchByImageSearchTermResponse" } } } } - }, - "security": [ - { - "ApiKey": [] - } - ] + } } }, - "/quote/{id}/decline": { + "/pending-order/request": { "post": { "tags": [ - "B2B Quote Management" - ], - "summary": "Decline a quote by id", - "description": "This route is used to decline a quote from the store by id", - "operationId": "declineQuote", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the quote to be reinvited", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "B2B Order Approval" ], + "summary": "Request new order approval", + "description": "This route is used to request a new order approval", + "operationId": "requestOrderApproval", + "parameters": [], "requestBody": { "required": false, "content": { @@ -18155,8 +19680,15 @@ } }, "responses": { - "204": { - "description": "No content response" + "200": { + "description": "Pending order entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PendingOrder" + } + } + } } }, "security": [ @@ -18166,19 +19698,19 @@ ] } }, - "/quote/{id}/request-change": { + "/pending-order/{id}": { "post": { "tags": [ - "B2B Quote Management" + "B2B Order Approval" ], - "summary": "Request change a quote by id", - "description": "This route is used to request change a quote from the store by id", - "operationId": "requestChangeQuote", + "summary": "Fetch one pending order by id", + "description": "This route is used to fetch a pending order from the store by id", + "operationId": "fetchPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the quote to be reinvited", + "description": "Identifier of the pending order to be fetched", "required": true, "schema": { "type": "string", @@ -18186,27 +19718,18 @@ } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "comment": { - "description": "Message content", - "type": "string" - } - }, - "type": "object" + "responses": { + "200": { + "description": "Pending order entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PendingOrder" + } } } } }, - "responses": { - "204": { - "description": "No content response" - } - }, "security": [ { "ApiKey": [] @@ -18214,19 +19737,19 @@ ] } }, - "/quote/{id}/configure": { + "/pending-order/{id}/decline": { "post": { "tags": [ - "B2B Quote Management" + "B2B Order Approval" ], - "summary": "Change payment or shipping method", - "description": "This route is used to change a payment or shipping method when place a order ", - "operationId": "switchPaymentOrShippingMethod", + "summary": "Decline a pending order by id", + "description": "This route is used to decline a pending order from the store by id", + "operationId": "declinePendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the quote to be reinvited", + "description": "Identifier of the pending order to be declined", "required": true, "schema": { "type": "string", @@ -18240,12 +19763,8 @@ "application/json": { "schema": { "properties": { - "paymentMethodId": { - "description": "Id of the payment method", - "type": "string" - }, - "shippingMethodId": { - "description": "Id of the shipping method", + "comment": { + "description": "Message content", "type": "string" } }, @@ -18266,19 +19785,19 @@ ] } }, - "/quote/order/{id}": { + "/pending-order/{id}/approve": { "post": { "tags": [ - "B2B Quote Management" + "B2B Order Approval" ], - "summary": "Create a order from a quote", - "description": "This route is used to create a order from a quote", - "operationId": "createOrderFromQuote", + "summary": "Approve a pending order by id", + "description": "This route is used to approve a pending order from the store by id", + "operationId": "approvePendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the quote to be reinvited", + "description": "Identifier of the pending order to be approved", "required": true, "schema": { "type": "string", @@ -18292,7 +19811,7 @@ "application/json": { "schema": { "properties": { - "customerComment": { + "comment": { "description": "Message content", "type": "string" } @@ -18303,15 +19822,8 @@ } }, "responses": { - "200": { - "description": "Order entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } + "204": { + "description": "No content response" } }, "security": [ @@ -18321,29 +19833,19 @@ ] } }, - "/quote/document/download/{documentId}/{deepLinkCode}": { + "/pending-order/{id}/checkout/order": { "post": { "tags": [ - "B2B Quote Management" + "B2B Order Approval" ], - "summary": "Download a document", - "description": "This route is used to download a document", - "operationId": "downloadQuoteDocument", + "summary": "Create a order from a pending order", + "description": "This route is used to create a order from a pending order", + "operationId": "createOrderFromPendingOrder", "parameters": [ { - "name": "documentId", - "in": "path", - "description": "Identifier of the quote document to be reinvited", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "deepLinkCode", + "name": "id", "in": "path", - "description": "Deep link code of the quote document", + "description": "Identifier of the pending order to be used to create a order", "required": true, "schema": { "type": "string", @@ -18351,98 +19853,39 @@ } } ], - "responses": { - "200": { - "description": "Document content response" - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - }, - "/product/natural-language/search-term": { - "post": { - "tags": [ - "Natural language search", - "AI Search", - "Experimental" - ], - "summary": "Fetch search terms by natural language search query", - "description": "Experimental until v6.7.0\n\nFetch search terms by natural search language query", - "operationId": "naturalLanguageSearchTerm", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "query": { - "description": "Natural language query", - "type": "string", - "example": "I'm looking for a present for my wife" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "A collection of search terms, with an associated 'reason' based on search context", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NaturalLanguageSearchTermResponse" - } - } - } - } - } - } - }, - "/product/image-upload-search/search-term": { - "post": { - "tags": [ - "Search by Image", - "AI Search", - "Experimental" - ], - "summary": "Fetch product search terms by uploading an image.", - "description": "Experimental until v6.7.0\n\nFetch product search terms by uploading an image.", - "operationId": "searchByImageSearchTerm", "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "file": { - "description": "Base-64 encoded image", - "type": "string", - "format": "binary" + "properties": { + "customerComment": { + "description": "Message content", + "type": "string" } - } + }, + "type": "object" } } } }, "responses": { "200": { - "description": "A collection of search terms", + "description": "Order entity", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchByImageSearchTermResponse" + "$ref": "#/components/schemas/Order" } } } } - } + }, + "security": [ + { + "ApiKey": [] + } + ] } }, "/approval-rule": { @@ -18597,7 +20040,7 @@ "operationId": "createApprovalRule", "parameters": [], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { @@ -18723,7 +20166,7 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { @@ -18791,240 +20234,6 @@ ] } }, - "/pending-order/request": { - "post": { - "tags": [ - "B2B Order Approval" - ], - "summary": "Request new order approval", - "description": "This route is used to request a new order approval", - "operationId": "requestOrderApproval", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "comment": { - "description": "Message content", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Pending order entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PendingOrder" - } - } - } - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - }, - "/pending-order/{id}": { - "post": { - "tags": [ - "B2B Order Approval" - ], - "summary": "Fetch one pending order by id", - "description": "This route is used to fetch a pending order from the store by id", - "operationId": "fetchPendingOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the pending order to be fetched", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Pending order entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PendingOrder" - } - } - } - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - }, - "/pending-order/{id}/decline": { - "post": { - "tags": [ - "B2B Order Approval" - ], - "summary": "Decline a pending order by id", - "description": "This route is used to decline a pending order from the store by id", - "operationId": "declinePendingOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the pending order to be declined", - "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": [] - } - ] - } - }, - "/pending-order/{id}/approve": { - "post": { - "tags": [ - "B2B Order Approval" - ], - "summary": "Approve a pending order by id", - "description": "This route is used to approve a pending order from the store by id", - "operationId": "approvePendingOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the pending order to be approved", - "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": [] - } - ] - } - }, - "/pending-order/{id}/checkout/order": { - "post": { - "tags": [ - "B2B Order Approval" - ], - "summary": "Create a order from a pending order", - "description": "This route is used to create a order from a pending order", - "operationId": "createOrderFromPendingOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the pending order to be used to create a order", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "customerComment": { - "description": "Message content", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Order entity", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - }, "/shopping-list": { "post": { "tags": [ diff --git a/SwagCommercial-storeapi.summary.json b/SwagCommercial-storeapi.summary.json index 318fb70..cf24ff6 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", @@ -69,10 +70,13 @@ "AppShippingMethod", "AppTemplate", "ApprovalRule", + "Association", "Associations", "B2bBusinessPartner", "B2bComponentsApprovalRule", "B2bComponentsApprovalRuleAppScriptCondition", + "B2bComponentsOrganization", + "B2bComponentsOrganizationCustomerAddress", "B2bComponentsPendingOrder", "B2bComponentsPendingOrderAddress", "B2bComponentsRole", @@ -148,6 +152,7 @@ "LanguageJsonApi", "LineItem", "LineItemType", + "ListPrice", "Locale", "LogEntry", "MailHeaderFooter", @@ -239,9 +244,11 @@ "QuoteDeliveryPosition", "QuoteDocument", "QuoteEmployee", + "QuoteJsonApi", "QuoteLineItem", "QuoteTransaction", "RangeFilter", + "ReferencePrice", "Rule", "RuleCondition", "SalesChannel",