From 9ae6cb8e4379ba17210297fc23de79f14ebfa104 Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Wed, 8 Jul 2026 09:51:15 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagCommercial-storeapi.json | 25240 ++++++++++++++++----------------- 1 file changed, 12491 insertions(+), 12749 deletions(-) diff --git a/SwagCommercial-storeapi.json b/SwagCommercial-storeapi.json index e9859e8..4fc9a11 100644 --- a/SwagCommercial-storeapi.json +++ b/SwagCommercial-storeapi.json @@ -2842,130 +2842,6 @@ }, "type": "object" }, - "BundleDiscount": { - "description": "Added since version: 6.7.9.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "description": "Version identifier of the bundle discount entity.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "type": { - "type": "string", - "enum": [ - "absolute", - "percentage" - ] - }, - "value": { - "type": "number" - }, - "maxValue": { - "type": "number" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "preventCombination": { - "type": "boolean" - }, - "active": { - "type": "boolean" - }, - "apiAlias": { - "type": "string", - "example": "bundle_discount" - } - }, - "type": "object", - "required": [ - "id", - "type", - "value" - ] - }, - "BundleItem": { - "description": "Added since version: 6.7.9.0", - "required": [ - "productId", - "quantity", - "min", - "required", - "id" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "description": "Version identifier of the bundle item entity.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "bundleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "minimum": 1 - }, - "min": { - "type": "integer", - "minimum": 1 - }, - "max": { - "type": "integer" - }, - "required": { - "type": "boolean" - }, - "position": { - "type": "integer" - }, - "showBundleOnItemPdp": { - "type": "boolean" - }, - "product": { - "type": "object" - }, - "apiAlias": { - "type": "string", - "example": "bundle_item" - } - }, - "type": "object" - }, "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -3330,399 +3206,315 @@ } ] }, - "Category": { + "CountryJsonApi": { "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "breadcrumb", - "children", - "childCount", - "translated", - "type", - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" - }, - "breadcrumb": { - "type": "array", - "items": { - "type": "string", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true - }, - "childCount": { - "type": "number", - "format": "int64", - "readOnly": true - }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" - }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "keywords": { - "type": "string" - }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customEntityTypeId": { + { + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" + }, + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" + }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "description": "States/provinces/regions within the country", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Country": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true + "name": { + "type": "string" }, - "seoUrl": { - "description": "Runtime field, cannot be used as part of the criteria.", + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" }, - "translated": { - "type": "object", - "additionalProperties": true, - "properties": { - "breadcrumb": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "breadcrumb" - ] + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" }, - "parent": { - "$ref": "#/components/schemas/Category", - "description": "Unique identity of category." + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" }, - "children": { - "description": "Child categories within this category for hierarchical navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Category image or banner" - }, - "tags": { - "description": "Tags for organizing and filtering categories", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the category" - }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "category" - ] - } - }, - "type": "object" - }, - "CmsBlock": { - "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "slots", - "id", - "position", - "type", - "sectionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", - "type": "integer", - "format": "int64" - }, - "type": { - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", - "type": "string" - }, - "name": { - "description": "Unique name of the CMS Block.", - "type": "string" - }, - "sectionPosition": { - "description": "Position of the section. It can either be `main` or `sidebar`.", - "type": "string" - }, - "marginTop": { - "description": "Defines the margin area on the top of an element.", - "type": "string" - }, - "marginBottom": { - "description": "Defines for the margin area on the bottom of an element.", - "type": "string" - }, - "marginLeft": { - "description": "Defines for the margin area on the left of an element.", - "type": "string" - }, - "marginRight": { - "description": "Defines the margin area on the right of an element.", - "type": "string" + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" }, - "backgroundColor": { - "description": "Defines the background color of an element.", - "type": "string" + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" }, - "backgroundMediaId": { - "description": "Unique identity of background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" }, - "backgroundMediaMode": { - "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" + "customFields": { + "type": "object" }, - "visibility": { + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], "properties": { - "mobile": { + "enabled": { "type": "boolean" }, - "desktop": { - "type": "boolean" + "currencyId": { + "type": "string" }, - "tablet": { - "type": "boolean" + "amount": { + "type": "number", + "format": "float" } }, "type": "object" }, - "sectionId": { - "description": "Unique identity of section.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" - }, - "slots": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "cms_block" - ] - } - }, - "type": "object" - }, - "CmsPage": { - "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "sections", - "id", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" }, - "type": { - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", - "type": "string" + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" }, - "entity": { - "description": "This field will be implemented in the future.", - "type": "string" + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, - "config": { - "properties": { - "backgroundColor": { - "type": "string" - } - }, + "addressFormat": { "type": "object" }, - "previewMediaId": { - "description": "Unique identity of media to be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" }, - "customFields": { - "type": "object" + "isEu": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -3737,198 +3529,113 @@ "translated": { "type": "object" }, - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", + "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CountryState" } + } + }, + "type": "object" + }, + "CountryStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "previewMedia": { - "$ref": "#/components/schemas/Media", - "description": "Preview image for the CMS page in admin panel and page selection" - }, - "landingPages": { - "description": "Landing pages using this CMS layout", - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "cms_page" - ] - } - }, - "type": "object" - }, - "CmsSection": { - "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "blocks", - "id", - "position", - "type", - "pageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", - "type": "integer", - "format": "int64" - }, - "type": { - "description": "Types of sections can be `default` or `sidebar`.", - "type": "string", - "enum": [ - "default", - "sidebar" - ] - }, - "name": { - "description": "Name of the CMS section defined.", - "type": "string" - }, - "sizingMode": { - "description": "Sizing mode can be `boxed` or `full_width`.", - "type": "string" - }, - "mobileBehavior": { - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", - "type": "string" - }, - "backgroundColor": { - "description": "Background color of CMS page.", - "type": "string" - }, - "backgroundMediaId": { - "description": "Unique identity of CMS section's background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode can be `cover`, `auto` or `contain`.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "pageId": { - "description": "Unique identity of page where CMS section is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { + { + "required": [ + "id", + "countryId", + "shortCode", + "name" + ], "properties": { - "mobile": { - "type": "boolean" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "desktop": { - "type": "boolean" + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "tablet": { + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "page": { - "$ref": "#/components/schemas/CmsPage" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" - }, - "blocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "cms_section" - ] } - }, - "type": "object" + ] }, - "CmsSlot": { + "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", "id", - "type", - "slot", - "blockId" + "countryId", + "shortCode", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsBlockVersionId": { + "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fieldConfig": { - "type": "object" - }, - "type": { - "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, - "slot": { - "description": "Key-value pair to configure which element to be shown in which slot.", + "name": { "type": "string" }, - "locked": { - "type": "boolean" + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" }, - "config": { - "type": "object" + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "type": "boolean" }, "customFields": { "type": "object" }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "description": "Unique identity of CMS block where slot is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -3941,20 +3648,11 @@ }, "translated": { "type": "object" - }, - "block": { - "$ref": "#/components/schemas/CmsBlock" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cms_slot" - ] } }, "type": "object" }, - "CountryJsonApi": { + "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -3963,127 +3661,97 @@ { "required": [ "id", - "name", - "addressFormat" + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" + }, + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" + }, + "shortName": { + "type": "string" + }, + "name": { "type": "string" }, "position": { - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", - "type": "boolean" - }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", - "type": "string" - }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" - }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" - }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" - }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", - "type": "boolean" - }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" }, "customFields": { "type": "object" }, - "customerTax": { + "itemRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "companyTax": { + "totalRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "postalCodeRequired": { - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", - "type": "boolean" - }, - "checkPostalCodePattern": { - "description": "Verify for valid postal code pattern.", - "type": "boolean" - }, - "checkAdvancedPostalCodePattern": { - "description": "Verify for advanced postal code pattern.", - "type": "boolean" - }, - "advancedPostalCodePattern": { - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", - "type": "string" - }, - "addressFormat": { - "type": "object" - }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -4096,173 +3764,149 @@ }, "translated": { "type": "object" - }, - "relationships": { - "properties": { - "states": { - "description": "States/provinces/regions within the country", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country_state" - }, - "id": { - "type": "string", - "example": "34d955a0df5f7af9c9b4e4dccb3c3564" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" } }, "type": "object" } ] }, - "Country": { + "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "addressFormat" + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, - "position": { - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", - "type": "boolean" - }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", - "type": "boolean" - }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" + "shortName": { + "type": "string" }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" + "name": { + "type": "string" }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" }, "customFields": { "type": "object" }, - "customerTax": { + "itemRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "companyTax": { + "totalRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "postalCodeRequired": { - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", - "type": "boolean" - }, - "checkPostalCodePattern": { - "description": "Verify for valid postal code pattern.", - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "checkAdvancedPostalCodePattern": { - "description": "Verify for advanced postal code pattern.", - "type": "boolean" - }, - "advancedPostalCodePattern": { - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "addressFormat": { + "translated": { "type": "object" + } + }, + "type": "object" + }, + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "isEu": { - "type": "boolean" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -4273,115 +3917,98 @@ "type": "string", "format": "date-time", "readOnly": true + } + }, + "type": "object" + }, + "CustomField": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "states": { - "description": "States/provinces/regions within the country", - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "CountryStateJsonApi": { + "CustomFieldSet": { "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "required": [ - "id", - "countryId", - "shortCode", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of the country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - } - }, - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } - ] + }, + "type": "object" }, - "CountryState": { + "CustomFieldSetRelation": { "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" + }, + "CustomPrice": { "required": [ "id", - "countryId", - "shortCode", - "name" + "productId", + "price" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of the country.", + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { + "price": { "type": "object" }, "createdAt": { @@ -4394,13 +4021,19 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "CurrencyJsonApi": { + "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -4409,96 +4042,96 @@ { "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" + "customerId": { + "description": "Unique identity of customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", - "type": "string" + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "shortName": { + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "name": { + "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" + "city": { + "description": "Name of customer's city.", + "type": "string" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "company": { + "description": "Name of customer's company.", + "type": "string" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "isDefaultBillingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "isDefaultShippingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -4510,7 +4143,132 @@ "format": "date-time", "readOnly": true }, - "translated": { + "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" + }, + "relationships": { + "properties": { + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "countryState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cb6a9764567191fb74fe28d8d6a4819d" + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + } + }, "type": "object" } }, @@ -4518,99 +4276,41 @@ } ] }, - "Currency": { - "description": "Added since version: 6.0.0.0", + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomerSpecificFeatures": { "required": [ - "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" + "customerId", + "features" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" - }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", - "type": "string" - }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" - }, - "shortName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" - }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" - }, - "customFields": { - "type": "object" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "features": { "type": "object" }, "createdAt": { @@ -4623,39 +4323,56 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "customer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "CurrencyCountryRounding": { - "description": "Added since version: 6.4.0.0", + "CustomerTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "customerId", + "tagId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "customerId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "tagId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "CustomEntity": { - "description": "Added since version: 6.4.9.0", + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "customerId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -4665,34 +4382,33 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } } }, "type": "object" }, - "CustomField": { - "description": "Added since version: 6.0.0.0", + "CustomerWishlistProduct": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "productId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "productId": { + "description": "Unique identity of the product.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "CustomFieldSet": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -4709,13 +4425,40 @@ }, "type": "object" }, - "CustomFieldSetRelation": { + "DeliveryTime": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "min", + "max", + "unit" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" + }, + "max": { + "description": "Maximum delivery time taken.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -4725,38 +4468,56 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "CustomPrice": { + "DocumentBaseConfig": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "price" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Name of the document.", + "type": "string" }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" }, - "price": { + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" + }, + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", + "type": "boolean" + }, + "documentNumber": { + "description": "Unique number associated with every document.", + "type": "string" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -4764,47 +4525,35 @@ "format": "date-time", "readOnly": true }, + "config": { + "type": "object", + "deprecated": true + }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "product": { - "$ref": "#/components/schemas/Product" + "logo": { + "$ref": "#/components/schemas/Media", + "description": "Logo in the document at the top-right corner." } }, "type": "object" }, - "Customer": { + "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", - "activeBillingAddress", - "activeShippingAddress", "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "description": "Unique identity of customer group.", + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -4813,144 +4562,189 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of language.", + "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "lastPaymentMethodId": { - "description": "Unique identity of previous payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerNumber": { - "description": "Unique number assigned to identity a customer.", - "type": "string" - }, - "salutationId": { - "description": "Unique identity of salutation.", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "DocumentType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "email": { - "description": "Email ID of the customer.", - "type": "string" - }, - "title": { - "description": "Titles or honorifics like Mr, Mrs, etc.", - "type": "string" - }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "name": { "type": "string" }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", + "technicalName": { + "description": "Technical name of document type.", "type": "string" }, - "active": { - "description": "To keep the status of the customer active, the boolean value is set to `true`.", - "type": "boolean" - }, - "doubleOptInRegistration": { - "description": "Set to `true` to allow user subscriptions to an email marketing list.", - "type": "boolean" + "customFields": { + "type": "object" }, - "doubleOptInEmailSentDate": { - "description": "Date and time when the double opt-in email was sent.", + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - "doubleOptInConfirmDate": { - "description": "Date and time when the double opt-in email was confirmed.", + "updatedAt": { "type": "string", - "format": "date-time" - }, - "hash": { - "description": "Customer registration double opt-in hash for confirming the customer account.", - "type": "string" + "format": "date-time", + "readOnly": true }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", - "type": "boolean" + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "Flow": { + "description": "Added since version: 6.4.6.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "firstLogin": { - "description": "To capture date and time of customer's first login.", + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - "lastLogin": { - "description": "To capture date and time of customer's last login.", + "updatedAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "FlowSequence": { + "description": "Added since version: 6.4.6.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "birthday": { - "description": "To capture customer's birthday details.", - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "lastOrderDate": { - "description": "Captures last order date.", + "updatedAt": { "type": "string", "format": "date-time", "readOnly": true + } + }, + "type": "object" + }, + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderCount": { - "description": "Captures the number of orders placed.", - "type": "integer", - "format": "int64", + "createdAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "orderTotalAmount": { - "description": "Sum of total amount to be paid.", - "type": "number", - "format": "float", + "updatedAt": { + "type": "string", + "format": "date-time", "readOnly": true + } + }, + "type": "object" + }, + "ImportExportFile": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", + "createdAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ImportExportLog": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, + "createdAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "requestedGroupId": { - "description": "Unique identity of requested group.", + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ImportExportProfile": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "updatedById": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "Integration": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -4963,235 +4757,62 @@ "type": "string", "format": "date-time", "readOnly": true + } + }, + "type": "object" + }, + "LandingPageJsonApi": { + "description": "Added since version: 6.4.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "extensions": { - "properties": { - "specificFeatures": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_specific_features" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "5cfb6fcb7542e25892e1a35cd6a06c54" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "group": { - "$ref": "#/components/schemas/CustomerGroup", - "description": "Customer group determining pricing and permissions" - }, - "language": { - "$ref": "#/components/schemas/Language", - "description": "Preferred language for customer communication" - }, - "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Last used payment method by the customer" - }, - "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Default billing address for the customer" - }, - "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Currently active billing address in the session" - }, - "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Default shipping address for the customer" - }, - "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Currently active shipping address in the session" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation", - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" - }, - "addresses": { - "description": "All addresses saved for the customer", - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "customer" - ] - } - }, - "type": "object", - "oneOf": [ - { - "required": [ - "accountType" - ], - "properties": { - "accountType": { - "type": "string", - "enum": [ - "private" - ] - } - } - }, - { - "required": [ - "accountType", - "vatIds", - "company" - ], - "properties": { - "accountType": { - "type": "string", - "enum": [ - "business" - ] - }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "company": { - "type": "string" - } - } - } - ] - }, - "CustomerAddressJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" - ], + { + "required": [ + "id", + "name", + "url" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of country's state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "description": "Unique identity of salutation.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "zipcode": { - "description": "Postal or zip code of customer's address.", - "type": "string" - }, - "city": { - "description": "Name of customer's city.", - "type": "string" - }, - "company": { - "description": "Name of customer's company.", - "type": "string" + "active": { + "type": "boolean" }, - "street": { - "description": "Name of customer's street.", + "name": { "type": "string" }, - "department": { - "description": "Name of customer's department.", - "type": "string" + "customFields": { + "type": "object" }, - "title": { - "description": "Titles given to customer like Dr. , Prof., etc", - "type": "string" + "slotConfig": { + "type": "object" }, - "phoneNumber": { - "description": "Customer's phone number.", + "metaTitle": { "type": "string" }, - "additionalAddressLine1": { - "description": "Additional customer's address information.", + "metaDescription": { "type": "string" }, - "additionalAddressLine2": { - "description": "Additional customer's address information.", + "keywords": { "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", + "url": { "type": "string" }, - "customFields": { - "type": "object" - }, - "isDefaultBillingAddress": { - "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isDefaultShippingAddress": { - "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -5203,45 +4824,13 @@ "format": "date-time", "readOnly": true }, - "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" - } - }, + "translated": { "type": "object" }, "relationships": { "properties": { - "country": { + "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -5249,7 +4838,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" } } }, @@ -5258,19 +4847,20 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, - "countryState": { + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -5278,7 +4868,100 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "LanguageJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "localeId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "description": "Unique identity of locale.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationCodeId": { + "description": "Unique identity of translation code.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the language.", + "type": "string" + }, + "active": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of language.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, @@ -5287,19 +4970,20 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "salutation": { + "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -5307,7 +4991,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, @@ -5316,12 +5000,74 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "fb216d9e8791e63c8d12bdc420956839" + } + } + } + }, + "type": "object" + }, + "translationCode": { + "description": "Locale used for translating content", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ef2035242b8fcb7b61c3a41850e60b3" + } + } + } + }, + "type": "object" + }, + "children": { + "description": "Child languages inheriting from this parent language", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } } } } @@ -5336,196 +5082,99 @@ } ] }, - "CustomerAddress": { + "Language": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" + "localeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { - "description": "Unique identity of country's state.", + "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { - "description": "Unique identity of salutation.", + "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", + "name": { + "description": "Name of the language.", "type": "string" }, - "zipcode": { - "description": "Postal or zip code of customer's address.", - "type": "string" + "active": { + "type": "boolean" }, - "city": { - "description": "Name of customer's city.", - "type": "string" + "customFields": { + "type": "object" }, - "company": { - "description": "Name of customer's company.", - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "street": { - "description": "Name of customer's street.", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "department": { - "description": "Name of customer's department.", - "type": "string" + "parent": { + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, - "title": { - "description": "Titles given to customer like Dr. , Prof., etc", - "type": "string" + "locale": { + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, - "phoneNumber": { - "description": "Customer's phone number.", - "type": "string" + "translationCode": { + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" }, - "additionalAddressLine1": { - "description": "Additional customer's address information.", - "type": "string" - }, - "additionalAddressLine2": { - "description": "Additional customer's address information.", - "type": "string" - }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "isDefaultBillingAddress": { - "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "isDefaultShippingAddress": { - "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "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" + "children": { + "description": "Child languages inheriting from this parent language", + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } } }, "type": "object" }, - "CustomerGroup": { + "Locale": { "description": "Added since version: 6.0.0.0", "required": [ - "translated", "id", - "name" + "code", + "name", + "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, - "displayGross": { - "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "registrationActive": { - "description": "To enable the registration of partner customer group.", - "type": "boolean" - }, - "registrationTitle": { + "name": { "type": "string" }, - "registrationIntroduction": { + "territory": { "type": "string" }, - "registrationOnlyCompanyRegistration": { - "type": "boolean" - }, - "registrationSeoMetaDescription": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -5538,27 +5187,13 @@ "readOnly": true }, "translated": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "registrationIntroduction": { - "type": "string" - }, - "registrationSeoMetaDescription": { - "type": "string" - }, - "registrationTitle": { - "type": "string" - } - } + "type": "object" } }, "type": "object" }, - "CustomerRecovery": { - "description": "Added since version: 6.1.0.0", + "LogEntry": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", @@ -5577,22 +5212,36 @@ }, "type": "object" }, - "CustomerSpecificFeatures": { + "MailHeaderFooter": { + "description": "Added since version: 6.0.0.0", "required": [ - "customerId", - "features" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "systemDefault": { + "type": "boolean" }, - "features": { - "type": "object" + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headerHtml": { + "type": "string" + }, + "headerPlain": { + "type": "string" + }, + "footerHtml": { + "type": "string" + }, + "footerPlain": { + "type": "string" }, "createdAt": { "type": "string", @@ -5604,52 +5253,35 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" + "translated": { + "type": "object" } }, "type": "object" }, - "CustomerTag": { + "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "customerId", - "tagId" + "subject", + "contentHtml", + "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "systemDefault": { + "type": "boolean" }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "senderName": { + "type": "string" }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "CustomerWishlist": { - "description": "Added since version: 6.3.4.0", - "required": [ - "id", - "customerId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "contentHtml": { + "type": "string" }, - "customerId": { - "description": "Unique identity of the customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "contentPlain": { + "type": "string" }, "customFields": { "type": "object" @@ -5664,56 +5296,62 @@ "format": "date-time", "readOnly": true }, - "products": { + "translated": { + "type": "object" + }, + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "media": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/MailTemplateMedia" } } }, "type": "object" }, - "CustomerWishlistProduct": { - "description": "Added since version: 6.3.4.0", + "MailTemplateMedia": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId" + "mailTemplateId", + "languageId", + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", + "mailTemplateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "mediaId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "position": { + "type": "integer", + "format": "int64" + }, + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "DeliveryTime": { + "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "min", - "max", - "unit" + "technicalName", + "name" ], "properties": { "id": { @@ -5723,18 +5361,8 @@ "name": { "type": "string" }, - "min": { - "description": "Minimum delivery time taken.", - "type": "integer", - "format": "int64" - }, - "max": { - "description": "Maximum delivery time taken.", - "type": "integer", - "format": "int64" - }, - "unit": { - "description": "Unit in which the delivery time is defined. For example, days or hours.", + "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "customFields": { @@ -5756,74 +5384,98 @@ }, "type": "object" }, - "Document": { - "description": "Added since version: 6.0.0.0", + "MainCategoryJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "categoryId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "description": "Unique identity of the category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "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" + } + ] + }, + "MainCategory": { + "description": "Added since version: 6.1.0.0", "required": [ "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode" + "productId", + "categoryId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedDocumentId": { + "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentMediaFileId": { + "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentA11yMediaFileId": { + "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "required": [ - "name", - "title" - ] - }, - "sent": { - "type": "boolean" - }, - "static": { - "type": "boolean" - }, - "deepLinkCode": { - "type": "string" - }, - "documentNumber": { - "type": "string" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -5833,125 +5485,79 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "referencedDocument": { - "$ref": "#/components/schemas/Document" - }, - "dependentDocuments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" - }, - "documentA11yMediaFile": { - "$ref": "#/components/schemas/Media" - }, - "fileType": { - "type": "string" } }, "type": "object" }, - "DocumentBaseConfig": { - "description": "Added since version: 6.0.0.0", + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "documentTypeId", - "name" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "description": "Unique identity of the document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "logoId": { - "description": "Unique identity of the company logo.", + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the document.", - "type": "string" + "default": { + "type": "boolean" }, - "filenamePrefix": { - "description": "A prefix name added to the file name separated by an underscore.", + "type": { "type": "string" }, - "filenameSuffix": { - "description": "A suffix name added to the file name separated by an underscore.", + "shortName": { "type": "string" }, - "global": { - "description": "When set to `true`, the document can be used across all sales channels.", - "type": "boolean" - }, - "documentNumber": { - "description": "Unique number associated with every document.", - "type": "string" + "factor": { + "type": "number", + "format": "float" }, - "customFields": { - "type": "object" + "precision": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, - "config": { - "type": "object", - "deprecated": true - }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "logo": { - "$ref": "#/components/schemas/Media", - "description": "Logo in the document at the top-right corner." + "translated": { + "type": "object" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, - "DocumentBaseConfigSalesChannel": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "documentBaseConfigId" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentBaseConfigId": { - "description": "Unique identity of document's base config.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "description": "Unique identity of document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "technicalName": { + "type": "string" }, "createdAt": { "type": "string", @@ -5962,31 +5568,34 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } } }, "type": "object" }, - "DocumentType": { - "description": "Added since version: 6.0.0.0", + "MediaAiTag": { "required": [ - "id", - "technicalName", - "name" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "technicalName": { - "description": "Technical name of document type.", - "type": "string" - }, - "customFields": { - "type": "object" + "tags": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, "createdAt": { "type": "string", @@ -6000,12 +5609,15 @@ }, "translated": { "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "Flow": { - "description": "Added since version: 6.4.6.0", + "MediaDefaultFolder": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", @@ -6024,8 +5636,8 @@ }, "type": "object" }, - "FlowSequence": { - "description": "Added since version: 6.4.6.0", + "MediaFolder": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", @@ -6044,8 +5656,8 @@ }, "type": "object" }, - "FlowTemplate": { - "description": "Added since version: 6.4.18.0", + "MediaFolderConfiguration": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", @@ -6064,13 +5676,59 @@ }, "type": "object" }, - "ImportExportFile": { + "MediaTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "mediaId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "width", + "height" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -6084,7 +5742,34 @@ }, "type": "object" }, - "ImportExportLog": { + "NewsletterRecipientJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "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" + } + ] + }, + "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "properties": { "id": { @@ -6104,8 +5789,31 @@ }, "type": "object" }, - "ImportExportProfile": { + "Notification": { + "description": "Added since version: 6.4.7.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" + }, + "NumberRange": { "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], "properties": { "id": { "type": "string", @@ -6127,7 +5835,7 @@ }, "type": "object" }, - "Integration": { + "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "properties": { "id": { @@ -6147,151 +5855,61 @@ }, "type": "object" }, - "LandingPageJsonApi": { - "description": "Added since version: 6.4.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "NumberRangeState": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "required": [ - "id", - "name", - "url" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "url": { - "type": "string" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "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" - }, - "relationships": { - "properties": { - "cmsPage": { - "description": "CMS page layout for the landing page", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" - } - } - } - }, - "type": "object" - }, - "seoUrls": { - "description": "SEO-friendly URLs for the landing page across different sales channels", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "NumberRangeType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object" } - ] + }, + "type": "object" }, - "LandingPage": { - "description": "Added since version: 6.4.0.0", + "OrderAddress": { + "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", "id", - "name", - "url" + "countryId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { @@ -6302,37 +5920,71 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "countryStateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "customFields": { - "type": "object" + "lastName": { + "description": "Last name of the customer.", + "type": "string" }, - "slotConfig": { - "type": "object" + "street": { + "description": "Street address", + "type": "string" }, - "metaTitle": { + "zipcode": { + "description": "Zip code of the country.", "type": "string" }, - "metaDescription": { + "city": { + "description": "Name of the city.", "type": "string" }, - "keywords": { + "company": { + "description": "Name of the company.", "type": "string" }, - "url": { + "department": { + "description": "Name of the department.", "type": "string" }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": { + "description": "Title name given to customer like DR. , Prof., etc.", + "type": "string" }, - "cmsPageVersionId": { + "phoneNumber": { + "description": "Phone number of the customer.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "vatId": { + "description": "Unique identity of VAT.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "deprecated": true }, "createdAt": { "type": "string", @@ -6344,244 +5996,209 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "country": { + "$ref": "#/components/schemas/Country" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the landing page" + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "seoUrls": { - "description": "SEO-friendly URLs for the landing page across different sales channels", + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "OrderCustomer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "email", + "firstName", + "lastName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "email": { + "description": "Email address of the customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "title": { + "description": "Title name given to the customer like Dr, prof. etc.", + "type": "string" + }, + "vatIds": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "type": "string" } }, - "apiAlias": { + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", - "enum": [ - "landing_page" - ] + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "LanguageJsonApi": { + "OrderDelivery": { "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "required": [ + "id", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", + "stateId", + "shippingDateEarliest", + "shippingDateLatest" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "required": [ - "id", - "localeId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "localeId": { - "description": "Unique identity of locale.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationCodeId": { - "description": "Unique identity of translation code.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the language.", - "type": "string" - }, - "active": { - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of language.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } - } - }, - "type": "object" - }, - "locale": { - "description": "Locale defining regional settings (date, time, number formats)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "locale" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "fb216d9e8791e63c8d12bdc420956839" - } - } - } - }, - "type": "object" - }, - "translationCode": { - "description": "Locale used for translating content", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "locale" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "6ef2035242b8fcb7b61c3a41850e60b3" - } - } - } - }, - "type": "object" - }, - "children": { - "description": "Child languages inheriting from this parent language", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Language": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "localeId", - "name" - ], - "properties": { - "id": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { - "description": "Unique identity of locale.", + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { - "description": "Unique identity of translation code.", + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the language.", - "type": "string" + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", + "type": "string", + "format": "date-time" + }, + "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" }, "customFields": { "type": "object" @@ -6596,120 +6213,136 @@ "format": "date-time", "readOnly": true }, - "parent": { - "$ref": "#/components/schemas/Language", - "description": "Unique identity of language." + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, - "locale": { - "$ref": "#/components/schemas/Locale", - "description": "Locale defining regional settings (date, time, number formats)" + "shippingOrderAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, - "translationCode": { - "$ref": "#/components/schemas/Locale", - "description": "Locale used for translating content" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, - "children": { - "description": "Child languages inheriting from this parent language", + "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } }, "type": "object" }, - "Locale": { + "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "code", - "name", - "territory" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "description": "Code given to the locale. For example: en-CA.", - "type": "string" - }, - "name": { - "type": "string" - }, - "territory": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "LogEntry": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MailHeaderFooter": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" + "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" }, - "headerHtml": { - "type": "string" + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" }, - "headerPlain": { - "type": "string" + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" }, - "footerHtml": { - "type": "string" + "quantity": { + "description": "Number of items of each product.", + "type": "integer", + "format": "int64" }, - "footerPlain": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -6720,40 +6353,16 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" } }, "type": "object" }, - "MailTemplate": { - "description": "Added since version: 6.0.0.0", - "required": [ - "subject", - "contentHtml", - "contentPlain" - ], + "OrderProductWarehouse": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" - }, - "senderName": { - "type": "string" - }, - "contentHtml": { - "type": "string" - }, - "contentPlain": { - "type": "string" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -6763,184 +6372,153 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" - }, - "mailTemplateType": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateMedia" - } } }, "type": "object" }, - "MailTemplateMedia": { - "description": "Added since version: 6.0.0.0", + "OrderReturn": { "required": [ "id", - "mailTemplateId", - "languageId", - "mediaId" + "orderId", + "stateId", + "returnNumber", + "requestedAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" - }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "MailTemplateType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "technicalName": { - "description": "Technical name of mail template.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, "type": "object" - } - }, - "type": "object" - }, - "MainCategoryJsonApi": { - "description": "Added since version: 6.1.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { + "shippingCosts": { "required": [ - "id", - "productId", - "categoryId", - "salesChannelId" + "unitPrice", + "totalPrice", + "quantity" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "type": "number", + "format": "float" }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "totalPrice": { + "type": "number", + "format": "float" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "integer", + "format": "int64" }, - "categoryId": { - "description": "Unique identity of the category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedTaxes": { + "type": "object" }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "taxRules": { + "type": "object" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" } }, "type": "object" - } - ] - }, - "MainCategory": { - "description": "Added since version: 6.1.0.0", - "required": [ - "id", - "productId", - "categoryId", - "salesChannelId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "returnNumber": { + "type": "string" }, - "categoryId": { - "description": "Unique identity of the category.", + "requestedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "categoryVersionId": { + "amountTotal": { + "type": "number", + "format": "float" + }, + "amountNet": { + "type": "number", + "format": "float" + }, + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6953,47 +6531,76 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "state": { + "$ref": "#/components/schemas/StateMachineState" + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } } }, "type": "object" }, - "MeasurementDisplayUnit": { - "description": "Added since version: 6.7.1.0", + "OrderReturnLineItem": { "required": [ "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementSystemId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "default": { - "type": "boolean" + "orderReturnId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "type": { - "type": "string" + "orderReturnVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { - "type": "string" + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "factor": { + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reasonId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "refundAmount": { "type": "number", "format": "float" }, - "precision": { + "restockQuantity": { "type": "integer", "format": "int64" }, + "customFields": { + "type": "object" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7004,27 +6611,29 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "reason": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" }, - "measurementSystem": { - "$ref": "#/components/schemas/MeasurementSystem" + "state": { + "$ref": "#/components/schemas/StateMachineState" } }, "type": "object" }, - "MeasurementSystem": { - "description": "Added since version: 6.7.1.0", + "OrderReturnLineItemReason": { "required": [ "id", - "technicalName" + "reasonKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { + "reasonKey": { + "type": "string" + }, + "content": { "type": "string" }, "createdAt": { @@ -7039,94 +6648,138 @@ }, "translated": { "type": "object" - }, - "units": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" - } } }, "type": "object" }, - "Media": { + "OrderTag": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", - "fileExtension", - "fileName", - "hasFile", - "path", - "private", - "url", - "id" + "orderId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mimeType": { - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", - "type": "string" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "fileExtension": { - "description": "Type of file indication. For example: jpeg, png.", - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "uploadedAt": { - "description": "Date and time at which media was added.", + "tagId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "fileName": { - "description": "Name of the media file uploaded.", - "type": "string" + "order": { + "$ref": "#/components/schemas/Order" }, - "fileSize": { - "description": "Size of the file media file uploaded.", - "type": "integer", - "format": "int64", - "readOnly": true + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "OrderTransaction": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "metaData": { - "type": "object", - "readOnly": true, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "description": "Unique identity of an order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "height": { - "type": "integer", - "format": "int64" + "unitPrice": { + "type": "number", + "format": "float" }, - "width": { + "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" } - } - }, - "config": { + }, "type": "object" }, - "alt": { - "type": "string" - }, - "title": { - "type": "string" - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "path": { - "type": "string" - }, - "hasFile": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "validationData": { + "type": "object" }, - "private": { - "description": "When `true`, the media display is kept private.", - "type": "boolean" + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" @@ -7141,100 +6794,118 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, - "extensions": { - "properties": { - "mediaAiTag": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3c88197809d464216a8c40a8db191b38" - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" }, - "thumbnails": { - "description": "Generated thumbnail images in various sizes", + "captures": { + "description": "Payment captures for this transaction", "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/OrderTransactionCapture" } - }, - "apiAlias": { - "type": "string", - "enum": [ - "media" - ] } }, "type": "object" }, - "MediaAiTag": { + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", "required": [ - "id" + "id", + "orderTransactionId", + "stateId", + "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "orderTransactionVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "MediaDefaultFolder": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "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", @@ -7245,37 +6916,121 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "transaction": { + "$ref": "#/components/schemas/OrderTransaction" + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } } }, "type": "object" }, - "MediaFolder": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefund": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "captureId", + "stateId", + "amount" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MediaFolderConfiguration": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "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", @@ -7285,79 +7040,126 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "transactionCapture": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } } }, "type": "object" }, - "MediaTag": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefundPosition": { + "description": "Added since version: 6.4.12.0", "required": [ - "mediaId", - "tagId" + "id", + "refundId", + "orderLineItemId", + "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "MediaThumbnail": { - "description": "Added since version: 6.0.0.0", - "required": [ - "url", - "id", - "mediaId", - "width", - "height" - ], - "properties": { - "id": { + "refundVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "description": "Unique identity of media.", + "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaThumbnailSizeId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true + "externalReference": { + "description": "External payment provider token.", + "type": "string" }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "url": { - "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", + "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, - "path": { - "type": "string" + "quantity": { + "description": "Quantity of line item to be refunded.", + "type": "integer", + "format": "int64" + }, + "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" @@ -7371,35 +7173,22 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "orderTransactionCaptureRefund": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, "type": "object" }, - "MediaThumbnailSize": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "width", - "height" - ], + "OrderWarehouseGroup": { "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64" - }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7413,18 +7202,61 @@ }, "type": "object" }, - "NewsletterRecipientJsonApi": { + "PaymentMethodJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { + "required": [ + "id", + "technicalName", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "distinguishableName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "type": "boolean" + }, + "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7434,39 +7266,100 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "media": { + "description": "Payment method logo or icon image", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "NewsletterRecipient": { + "PaymentMethod": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "name": { + "type": "string" }, - "updatedAt": { + "distinguishableName": { "type": "string", - "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "Notification": { - "description": "Added since version: 6.4.7.0", - "properties": { - "id": { + }, + "description": { + "type": "string" + }, + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "type": "boolean" + }, + "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7476,14 +7369,21 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" } }, "type": "object" }, - "NumberRange": { + "Plugin": { "description": "Added since version: 6.0.0.0", "required": [ - "name" + "label" ], "properties": { "id": { @@ -7506,33 +7406,108 @@ }, "type": "object" }, - "NumberRangeSalesChannel": { + "ProductConfiguratorSetting": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "optionId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "productId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "optionId": { + "description": "Unique identity of option.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { "type": "string", "format": "date-time", "readOnly": true + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "NumberRangeState": { - "description": "Added since version: 6.0.0.0", + "ProductCrossSelling": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", + "type": "string" + }, + "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", + "type": "string" + }, + "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", + "type": "string" + }, + "active": { + "description": "When set to active, the cross-selling feature is enabled.", + "type": "boolean" + }, + "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7542,15 +7517,15 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "NumberRangeType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "typeName" - ], + "ProductCrossSellingAssignedProducts": { + "description": "Added since version: 6.2.0.0", "properties": { "id": { "type": "string", @@ -7565,27 +7540,16 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" } }, "type": "object" }, - "Order": { - "description": "Added since version: 6.0.0.0", + "ProductDownload": { + "description": "Added since version: 6.4.19.0", "required": [ - "documents", - "orderDate", - "stateMachineState", - "price", "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor" + "productId", + "mediaId" ], "properties": { "id": { @@ -7596,37 +7560,101 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderNumber": { - "description": "Unique number associated with every order.", - "type": "string" - }, - "billingAddressId": { - "description": "Unique identity of the billing address.", + "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "billingAddressVersionId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "primaryOrderDeliveryId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "primaryOrderDeliveryVersionId": { + "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "primaryOrderTransactionId": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "ProductExport": { + "description": "Added since version: 6.1.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "primaryOrderTransactionVersionId": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductFeatureSet": { + "description": "Added since version: 6.3.0.0", + "required": [ + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "description": "Unique identity of the currency.", + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "ProductKeywordDictionary": { + "description": "Added since version: 6.0.0.0", + "required": [ + "languageId", + "keyword" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7635,186 +7663,184 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", + "keyword": { + "description": "The keywords that help to search the product.", + "type": "string" + } + }, + "type": "object" + }, + "ProductManufacturer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDateTime": { - "description": "Timestamp when the order was placed.", + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "orderDate": { - "description": "Date when the order was placed.", + "mediaId": { + "description": "Unique identity of the media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "link": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", + "format": "date-time", "readOnly": true }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object", - "$ref": "#/components/schemas/CalculatedPrice" - }, - "amountTotal": { - "description": "Gross price of the order.", - "type": "number", - "format": "float", + "updatedAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "amountNet": { - "description": "Net price of the order.", - "type": "number", - "format": "float", - "readOnly": true + "translated": { + "type": "object" }, - "positionPrice": { - "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", - "type": "number", - "format": "float", + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "ProductPrice": { + "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 }, - "taxStatus": { - "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "updatedAt": { "type": "string", + "format": "date-time", "readOnly": true + } + }, + "type": "object" + }, + "ProductReview": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "salesChannelId", + "languageId", + "title", + "content" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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" + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shippingTotal": { - "description": "Total shipping cost of the ordered product.", - "type": "number", - "format": "float", - "readOnly": true + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "currencyFactor": { - "description": "Rate at which currency is exchanged.", - "type": "number", - "format": "float" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "deepLinkCode": { - "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", - "type": "string" + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "externalUser": { + "description": "External user name.", "type": "string" }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", + "title": { + "description": "Title of product review.", "type": "string" }, - "customerComment": { - "description": "Comments given by comments.", + "content": { + "description": "Short description or subject of the project review.", "type": "string" }, - "source": { - "description": "Source of orders either via normal order placement or subscriptions.", - "type": "string" + "points": { + "description": "A floating point number given to rate a product.", + "type": "number", + "format": "float" }, - "taxCalculationType": { + "status": { + "description": "When status is set, the rating is made visible.", + "type": "boolean" + }, + "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { "type": "object" }, - "createdById": { - "description": "Unique identity of createdBy.", + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductReviewSummary": { + "required": [ + "id", + "productId", + "salesChannelId" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { - "description": "Unique identity of updatedBy.", + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "summary": { + "type": "string" + }, + "visible": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7825,378 +7851,100 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "subscription": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" - } - } - } - }, - "type": "object" - }, - "initialSubscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "3b40c275cdd1f84402bcef5be1651f64" - } - } - } - } - }, - "type": "object" - }, - "returns": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } - } - } - } - }, - "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": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a674c327bfa07f7c1204fb38ca6ef3b" - } - } - } - }, - "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" - }, - "budget": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_budget" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2f212049ce79d2b949fd242043004288" - } - } - } - }, - "type": "object" - } - }, + "translated": { "type": "object" }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current order state (e.g., open, in_progress, completed, cancelled)" - }, - "primaryOrderDelivery": { - "$ref": "#/components/schemas/OrderDelivery", - "description": "Primary delivery information for the order" + "product": { + "$ref": "#/components/schemas/Product" }, - "primaryOrderTransaction": { - "$ref": "#/components/schemas/OrderTransaction", - "description": "Primary payment transaction for the order" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "ProductSearchConfig": { + "description": "Added since version: 6.3.5.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderCustomer": { - "$ref": "#/components/schemas/OrderCustomer", - "description": "Customer information associated with the order" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "currency": { - "$ref": "#/components/schemas/Currency", - "description": "Currency used for the order" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductSearchConfigField": { + "description": "Added since version: 6.3.5.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "language": { - "$ref": "#/components/schemas/Language", - "description": "Language used when placing the order" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "addresses": { - "description": "All addresses associated with the order (billing and shipping)", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductSearchKeyword": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "billingAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Billing address for the order" - }, - "deliveries": { - "description": "Delivery information including shipping address and tracking", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - }, - "lineItems": { - "description": "Order line items (products, discounts, fees)", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - }, - "transactions": { - "description": "Payment transactions for the order", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - }, - "documents": { - "description": "Generated documents (invoices, delivery notes, credit notes)", - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tags": { - "description": "Tags assigned to the order for organization and filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "OrderAddress": { - "description": "Added since version: 6.0.0.0", + "ProductSorting": { + "description": "Added since version: 6.3.2.0", "required": [ - "id", - "countryId", - "firstName", - "lastName", - "street", - "city" + "key", + "priority", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "street": { - "description": "Street address", - "type": "string" - }, - "zipcode": { - "description": "Zip code of the country.", - "type": "string" - }, - "city": { - "description": "Name of the city.", - "type": "string" - }, - "company": { - "description": "Name of the company.", - "type": "string" - }, - "department": { - "description": "Name of the department.", - "type": "string" - }, - "title": { - "description": "Title name given to customer like DR. , Prof., etc.", - "type": "string" - }, - "phoneNumber": { - "description": "Phone number of the customer.", - "type": "string" - }, - "additionalAddressLine1": { - "description": "Additional address input if necessary.", + "key": { "type": "string" }, - "additionalAddressLine2": { - "description": "Additional address input if necessary.", - "type": "string" + "priority": { + "type": "integer", + "format": "int64" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", + "label": { "type": "string" }, - "customFields": { - "type": "object" - }, - "vatId": { - "description": "Unique identity of VAT.", - "type": "string", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -8207,73 +7955,40 @@ "format": "date-time", "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "translated": { + "type": "object" } }, "type": "object" }, - "OrderCustomer": { + "ProductStream": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "email", - "firstName", - "lastName" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "email": { - "description": "Email address of the customer.", - "type": "string" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "company": { - "description": "Name of the company.", - "type": "string" - }, - "title": { - "description": "Title name given to the customer like Dr, prof. etc.", + "name": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customerNumber": { - "description": "Unique number assigned to the customer.", + "description": { "type": "string" }, "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, + "displayAsGroup": { + "description": "When enabled, matching variants are grouped according to the product presentation setting. Disable to show them individually.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -8284,132 +7999,80 @@ "format": "date-time", "readOnly": true }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "translated": { + "type": "object" } }, "type": "object" }, - "OrderDelivery": { + "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", - "stateId", - "shippingDateEarliest", - "shippingDateLatest" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderId": { - "description": "Unique identity of order.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductVisibility": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingOrderAddressId": { - "description": "Unique identity of order's shipping address.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "shippingOrderAddressVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductWarehouse": { + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of state.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "trackingCodes": { - "type": "array", - "items": { - "type": "string" - } + "format": "date-time", + "readOnly": true }, - "shippingDateEarliest": { - "description": "Date and time of earliest delivery of products.", + "updatedAt": { "type": "string", - "format": "date-time" - }, - "shippingDateLatest": { - "description": "Date and time of latest delivery of products.", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Promotion": { + "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], + "properties": { + "id": { "type": "string", - "format": "date-time" - }, - "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" + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" @@ -8424,137 +8087,59 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" - }, - "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Shipping address for this delivery" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod", - "description": "Shipping method used for this delivery" - }, - "positions": { - "description": "Line items included in this delivery", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } + "translated": { + "type": "object" } }, "type": "object" }, - "OrderDeliveryPosition": { + "PromotionDiscount": { "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "orderDeliveryId", - "orderLineItemId" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderDeliveryId": { - "description": "Unique identity of order delivery.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderDeliveryVersionId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "PromotionDiscountPrices": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { - "description": "Unique identity of line items in an order.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderLineItemVersionId": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "PromotionIndividualCode": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "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": { - "description": "Price of product per item (where, quantity=1).", - "type": "number", - "format": "float" - }, - "totalPrice": { - "description": "Cost of product based on quantity.", - "type": "number", - "format": "float" - }, - "quantity": { - "description": "Number of items of each product.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -8568,612 +8153,619 @@ }, "type": "object" }, - "OrderLineItem": { + "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "id", - "orderId", - "identifier", - "quantity", - "label", - "children", - "states" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderId": { - "description": "Unique identity of order.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "PromotionSetgroup": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of product.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "promotionId": { - "description": "Unique identity of product.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "PropertyGroup": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "coverId": { - "description": "Unique identity of cover image.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" }, - "identifier": { - "description": "It is a unique identity of an item in cart before its converted to an order.", + "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, - "referencedId": { - "description": "Unique identity of type of entity.", + "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, - "quantity": { - "description": "Number of items of product.", + "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", + "type": "boolean" + }, + "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", + "type": "boolean" + }, + "position": { "type": "integer", "format": "int64" }, - "label": { - "description": "It is a typical product name given to the line item.", - "type": "string" + "customFields": { + "type": "object" }, - "payload": { - "type": "object", + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + }, + "type": "object" + }, + "QuoteJsonApi": { + "description": "Added since version: 6.5.3.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "stateId", + "currencyId", + "languageId", + "salesChannelId", + "customerId" + ], "properties": { - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "features": { - "type": "array" + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isCloseout": { - "type": "boolean" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isNew": { - "type": "boolean" + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "manufacturerId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "markAsTopseller": { - "type": "boolean" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "options": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productNumber": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "quoteNumber": { + "type": "string" }, - "releaseDate": { + "expirationDate": { "type": "string", "format": "date-time" }, - "stock": { - "type": "integer", - "format": "int64" - }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "sentAt": { + "type": "string", + "format": "date-time" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } }, - "readOnly": true - }, - "taxId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "object" }, - "productType": { - "$ref": "#/components/schemas/Product/properties/type" - } - } - }, - "good": { - "description": "When set to true, it indicates the line item is physical else it is virtual.", - "type": "boolean" - }, - "removable": { - "description": "Allows the line item to be removable from the cart when set to true.", - "type": "boolean" - }, - "stackable": { - "description": "Allows to change the quantity of the line item when set to true.", - "type": "boolean" - }, - "position": { - "description": "Position of line items placed in an order.", - "type": "integer", - "format": "int64" - }, - "priceDefinition": { - "type": "object", - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "unitPrice": { - "description": "Price of product per item (where, quantity=1).", - "type": "number", - "format": "float" - }, - "totalPrice": { - "description": "Cost of product based on quantity.", - "type": "number", - "format": "float" - }, - "description": { - "description": "Description of line items in an order.", - "type": "string" - }, - "type": { - "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "container", - "discount", - "quantity" - ] - }, - "customFields": { - "type": "object" - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "deprecated": true - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "returns": { + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "links": { - "type": "object", + "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": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" } - } + }, + "type": "object" } }, "type": "object" }, - "state": { + "discount": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" - } - } + "type": { + "type": "string" }, - "data": { - "type": "object", + "value": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "subtotalNet": { + "type": "number", + "format": "float" + }, + "totalDiscount": { + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "organization": { "properties": { - "type": { - "type": "string", - "example": "state_machine_state" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" + } + } }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "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" - }, - "cover": { - "$ref": "#/components/schemas/Media", - "description": "Line item image or thumbnail" - }, - "product": { - "$ref": "#/components/schemas/Product", - "description": "Referenced product if this is a product line item" - }, - "orderDeliveryPositions": { - "description": "Delivery positions for this line item", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - }, - "downloads": { - "description": "Digital downloads associated with this line item", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - }, - "parent": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - }, - "apiAlias": { - "type": "string", - "enum": [ - "order_line_item" - ] - }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "OrderLineItemDownload": { - "description": "Added since version: 6.4.19.0", - "required": [ - "media", - "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { - "description": "Unique identity of Order line item.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "accessGranted": { - "description": "When boolean value is `true`, the digital product is allowed to download.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "OrderProductWarehouse": { - "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" - }, - "OrderReturn": { - "required": [ - "id", - "orderId", - "stateId", - "returnNumber", - "requestedAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" }, - "taxRules": { - "type": "object" - }, - "referencePrice": { - "type": "object" - }, - "listPrice": { + "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" + "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" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "returnNumber": { - "type": "string" - }, - "requestedAt": { - "type": "string", - "format": "date-time" - }, - "amountTotal": { - "type": "number", - "format": "float" - }, - "amountNet": { - "type": "number", - "format": "float" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } } - }, - "type": "object" + ] }, - "OrderReturnLineItem": { + "Quote": { + "description": "Added since version: 6.5.3.0", "required": [ "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "stateId" + "stateId", + "currencyId", + "languageId", + "salesChannelId", + "customerId" ], "properties": { "id": { @@ -9184,104 +8776,35 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnVersionId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "refundAmount": { - "type": "number", - "format": "float" - }, - "restockQuantity": { - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "stateId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "reason": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - } - }, - "type": "object" - }, - "OrderReturnLineItemReason": { - "required": [ - "id", - "reasonKey" - ], - "properties": { - "id": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonKey": { - "type": "string" - }, - "content": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "OrderTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "orderId", - "tagId" - ], - "properties": { - "id": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9293,52 +8816,55 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "OrderTransaction": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "orderId", - "paymentMethodId", - "amount", - "stateId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quoteNumber": { + "type": "string" }, - "orderId": { - "description": "Unique identity of an order.", + "expirationDate": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "orderVersionId": { + "sentAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "paymentMethodId": { - "description": "Unique identity of payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" }, - "amount": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -9395,13 +8921,39 @@ }, "type": "object" }, - "validationData": { + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + } + }, "type": "object" }, - "stateId": { - "description": "Unique identity of state.", + "taxStatus": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" @@ -9416,33 +8968,89 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "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" + }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current payment transaction state (e.g., open, paid, cancelled)" + "$ref": "#/components/schemas/StateMachineState" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Payment method used for this transaction" + "currency": { + "$ref": "#/components/schemas/Currency" }, - "captures": { - "description": "Payment captures for this transaction", + "language": { + "$ref": "#/components/schemas/Language" + }, + "lineItems": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/QuoteLineItem" } - } - }, - "type": "object" - }, - "OrderTransactionCapture": { - "description": "Added since version: 6.4.12.0", - "required": [ - "id", - "orderTransactionId", - "stateId", - "amount" - ], - "properties": { + }, + "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}$" @@ -9451,83 +9059,36 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "comment": { + "type": "string" + }, + "seenAt": { + "type": "string", + "format": "date-time" + }, + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionVersionId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { - "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" + "customerId": { + "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" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -9542,25 +9103,23 @@ "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, - "transaction": { - "$ref": "#/components/schemas/OrderTransaction" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "refunds": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } + "employee": { + "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, - "OrderTransactionCaptureRefund": { - "description": "Added since version: 6.4.12.0", + "QuoteDelivery": { + "description": "Added since version: 6.5.3.0", "required": [ "id", - "captureId", - "stateId", - "amount" + "quoteId", + "shippingMethodId", + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -9571,29 +9130,27 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureId": { - "description": "Unique identity of order transaction capture.", + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of order state.", + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" + "shippingDateEarliest": { + "type": "string", + "format": "date-time" }, - "reason": { - "description": "Reason for refunding the amount for an order.", - "type": "string" + "shippingDateLatest": { + "type": "string", + "format": "date-time" }, - "amount": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -9663,28 +9220,24 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "transactionCapture": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" }, "positions": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } }, "type": "object" }, - "OrderTransactionCaptureRefundPosition": { - "description": "Added since version: 6.4.12.0", + "QuoteDeliveryPosition": { + "description": "Added since version: 6.5.3.0", "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "quoteDeliveryId", + "quoteLineItemId" ], "properties": { "id": { @@ -9695,38 +9248,23 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundId": { - "description": "Unique identity of order transaction capture refund.", + "quoteDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundVersionId": { + "quoteDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { - "description": "Unique identity of order line item.", + "quoteLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "quoteLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" - }, - "reason": { - "description": "Reason for refunding the amount for an order.", - "type": "string" - }, - "quantity": { - "description": "Quantity of line item to be refunded.", - "type": "integer", - "format": "int64" - }, - "amount": { + "price": { "required": [ "unitPrice", "totalPrice", @@ -9783,6 +9321,18 @@ }, "type": "object" }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, "customFields": { "type": "object" }, @@ -9795,192 +9345,71 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "orderTransactionCaptureRefund": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, "type": "object" }, - "OrderWarehouseGroup": { + "QuoteDocument": { + "required": [ + "id", + "documentTypeId", + "fileType", + "quoteId", + "config", + "deepLinkCode" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "documentNumber": { + "type": "string" + }, + "documentTypeId": { "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "PaymentMethodJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "pattern": "^[0-9a-f]{32}$" }, - { - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "distinguishableName": { - "type": "string", - "readOnly": true - }, - "description": { - "type": "string" - }, - "position": { - "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", - "type": "boolean" - }, - "afterOrderEnabled": { - "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "type": "string" - }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "media": { - "description": "Payment method logo or icon image", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PaymentMethod": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { + "fileType": { + "type": "string" + }, + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "distinguishableName": { + "quoteVersionId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "config": { + "type": "object" }, - "position": { - "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" + "sent": { + "type": "boolean" }, - "active": { - "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "static": { "type": "boolean" }, - "afterOrderEnabled": { - "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "active": { "type": "boolean" }, - "customFields": { - "type": "object" + "deepLinkCode": { + "type": "string" }, - "mediaId": { - "description": "Unique identity of media.", + "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -9992,26 +9421,37 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Payment method logo or icon image" + "quote": { + "$ref": "#/components/schemas/Quote" + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "Plugin": { - "description": "Added since version: 6.0.0.0", + "QuoteEmployee": { "required": [ - "label" + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10021,2574 +9461,346 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" } }, "type": "object" }, - "ProductJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$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" - ] - } - } - } - } - } + "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", - "taxId", - "productNumber", - "stock", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "manufacturerId": { - "description": "Unique identity of the manufacturer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productManufacturerVersionId": { - "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": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, + "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" + } + }, + "discount": { + "properties": { + "type": { + "type": "string" }, - "unitId": { - "description": "Unique identity of the unit.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + }, + "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": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" }, - "taxId": { - "description": "Unique identity of tax.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "totalPrice": { + "type": "number", + "format": "float" }, - "coverId": { - "description": "Unique identity of a ProductMedia item used as product cover.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "integer", + "format": "int64" }, - "productMediaVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedTaxes": { + "type": "object" }, - "deliveryTimeId": { - "description": "Unique identity of delivery time.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "taxRules": { + "type": "object" }, - "canonicalProductId": { - "description": "Unique identity of canonical product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "referencePrice": { + "type": "object" }, - "canonicalProductVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "openGraphMediaId": { - "description": "Media used as Open Graph image for social media sharing.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productNumber": { - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", - "type": "string" - }, - "restockTime": { - "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", - "type": "boolean" - }, - "available": { - "description": "Indicates weather the product is available or not.", - "type": "boolean", - "readOnly": true - }, - "isCloseout": { - "description": "When the value is set to true, the product is hidden when sold out.", - "type": "boolean" - }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "stock": { - "description": "Indicates the number of products available.", - "type": "integer", - "format": "int64" - }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", - "type": "string" - }, - "ean": { - "description": "Indicates EAN of the product.", - "type": "string" - }, - "purchaseSteps": { - "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", - "type": "integer", - "format": "int64" - }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "purchaseUnit": { - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", - "type": "number", - "format": "float" - }, - "referenceUnit": { - "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", - "type": "number", - "format": "float" - }, - "shippingFree": { - "description": "Indicates weather the shipping price is free or not.", - "type": "boolean" - }, - "markAsTopseller": { - "description": "Indicates weather the product is top seller or not.", - "type": "boolean" - }, - "weight": { - "description": "The weight of the product.", - "type": "number", - "format": "float" - }, - "width": { - "description": "The width of the product.", - "type": "number", - "format": "float" - }, - "height": { - "description": "The height of the product.", - "type": "number", - "format": "float" - }, - "length": { - "description": "The length of the product.", - "type": "number", - "format": "float" - }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", - "type": "string", - "format": "date-time" - }, - "ratingAverage": { - "description": "Average of all the ratings.", - "type": "number", - "format": "float", - "readOnly": true - }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaDescription": { - "type": "string" - }, - "name": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "description": { - "type": "string" - }, - "descriptionTeaser": { - "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", - "type": "string", - "readOnly": true - }, - "metaTitle": { - "type": "string" - }, - "packUnit": { - "type": "string" - }, - "packUnitPlural": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] - }, - "states": { - "type": "array", - "items": { - "type": "string" + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } }, - "readOnly": true, - "deprecated": true - }, - "calculatedPrice": { "type": "object" - }, - "calculatedPrices": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "calculatedMaxPurchase": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "calculatedCheapestPrice": { - "type": "object" - }, - "isNew": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "sortedProperties": { - "type": "object" - }, - "measurements": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "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}$" + }, + "name": { + "description": "Name of the rule defined.", + "type": "string" + }, + "description": { + "description": "Description of the rule.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "warehouseGroup": { "properties": { - "reviewSummaries": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" - } - } - } - } - }, - "type": "object" - }, - "bundleItems": { - "description": "Bundle items assigned to this grouped bundle product.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundleItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bundle_item" - }, - "id": { - "type": "string", - "example": "d7706d2e11bc4878ffb242403ea5b274" - } - } - } - } - }, - "type": "object" - }, - "bundleDiscounts": { - "description": "Discount configurations that belong to this bundle.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bundle_discount" - }, - "id": { - "type": "string", - "example": "a79712cce6d0182645b519f6add10f77" - } - } - } - } - }, - "type": "object" - }, - "bundleSalesChannels": { - "description": "Sales channels in which this bundle is available.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "d4aa52cb00cd89c5e047c6a5c72a0384" - } - } - } - } - }, + "links": { "type": "object", - "readOnly": true - }, - "items": { - "description": "Products referenced as bundle items of this bundle.", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/items" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "691d502cfd0e0626cd3b058e5682ad1c" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" } - }, - "type": "object" + } }, - "belongToBundleItems": { - "description": "Reference to the bundle item definition when this product acts as a bundle item.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bundle_item" - }, - "id": { - "type": "string", - "example": "db4ef6a91ceb3a70935c07a3617ea4cd" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "1768e3071b62161d415e0c24332055ed" } } - }, - "type": "object" - }, - "bundles": { - "description": "Bundles that include this product as an item.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundles" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "9e21e19f42862a3b26cd7aae135a3f74" - } - } - } - } - }, - "type": "object" + } } }, "type": "object" - }, - "relationships": { - "properties": { - "downloads": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/downloads" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_download" - }, - "id": { - "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" - } - } - } - } - }, - "type": "object" - }, - "parent": { - "description": "Unique identity of the product.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/parent" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } - } - }, - "type": "object" - }, - "children": { - "description": "Product variants that inherit from this parent product", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/children" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } - } - } - }, - "type": "object" - }, - "deliveryTime": { - "description": "Estimated delivery time for the product", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "delivery_time" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8c888ae25a7bd42057370e31f7e01044" - } - } - } - }, - "type": "object" - }, - "tax": { - "description": "Tax configuration (rate and calculation rules)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tax" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" - } - } - } - }, - "type": "object" - }, - "manufacturer": { - "description": "Product manufacturer or brand information", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/manufacturer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_manufacturer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c2904bca62b22443d6cf5e9d89cab204" - } - } - } - }, - "type": "object" - }, - "unit": { - "description": "Product unit of measure (e.g., piece, liter, kg)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/unit" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "unit" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3e34bdebd9bd5edda27e8728904a2552" - } - } - } - }, - "type": "object" - }, - "cover": { - "description": "Main product image displayed in listings and detail pages", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cover" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" - } - } - } - }, - "type": "object" - }, - "openGraphMedia": { - "description": "Open Graph image for social media sharing", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "bbda52d941a3452369a00f2880f4f358" - } - } - } - }, - "type": "object" - }, - "cmsPage": { - "description": "Custom CMS page layout for the product detail page", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" - } - } - } - }, - "type": "object" - }, - "canonicalProduct": { - "description": "Canonical product reference for variant consolidation and SEO purposes", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "023995a50b56c0de077323e958b2bbcd" - } - } - } - }, - "type": "object" - }, - "media": { - "description": "Product images and media gallery", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/media" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } - } - } - } - }, - "type": "object" - }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/crossSellings" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_cross_selling" - }, - "id": { - "type": "string", - "example": "89936e14544d1b403cecef938101b6b0" - } - } - } - } - }, - "type": "object" - }, - "configuratorSettings": { - "description": "Variant configurator settings defining available options for product variants", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_configurator_setting" - }, - "id": { - "type": "string", - "example": "c0827fee13725d41f1fd7e292243f5aa" - } - } - } - } - }, - "type": "object" - }, - "productReviews": { - "description": "Customer reviews and ratings for the product", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/productReviews" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review" - }, - "id": { - "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" - } - } - } - } - }, - "type": "object" - }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/mainCategories" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "main_category" - }, - "id": { - "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" - } - } - } - } - }, - "type": "object" - }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/seoUrls" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } - } - } - } - }, - "type": "object" - }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/options" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group_option" - }, - "id": { - "type": "string", - "example": "93da65a9fd0004d9477aeac024e08e15" - } - } - } - } - }, - "type": "object" - }, - "properties": { - "description": "Product properties and characteristics for filtering", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/properties" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group_option" - }, - "id": { - "type": "string", - "example": "74693d2fc58b46bd06410f278e39aa71" - } - } - } - } - }, - "type": "object" - }, - "categories": { - "description": "Categories this product is assigned to", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categories" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" - } - } - } - } - }, - "type": "object" - }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/streams" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_stream" - }, - "id": { - "type": "string", - "example": "2f6f4768f1c2d7c8f1f54823723f1a70" - } - } - } - } - }, - "type": "object" - }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "7f0702d3a90d965b8c9158c451f43fdb" - } - } - } - } - }, - "type": "object" - }, - "tags": { - "description": "Tags for organizing and filtering products", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } - } - } - } - }, - "type": "object" - }, - "seoCategory": { - "description": "Main category used for SEO URL generation in the current sales channel", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/seoCategory" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9354d004d12e03d35ad8292bf0bb234d" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Product": { - "description": "Represents a product along with detailed information required to display a variant selection.", - "required": [ - "apiAlias", - "calculatedPrice", - "calculatedPrices", - "seoCategory", - "type", - "translated", - "id", - "taxId", - "productNumber", - "stock", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "manufacturerId": { - "description": "Unique identity of the manufacturer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productManufacturerVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "unitId": { - "description": "Unique identity of the unit.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxId": { - "description": "Unique identity of tax.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "coverId": { - "description": "Unique identity of a ProductMedia item used as product cover.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productMediaVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "deliveryTimeId": { - "description": "Unique identity of delivery time.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductId": { - "description": "Unique identity of canonical product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "openGraphMediaId": { - "description": "Media used as Open Graph image for social media sharing.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productNumber": { - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", - "type": "string" - }, - "restockTime": { - "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", - "type": "boolean" - }, - "available": { - "description": "Indicates weather the product is available or not.", - "type": "boolean", - "readOnly": true - }, - "isCloseout": { - "description": "When the value is set to true, the product is hidden when sold out.", - "type": "boolean" - }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "stock": { - "description": "Indicates the number of products available.", - "type": "integer", - "format": "int64" - }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", - "type": "string" - }, - "ean": { - "description": "Indicates EAN of the product.", - "type": "string" - }, - "purchaseSteps": { - "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", - "type": "integer", - "format": "int64" - }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "purchaseUnit": { - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", - "type": "number", - "format": "float" - }, - "referenceUnit": { - "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", - "type": "number", - "format": "float" - }, - "shippingFree": { - "description": "Indicates weather the shipping price is free or not.", - "type": "boolean" - }, - "markAsTopseller": { - "description": "Indicates weather the product is top seller or not.", - "type": "boolean" - }, - "weight": { - "description": "The weight of the product.", - "type": "number", - "format": "float" - }, - "width": { - "description": "The width of the product.", - "type": "number", - "format": "float" - }, - "height": { - "description": "The height of the product.", - "type": "number", - "format": "float" - }, - "length": { - "description": "The length of the product.", - "type": "number", - "format": "float" - }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", - "type": "string", - "format": "date-time" - }, - "ratingAverage": { - "description": "Average of all the ratings.", - "type": "number", - "format": "float", - "readOnly": true - }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaDescription": { - "type": "string" - }, - "name": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "description": { - "type": "string" - }, - "descriptionTeaser": { - "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", - "type": "string", - "readOnly": true - }, - "metaTitle": { - "type": "string" - }, - "packUnit": { - "type": "string" - }, - "packUnitPlural": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true - }, - "calculatedPrice": { - "type": "object", - "$ref": "#/components/schemas/CalculatedPrice" - }, - "calculatedPrices": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "allOf": [ - { - "$ref": "#/components/schemas/CalculatedPrice" - } - ] - } - }, - "calculatedMaxPurchase": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "calculatedCheapestPrice": { - "type": "object", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "totalPrice": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/ReferencePrice" - }, - { - "type": "null" - } - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/ListPrice" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - } - }, - "required": [ - "price" - ] - }, - { - "type": "null" - } - ] - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "" - }, - { - "type": "null" - } - ] - }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_cheapest_price" - ] - } - } - }, - "isNew": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "sortedProperties": { - "type": "object" - }, - "measurements": { - "type": "object", - "$ref": "#/components/schemas/ProductMeasurements" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "reviewSummaries": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" - } - } - } - } - }, - "type": "object" - }, - "bundleItems": { - "description": "Bundle items assigned to this grouped bundle product.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundleItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bundle_item" - }, - "id": { - "type": "string", - "example": "d7706d2e11bc4878ffb242403ea5b274" - } - } - } - } - }, - "type": "object" - }, - "bundleDiscounts": { - "description": "Discount configurations that belong to this bundle.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bundle_discount" - }, - "id": { - "type": "string", - "example": "a79712cce6d0182645b519f6add10f77" - } - } - } - } - }, - "type": "object" - }, - "bundleSalesChannels": { - "description": "Sales channels in which this bundle is available.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "d4aa52cb00cd89c5e047c6a5c72a0384" - } - } - } - } - }, - "type": "object", - "readOnly": true - }, - "items": { - "description": "Products referenced as bundle items of this bundle.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/items" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "691d502cfd0e0626cd3b058e5682ad1c" - } - } - } - } - }, - "type": "object" - }, - "belongToBundleItems": { - "description": "Reference to the bundle item definition when this product acts as a bundle item.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bundle_item" - }, - "id": { - "type": "string", - "example": "db4ef6a91ceb3a70935c07a3617ea4cd" - } - } - } - } - }, - "type": "object" - }, - "bundles": { - "description": "Bundles that include this product as an item.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/bundles" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "9e21e19f42862a3b26cd7aae135a3f74" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "downloads": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - }, - "parent": { - "$ref": "#/components/schemas/Product", - "description": "Unique identity of the product." - }, - "children": { - "description": "Product variants that inherit from this parent product", - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime", - "description": "Estimated delivery time for the product" - }, - "tax": { - "$ref": "#/components/schemas/Tax", - "description": "Tax configuration (rate and calculation rules)" - }, - "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer", - "description": "Product manufacturer or brand information" - }, - "unit": { - "$ref": "#/components/schemas/Unit", - "description": "Product unit of measure (e.g., piece, liter, kg)" - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia", - "description": "Main product image displayed in listings and detail pages" - }, - "openGraphMedia": { - "$ref": "#/components/schemas/Media", - "description": "Open Graph image for social media sharing" - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "Custom CMS page layout for the product detail page" - }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product", - "description": "Canonical product reference for variant consolidation and SEO purposes" - }, - "media": { - "description": "Product images and media gallery", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - }, - "configuratorSettings": { - "description": "Variant configurator settings defining available options for product variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - }, - "productReviews": { - "description": "Customer reviews and ratings for the product", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - }, - "properties": { - "description": "Product properties and characteristics for filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - }, - "categories": { - "description": "Categories this product is assigned to", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "tags": { - "description": "Tags for organizing and filtering products", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "seoCategory": { - "$ref": "#/components/schemas/Category", - "description": "Main category used for SEO URL generation in the current sales channel" - }, - "apiAlias": { - "type": "string", - "enum": [ - "product" - ] - }, - "variantListingConfig": { - "oneOf": [ - { - "type": "object", - "properties": { - "displayParent": { - "type": "boolean" - } - } - }, - { - "type": "null" - } - ] - } - }, - "type": "object" - }, - "ProductConfiguratorSetting": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "productId", - "optionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "description": "Unique identity of product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "optionId": { - "description": "Unique identity of option.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - }, - "type": "object" - }, - "ProductCrossSelling": { - "description": "Added since version: 6.1.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "position": { - "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "sortBy": { - "description": "To sort the display of products by name, price or publication (descending, ascending) date.", - "type": "string" - }, - "sortDirection": { - "description": "To sort the display of products by ascending or descending order.", - "type": "string" - }, - "type": { - "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", - "type": "string" - }, - "active": { - "description": "When set to active, the cross-selling feature is enabled.", - "type": "boolean" - }, - "limit": { - "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", - "type": "integer", - "format": "int64" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "ProductCrossSellingAssignedProducts": { - "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" - }, - "ProductDownload": { - "description": "Added since version: 6.4.19.0", - "required": [ - "id", - "productId", - "mediaId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "description": "Unique identity of Product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "ProductExport": { - "description": "Added since version: 6.1.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "ProductFeatureSet": { - "description": "Added since version: 6.3.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" - }, - "ProductKeywordDictionary": { - "description": "Added since version: 6.0.0.0", - "required": [ - "languageId", - "keyword" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of the language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "keyword": { - "description": "The keywords that help to search the product.", - "type": "string" - } - }, - "type": "object" - }, - "ProductManufacturer": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of the media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "link": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "ProductMedia": { - "description": "Added since version: 6.0.0.0", - "required": [ - "media", - "id", - "productId", - "mediaId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of the media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "description": "The order of the images to be displayed for a product.", - "type": "integer", - "format": "int64" - }, - "customFields": { + } + }, "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "media": { - "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "ProductPrice": { + "RuleCondition": { "description": "Added since version: 6.0.0.0", "properties": { "id": { @@ -12608,250 +9820,133 @@ }, "type": "object" }, - "ProductReview": { + "SalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "salesChannelId", "languageId", - "title", - "content" + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "name", + "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "languageId": { - "description": "Unique identity of the language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalUser": { - "description": "External user name.", - "type": "string" - }, - "title": { - "description": "Title of product review.", - "type": "string" - }, - "content": { - "description": "Short description or subject of the project review.", - "type": "string" - }, - "points": { - "description": "A floating point number given to rate a product.", - "type": "number", - "format": "float" - }, - "status": { - "description": "When status is set, the rating is made visible.", - "type": "boolean" - }, - "comment": { - "description": "Detailed review about the product.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "ProductReviewSummary": { - "required": [ - "id", - "productId", - "salesChannelId" - ], - "properties": { - "id": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "summary": { - "type": "string" - }, - "visible": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "ProductSearchConfig": { - "description": "Added since version: 6.3.5.0", - "properties": { - "id": { + "paymentMethodId": { + "description": "Unique identity of payment method used.", "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" - }, - "ProductSearchConfigField": { - "description": "Added since version: 6.3.5.0", - "properties": { - "id": { + "shippingMethodId": { + "description": "Unique identity of shipping method.", "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" - }, - "ProductSearchKeyword": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "countryId": { + "description": "Unique identity of country.", "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" - }, - "ProductSorting": { - "description": "Added since version: 6.3.2.0", - "required": [ - "key", - "priority", - "label" - ], - "properties": { - "id": { + "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "key": { - "type": "string" + "navigationCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "priority": { + "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, - "label": { - "type": "string" + "footerCategoryId": { + "description": "Unique identity of footer category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "footerCategoryVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "ProductStream": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { + "serviceCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, + "businessTimeZone": { + "description": "Business timezone used for sales-channel-specific rendering. Added since version: 6.7.13.0.", + "type": "string" + }, "name": { "type": "string" }, - "description": { + "shortName": { + "description": "A short name for sales channel.", "type": "string" }, - "customFields": { + "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", + "type": "string" + }, + "configuration": { "type": "object" }, - "internal": { - "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", + "type": "boolean" + }, + "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", + "type": "boolean" + }, + "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -12864,12 +9959,54 @@ }, "translated": { "type": "object" + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" + }, + "domains": { + "description": "Domain URLs configured for the sales channel", + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "navigationCategory": { + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" + }, + "footerCategory": { + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" + }, + "serviceCategory": { + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" + }, + "hreflangDefaultDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" } }, "type": "object" }, - "ProductStreamFilter": { - "description": "Added since version: 6.0.0.0", + "SalesChannelAnalytics": { + "description": "Added since version: 6.2.0.0", "properties": { "id": { "type": "string", @@ -12888,55 +10025,52 @@ }, "type": "object" }, - "ProductVisibility": { + "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}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "url": { + "description": "URL of the sales channel domain.", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "ProductWarehouse": { - "properties": { - "id": { + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "languageId": { + "description": "Unique identity of language used.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "currencyId": { + "description": "Unique identity of currency.", "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Promotion": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$" + }, + "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, + "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -12950,14 +10084,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "language": { + "$ref": "#/components/schemas/Language" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "salesChannelDefaultHreflang": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "PromotionDiscount": { - "description": "Added since version: 6.0.0.0", + "SalesChannelFile": { + "description": "Added since version: 6.7.12.0", "properties": { "id": { "type": "string", @@ -12976,8 +10116,8 @@ }, "type": "object" }, - "PromotionDiscountPrices": { - "description": "Added since version: 6.0.0.0", + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", "properties": { "id": { "type": "string", @@ -12996,8 +10136,8 @@ }, "type": "object" }, - "PromotionIndividualCode": { - "description": "Added since version: 6.0.0.0", + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", "properties": { "id": { "type": "string", @@ -13016,8 +10156,11 @@ }, "type": "object" }, - "PromotionSalesChannel": { + "SalesChannelType": { "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], "properties": { "id": { "type": "string", @@ -13032,70 +10175,98 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "PromotionSetgroup": { + "SalutationJsonApi": { "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 + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "required": [ + "id", + "salutationKey", + "displayName", + "letterName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationKey": { + "description": "Technical name given to salutation. For example: mr", + "type": "string" + }, + "displayName": { + "type": "string" + }, + "letterName": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + } + }, + "type": "object" } - }, - "type": "object" + ] }, - "PropertyGroup": { + "Salutation": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name" + "salutationKey", + "displayName", + "letterName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "description": { + "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, - "displayType": { - "description": "Property groups can be displayed in the form of text, image, dropdown or color.", + "displayName": { "type": "string" }, - "sortingType": { - "description": "Sorting the property group by name or position.", + "letterName": { "type": "string" }, - "filterable": { - "description": "When set to true, the property will be displayed in the product filter of product lists.", - "type": "boolean" - }, - "visibleOnProductDetailPage": { - "description": "When set to true, the property groups are displayed on product detail page.", - "type": "boolean" + "customFields": { + "type": "object" }, "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13108,59 +10279,37 @@ }, "translated": { "type": "object" - }, - "options": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } } }, "type": "object" }, - "PropertyGroupOption": { + "ScheduledTask": { "description": "Added since version: 6.0.0.0", - "required": [ - "group", - "option", - "translated", - "id", - "groupId", - "name" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "description": "Unique identity of property group.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "colorHexCode": { - "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", - "type": "string" + "format": "date-time", + "readOnly": true }, - "mediaId": { - "description": "Unique identity of media.", + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Script": { + "description": "Added since version: 6.4.7.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "combinable": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13170,24 +10319,12 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" - }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "group": { - "$ref": "#/components/schemas/PropertyGroup" - }, - "option": { - "type": "string" } }, "type": "object" }, - "QuoteJsonApi": { - "description": "Added since version: 6.5.3.0", + "SeoUrlJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -13195,202 +10332,175 @@ { "required": [ "id", - "stateId", - "currencyId", "languageId", - "salesChannelId", - "customerId" + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "frontend.navigation.page", + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" + ] }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", + "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", + "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isCanonical": { + "description": "When set to true, search redirects to the main URL.", + "type": "boolean" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", + "type": "boolean" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", + "type": "boolean" }, - "orderId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderVersionId": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "SeoUrlTemplate": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "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", + "technicalName", + "deliveryTimeId", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteNumber": { + "name": { "type": "string" }, - "expirationDate": { - "type": "string", - "format": "date-time" - }, - "sentAt": { - "type": "string", - "format": "date-time" + "technicalName": { + "type": "string" }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" + "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", + "type": "boolean" }, - "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" + "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" }, - "discount": { - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "number", - "format": "float" - } - }, + "customFields": { "type": "object" }, - "taxStatus": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true + "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "subtotalNet": { - "type": "number", - "format": "float" + "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", + "type": "string" }, - "totalDiscount": { - "type": "number", - "format": "float" + "description": { + "type": "string" }, - "customFields": { - "type": "object" + "trackingUrl": { + "type": "string" }, "createdAt": { "type": "string", @@ -13402,101 +10512,13 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "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" - } - }, + "translated": { "type": "object" }, "relationships": { "properties": { - "stateMachineState": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/stateMachineState" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" - } - } - } - }, - "type": "object" - }, - "currency": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/currency" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" - } - } - } - }, - "type": "object" - }, - "language": { + "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -13504,7 +10526,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/language" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" } } }, @@ -13513,19 +10535,20 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "delivery_time" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, - "lineItems": { + "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -13533,30 +10556,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/lineItems" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, - "deliveries": { + "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -13564,7 +10586,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/deliveries" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" } } }, @@ -13575,11 +10597,11 @@ "properties": { "type": { "type": "string", - "example": "quote_delivery" + "example": "shipping_method_price" }, "id": { "type": "string", - "example": "6fc31b6b9cd717cc0dcb81152308f8af" + "example": "afae32efe0f84fece3f96b377b768b33" } } } @@ -13587,7 +10609,8 @@ }, "type": "object" }, - "transactions": { + "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -13595,30 +10618,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/transactions" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_transaction" - }, - "id": { - "type": "string", - "example": "c15b977dd99332ca8623fbdfb86827e8" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "comments": { + "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -13626,7 +10648,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/comments" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" } } }, @@ -13637,11 +10659,11 @@ "properties": { "type": { "type": "string", - "example": "quote_comment" + "example": "tag" }, "id": { "type": "string", - "example": "a5d491060952aa8ad5fdee071be752de" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -13649,7 +10671,8 @@ }, "type": "object" }, - "documents": { + "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -13657,23 +10680,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/documents" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_document" - }, - "id": { - "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" } } } @@ -13686,205 +10707,629 @@ }, "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": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", + "type": "boolean" + }, + "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", + "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", + "description": "Estimated delivery time information" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" + }, + "prices": { + "description": "Shipping prices based on weight, volume, or cart value", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + }, + "media": { + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" + }, + "tags": { + "description": "Tags for organizing shipping methods", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" + } + }, + "type": "object" + }, + "ShippingMethodPrice": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", + "type": "integer", + "format": "int64" + }, + "calculationRuleId": { + "description": "Unique identity of rule calculation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantityStart": { + "description": "Starting range of quantity of an item.", + "type": "number", + "format": "float" + }, + "quantityEnd": { + "description": "Ending range of quantity of an item.", + "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": { + "description": "Unique identity od snippet set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationKey": { + "description": "Reference to the snippet in the template.", + "type": "string" + }, + "value": { + "description": "Value of the key.", + "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": { + "description": "Name of snippet set.", + "type": "string" + }, + "iso": { + "description": "ISO nomenclature used to classify languages.", + "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" }, - "Quote": { - "description": "Added since version: 6.5.3.0", + "SsoProviderCustomer": { + "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" + }, + "StateMachine": { + "description": "Added since version: 6.0.0.0", "required": [ - "id", - "stateId", - "currencyId", - "languageId", - "salesChannelId", - "customerId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "stateId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "userId": { + "translated": { + "type": "object" + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "transitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + }, + "type": "object" + }, + "StateMachineHistory": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "languageId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "salesChannelId": { + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "type": "object" + }, + "StateMachineTransition": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "updatedById": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Subscription": { + "required": [ + "id", + "convertedOrder", + "subscriptionNumber", + "nextSchedule", + "followingNextSchedule", + "salesChannelId", + "subscriptionPlanName", + "subscriptionIntervalName", + "dateInterval", + "cronInterval", + "billingAddressId", + "shippingAddressId", + "shippingMethodId", + "paymentMethodId", + "currencyId", + "languageId" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "convertedOrder": { + "type": "object" + }, + "subscriptionNumber": { + "type": "string" + }, + "nextSchedule": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "orderId": { + "followingNextSchedule": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "format": "date-time" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "subscriptionPlanId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteNumber": { + "subscriptionPlanName": { "type": "string" }, - "expirationDate": { + "subscriptionIntervalId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "sentAt": { - "type": "string", - "format": "date-time" + "subscriptionIntervalName": { + "type": "string" }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float" - }, - "rawTotal": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string" - } - }, - "type": "object" + "dateInterval": { + "type": "string" }, - "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" + "cronInterval": { + "type": "string" + }, + "initialExecutionCount": { + "type": "integer", + "format": "int64" }, - "discount": { - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "remainingExecutionCount": { + "type": "integer", + "format": "int64" }, - "taxStatus": { + "billingAddressId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true + "shippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "subtotalNet": { - "type": "number", - "format": "float" + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalDiscount": { - "type": "number", - "format": "float" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "initialOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "initialOrderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" @@ -13901,7 +11346,7 @@ }, "extensions": { "properties": { - "organization": { + "subscriptionEmployee": { "properties": { "links": { "type": "object", @@ -13909,7 +11354,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionEmployee" } } }, @@ -13918,12 +11363,41 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_organization" + "example": "b2b_components_subscription_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b4c1948c087fafc89a88450fcbb64c77" + "example": "a4844d7989267e34103e44248b16cf6c" + } + } + } + }, + "type": "object" + }, + "subscriptionBudget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionBudget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6b2732717e6360e8eccfd947596f4e64" } } } @@ -13933,93 +11407,133 @@ }, "type": "object" }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "subscriptionPlan": { + "$ref": "#/components/schemas/SubscriptionPlan" }, - "currency": { - "$ref": "#/components/schemas/Currency" + "subscriptionInterval": { + "$ref": "#/components/schemas/SubscriptionInterval" }, - "language": { - "$ref": "#/components/schemas/Language" + "subscriptionCustomer": { + "$ref": "#/components/schemas/SubscriptionCustomer" }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteLineItem" - } + "billingAddress": { + "$ref": "#/components/schemas/SubscriptionAddress" }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDelivery" - } + "shippingAddress": { + "$ref": "#/components/schemas/SubscriptionAddress" }, - "transactions": { + "addresses": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/SubscriptionAddress" } }, - "comments": { + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "orders": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Order" } }, - "documents": { + "tags": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/Tag" } + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "initialOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" }, - "QuoteComment": { + "SubscriptionAddress": { "required": [ "id", - "comment", - "quoteId" + "countryId", + "subscriptionId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "comment": { - "type": "string" - }, - "seenAt": { - "type": "string", - "format": "date-time" - }, - "quoteId": { + "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteVersionId": { + "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "type": "string" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "lastName": { + "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "street": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -14031,112 +11545,71 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "billingSubscription": { + "$ref": "#/components/schemas/Subscription" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "shippingSubscription": { + "$ref": "#/components/schemas/Subscription" }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "subscription": { + "$ref": "#/components/schemas/Subscription" } }, "type": "object" }, - "QuoteDelivery": { - "description": "Added since version: 6.5.3.0", + "SubscriptionCustomer": { "required": [ "id", - "quoteId", - "shippingMethodId", - "shippingDateEarliest", - "shippingDateLatest" + "salutationId", + "email", + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteId": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "email": { + "type": "string" }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "type": "string" }, - "shippingDateEarliest": { - "type": "string", - "format": "date-time" + "lastName": { + "type": "string" }, - "shippingDateLatest": { - "type": "string", - "format": "date-time" + "company": { + "type": "string" }, - "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" + "title": { + "type": "string" + }, + "customerNumber": { + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" @@ -14151,121 +11624,209 @@ "format": "date-time", "readOnly": true }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" - } + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "QuoteDeliveryPosition": { - "description": "Added since version: 6.5.3.0", + "SubscriptionInterval": { "required": [ "id", - "quoteDeliveryId", - "quoteLineItemId" + "name", + "delayed" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "quoteDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "quoteDeliveryVersionId": { + "dateInterval": { + "type": "string" + }, + "cronInterval": { + "type": "string" + }, + "delayed": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteLineItemId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "quoteLineItemVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "price": { + "translated": { + "type": "object" + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + }, + "type": "object" + }, + "SubscriptionPlanJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { "required": [ - "unitPrice", - "totalPrice", - "quantity" + "id", + "name" ], "properties": { - "unitPrice": { - "type": "number", - "format": "float" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalPrice": { - "type": "number", - "format": "float" + "name": { + "type": "string" }, - "quantity": { + "description": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "minimumExecutionCount": { "type": "integer", "format": "int64" }, - "calculatedTaxes": { - "type": "object" + "activeStorefrontLabel": { + "type": "boolean" }, - "taxRules": { - "type": "object" + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "referencePrice": { - "type": "object" + "discountPercentage": { + "type": "number", + "format": "float" }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" - }, - "percentage": { - "type": "number", - "format": "float" - } - }, + "label": { + "type": "string" + }, + "discountPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object" }, - "regulationPrice": { + "relationships": { "properties": { - "price": { - "type": "number", - "format": "float" + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, + "type": "object" } }, "type": "object" } }, "type": "object" + } + ] + }, + "SubscriptionPlan": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unitPrice": { - "type": "number", - "format": "float" + "name": { + "type": "string" }, - "totalPrice": { - "type": "number", - "format": "float" + "description": { + "type": "string" }, - "quantity": { + "active": { + "type": "boolean" + }, + "minimumExecutionCount": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" + "activeStorefrontLabel": { + "type": "boolean" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "discountPercentage": { + "type": "number", + "format": "float" + }, + "label": { + "type": "string" + }, + "discountPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -14276,71 +11837,120 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "subscriptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } } }, "type": "object" }, - "QuoteDocument": { + "SubscriptionPlanIntervalMapping": { "required": [ - "id", - "documentTypeId", - "fileType", - "quoteId", - "config", - "deepLinkCode" + "subscriptionIntervalId", + "subscriptionPlanId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "subscriptionIntervalId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentNumber": { - "type": "string" + "subscriptionPlanId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { + "subscriptionPlan": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "subscriptionInterval": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + }, + "type": "object" + }, + "SubscriptionPlanProductMapping": { + "required": [ + "productId", + "subscriptionPlanId" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "quoteId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteVersionId": { + "subscriptionPlanId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "subscriptionPlan": { + "$ref": "#/components/schemas/SubscriptionPlan" }, - "sent": { - "type": "boolean" + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "SubscriptionTagMapping": { + "required": [ + "subscriptionId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "static": { - "type": "boolean" + "subscriptionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "deepLinkCode": { - "type": "string" + "subscription": { + "$ref": "#/components/schemas/Subscription" }, - "documentMediaFileId": { + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "SwagDelayAction": { + "required": [ + "id" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentA11yMediaFileId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -14351,37 +11961,38 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "quote": { - "$ref": "#/components/schemas/Quote" - }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" - }, - "documentA11yMediaFile": { - "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "QuoteEmployee": { + "SystemConfig": { + "description": "Added since version: 6.0.0.0", "required": [ - "firstName", - "lastName" + "id", + "configurationKey", + "configurationValue" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { + "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, - "lastName": { - "type": "string" + "configurationValue": { + "properties": { + "_value": { + "type": "object" + } + }, + "type": "object" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -14392,133 +12003,112 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "QuoteLineItem": { - "description": "Added since version: 6.5.3.0", + "Tag": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "quoteId", - "identifier", - "children", - "states", - "label", - "quantity", - "position" + "name" ], "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": { + "name": { "type": "string" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "productId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Tax": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "taxRate", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "deprecated": true - }, - "label": { - "type": "string" + "taxRate": { + "description": "Rate of tax.", + "type": "number", + "format": "float" }, - "description": { + "name": { + "description": "Name defined for a Tax.", "type": "string" }, - "quantity": { + "position": { + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, - "type": { - "type": "string" - }, - "payload": { - "type": "object" - }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "priceDefinition": { + "customFields": { "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" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "good": { - "type": "boolean" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "TaxProvider": { + "description": "Added since version: 6.5.0.0", + "required": [ + "id", + "priority", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "removable": { + "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, - "stackable": { - "type": "boolean" + "name": { + "type": "string" }, - "position": { + "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, - "referencedId": { + "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, - "coverId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14535,116 +12125,109 @@ "format": "date-time", "readOnly": true }, - "parent": { - "$ref": "#/components/schemas/QuoteLineItem" - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteLineItem" - } + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "TaxRule": { + "description": "Added since version: 6.1.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cover": { - "$ref": "#/components/schemas/Media" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "deliveryPositions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "QuoteTransaction": { - "description": "Added since version: 6.5.3.0", + "TaxRuleType": { + "description": "Added since version: 6.1.0.0", "required": [ - "id", - "quoteId", - "paymentMethodId", - "amount" + "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "quoteId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "quoteVersionId": { + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "Theme": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "author", + "active" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "author": { + "type": "string" + }, + "description": { + "type": "string" + }, + "labels": { + "type": "object" + }, + "helpTexts": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "previewMediaId": { "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" - } - }, + "parentThemeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "baseConfig": { "type": "object" }, - "customFields": { + "configValues": { "type": "object" }, + "active": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -14655,15 +12238,23 @@ "format": "date-time", "readOnly": true }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "translated": { + "type": "object" + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } } }, "type": "object" }, - "Rule": { + "Unit": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "shortCode", "name" ], "properties": { @@ -14671,12 +12262,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the rule defined.", + "shortCode": { "type": "string" }, - "description": { - "description": "Description of the rule.", + "name": { "type": "string" }, "customFields": { @@ -14692,46 +12281,13 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "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" - } - }, + "translated": { "type": "object" } }, "type": "object" }, - "RuleCondition": { + "User": { "description": "Added since version: 6.0.0.0", "properties": { "id": { @@ -14751,133 +12307,336 @@ }, "type": "object" }, - "SalesChannel": { + "UserAccessKey": { "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "languageId", - "customerGroupId", - "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "name", - "homeEnabled" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of language used.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "customerGroupId": { - "description": "Unique identity of customer group.", + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "UserConfig": { + "description": "Added since version: 6.3.5.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "description": "Unique identity of currency used.", + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "UserRecovery": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of payment method used.", + "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}$" }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "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}$" }, - "countryId": { - "description": "Unique identity of country.", + "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}$" }, - "navigationCategoryId": { - "description": "Unique identity of navigation category.", + "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}$" }, - "navigationCategoryVersionId": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Customer": { + "type": "object", + "properties": { + "extensions": { + "properties": { + "specificFeatures": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_specific_features" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5cfb6fcb7542e25892e1a35cd6a06c54" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "navigationCategoryDepth": { - "description": "It determines the number of levels of subcategories in the storefront category menu.", - "type": "integer", - "format": "int64" + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerCategoryId": { - "description": "Unique identity of footer category.", + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "footerCategoryVersionId": { + "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "serviceCategoryId": { - "description": "Unique identity of service category.", + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "serviceCategoryVersionId": { + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailHeaderFooterId": { - "description": "Unique identity of mail header and footer.", + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hreflangDefaultDomainId": { - "description": "Unique identity of hreflangDefaultDomain.", + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementUnits": { - "$ref": "#/components/schemas/MeasurementUnits" + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "businessTimeZone": { - "description": "Business timezone used for sales-channel-specific rendering. Added since version: 6.7.13.0.", + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "name": { + "email": { + "description": "Email ID of the customer.", "type": "string" }, - "shortName": { - "description": "A short name for sales channel.", + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, - "taxCalculationType": { - "description": "Tax calculation types are `horizontal` and `vertical`.", + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, - "configuration": { - "type": "object" + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" }, "active": { - "description": "When boolean value is `true`, the sales channel is enabled.", + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, - "hreflangActive": { - "description": "When set to true, the sales channel pages are available in different languages.", + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, - "maintenance": { - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Customer registration double opt-in hash for confirming the customer account.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true + }, "customFields": { "type": "object" }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -14888,123 +12647,238 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, "language": { "$ref": "#/components/schemas/Language", - "description": "Default language for the sales channel" - }, - "currency": { - "$ref": "#/components/schemas/Currency", - "description": "Default currency for the sales channel" + "description": "Preferred language for customer communication" }, - "paymentMethod": { + "lastPaymentMethod": { "$ref": "#/components/schemas/PaymentMethod", - "description": "Default payment method for the sales channel" + "description": "Last used payment method by the customer" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod", - "description": "Default shipping method for the sales channel" + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, - "country": { - "$ref": "#/components/schemas/Country", - "description": "Default country for the sales channel" + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, - "domains": { - "description": "Domain URLs configured for the sales channel", + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" + }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" + }, + "addresses": { + "description": "All addresses saved for the customer", "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/CustomerAddress" } }, - "navigationCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for navigation menu" - }, - "footerCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for footer navigation" - }, - "serviceCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for service pages" + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "hreflangDefaultDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" + "apiAlias": { + "type": "string", + "enum": [ + "customer" + ] } }, - "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 + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "activeBillingAddress", + "activeShippingAddress", + "id", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" + ], + "oneOf": [ + { + "required": [ + "accountType" + ], + "properties": { + "accountType": { + "type": "string", + "enum": [ + "private" + ] + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "required": [ + "accountType", + "vatIds", + "company" + ], + "properties": { + "accountType": { + "type": "string", + "enum": [ + "business" + ] + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + }, + "company": { + "type": "string" + } + } } - }, - "type": "object" + ] }, - "SalesChannelDomain": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "url", - "salesChannelId", - "languageId", - "currencyId", - "snippetSetId" - ], + "CustomerAddress": { + "type": "object", "properties": { + "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" + }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { - "description": "URL of the sales channel domain.", - "type": "string" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of language used.", + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "description": "Unique identity of currency.", + "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "snippetSetId": { - "description": "Unique identity of snippet set.", + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementUnits": { - "$ref": "#/components/schemas/MeasurementUnits" + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "hreflangUseOnlyLocale": { - "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", - "type": "boolean" + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" + }, + "city": { + "description": "Name of customer's city.", + "type": "string" + }, + "company": { + "description": "Name of customer's company.", + "type": "string" + }, + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" }, + "isDefaultBillingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "isDefaultShippingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -15015,87 +12889,132 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "country": { + "$ref": "#/components/schemas/Country" }, - "currency": { - "$ref": "#/components/schemas/Currency" + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "salesChannelDefaultHreflang": { - "$ref": "#/components/schemas/SalesChannel" + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, - "type": "object" + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" + ] }, - "SalesChannelFile": { - "description": "Added since version: 6.7.12.0", + "Media": { + "type": "object", "properties": { + "extensions": { + "properties": { + "mediaAiTag": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3c88197809d464216a8c40a8db191b38" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" + }, + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" + }, + "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "fileName": { + "description": "Name of the media file uploaded.", + "type": "string" + }, + "fileSize": { + "description": "Size of the file media file uploaded.", + "type": "integer", + "format": "int64", "readOnly": true - } - }, - "type": "object" - }, - "SalesChannelTrackingCustomer": { - "description": "Added since version: 6.7.9.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "height": { + "type": "integer", + "format": "int64" + }, + "width": { + "type": "integer", + "format": "int64" + } + } + }, + "config": { + "type": "object" + }, + "alt": { + "type": "string" + }, + "title": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SalesChannelTrackingOrder": { - "description": "Added since version: 6.7.9.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "path": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SalesChannelType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "hasFile": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "private": { + "description": "When `true`, the media display is kept private.", + "type": "boolean" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -15109,345 +13028,477 @@ }, "translated": { "type": "object" + }, + "thumbnails": { + "description": "Generated thumbnail images in various sizes", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "media" + ] } }, - "type": "object" - }, - "SalutationJsonApi": { "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "salutationKey", - "displayName", - "letterName" - ], + "required": [ + "apiAlias", + "fileExtension", + "fileName", + "hasFile", + "path", + "private", + "url", + "id" + ] + }, + "Order": { + "type": "object", + "properties": { + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationKey": { - "description": "Technical name given to salutation. For example: mr", - "type": "string" - }, - "displayName": { - "type": "string" + "subscription": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + } + } + } + }, + "type": "object" }, - "letterName": { - "type": "string" + "initialSubscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } + } + } + } + }, + "type": "object" }, - "customFields": { + "returns": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" + } + } + } + } + }, "type": "object" }, - "position": { - "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", - "type": "integer", - "format": "int64" + "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" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "quote": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } + } + }, + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" }, - "translated": { + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" + } + } + } + }, "type": "object" } }, "type": "object" - } - ] - }, - "Salutation": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "salutationKey", - "displayName", - "letterName" - ], - "properties": { + }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationKey": { - "description": "Technical name given to salutation. For example: mr", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "displayName": { + "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, - "letterName": { - "type": "string" + "billingAddressId": { + "description": "Unique identity of the billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "billingAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", - "type": "integer", - "format": "int64" + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "primaryOrderDeliveryVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "primaryOrderTransactionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "ScheduledTask": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "primaryOrderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "currencyId": { + "description": "Unique identity of the currency.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "languageId": { + "description": "Unique identity of the language.", "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Script": { - "description": "Added since version: 6.4.7.0", - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "orderDate": { + "description": "Date when the order was placed.", "type": "string", - "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "SeoUrlJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { + "price": { "required": [ - "id", - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo" + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "netPrice": { + "type": "number", + "format": "float" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "totalPrice": { + "type": "number", + "format": "float" }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedTaxes": { + "type": "object" }, - "foreignKey": { - "description": "The key that references to product or category entity ID.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "taxRules": { + "type": "object" }, - "routeName": { - "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string", - "enum": [ - "frontend.navigation.page", - "frontend.landing.page", - "frontend.bundle.detail.page", - "frontend.detail.page" - ] + "positionPrice": { + "type": "number", + "format": "float" }, - "pathInfo": { - "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", - "type": "string" + "rawTotal": { + "type": "number", + "format": "float" }, - "seoPathInfo": { - "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", + "taxStatus": { "type": "string" + } + }, + "type": "object", + "$ref": "#/components/schemas/CalculatedPrice" + }, + "amountTotal": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", + "readOnly": true + }, + "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", + "type": "number", + "format": "float", + "readOnly": true + }, + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "type": "string", + "readOnly": true + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" }, - "isCanonical": { - "description": "When set to true, search redirects to the main URL.", - "type": "boolean" - }, - "isModified": { - "description": "When boolean value is `true`, the seo url is changed.", - "type": "boolean" + "totalPrice": { + "type": "number", + "format": "float" }, - "isDeleted": { - "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", - "type": "boolean" + "quantity": { + "type": "integer", + "format": "int64" }, - "error": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "calculatedTaxes": { + "type": "object" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "taxRules": { + "type": "object" }, - "customFields": { + "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": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" } }, "type": "object" - } - ] - }, - "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}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { - "description": "The key that references to product or category entity ID.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shippingTotal": { + "description": "Total shipping cost of the ordered product.", + "type": "number", + "format": "float", + "readOnly": true }, - "routeName": { - "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string", - "enum": [ - "frontend.navigation.page", - "frontend.landing.page", - "frontend.bundle.detail.page", - "frontend.detail.page" - ] + "currencyFactor": { + "description": "Rate at which currency is exchanged.", + "type": "number", + "format": "float" }, - "pathInfo": { - "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", + "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, - "seoPathInfo": { - "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, - "isCanonical": { - "description": "When set to true, search redirects to the main URL.", - "type": "boolean" - }, - "isModified": { - "description": "When boolean value is `true`, the seo url is changed.", - "type": "boolean" + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" }, - "isDeleted": { - "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", - "type": "boolean" + "customerComment": { + "description": "Comments given by comments.", + "type": "string" }, - "error": { - "description": "Runtime field, cannot be used as part of the criteria.", + "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "taxCalculationType": { "type": "string" }, "customFields": { "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SeoUrlTemplate": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "isValid": { - "description": "Created SEO URL template can be made usable by setting `isValid` to true.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -15457,420 +13508,377 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" + }, + "primaryOrderDelivery": { + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" + }, + "primaryOrderTransaction": { + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" + }, + "orderCustomer": { + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" + }, + "addresses": { + "description": "All addresses associated with the order (billing and shipping)", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + }, + "billingAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" + }, + "deliveries": { + "description": "Delivery information including shipping address and tracking", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + }, + "lineItems": { + "description": "Order line items (products, discounts, fees)", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "transactions": { + "description": "Payment transactions for the order", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + }, + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "tags": { + "description": "Tags assigned to the order for organization and filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } } }, - "type": "object" + "description": "Added since version: 6.0.0.0", + "required": [ + "documents", + "orderDate", + "stateMachineState", + "price", + "id", + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor" + ] }, - "ShippingMethodJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "technicalName", - "deliveryTimeId", - "name" - ], + "OrderLineItem": { + "type": "object", + "properties": { + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "technicalName": { - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", - "type": "boolean" - }, - "position": { - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxType": { - "description": "Refers `Free`, `Net` or `Gross` type of taxes.", - "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": { + "returns": { "properties": { - "deliveryTime": { - "description": "Estimated delivery time information", - "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": { - "description": "Rule defining when this shipping method is available", - "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": { - "description": "Shipping prices based on weight, volume, or cart value", + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" } - }, - "type": "object" + } }, - "media": { - "description": "Shipping method logo or carrier image", - "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" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return_line_item" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" } } - }, - "type": "object" - }, - "tags": { - "description": "Tags for organizing shipping methods", - "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" + }, + "state": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" } - }, - "type": "object" + } }, - "tax": { - "description": "Tax configuration for shipping costs", + "data": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" - } - } + "type": { + "type": "string", + "example": "state_machine_state" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" } - }, - "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": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", - "type": "boolean" - }, - "position": { - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "mediaId": { - "description": "Unique identity of media.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime.", + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "taxType": { - "description": "Refers `Free`, `Net` or `Gross` type of taxes.", - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "productId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "trackingUrl": { - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "promotionId": { + "description": "Unique identity of product.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "parentId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime", - "description": "Estimated delivery time information" + "coverId": { + "description": "Unique identity of cover image.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule", - "description": "Rule defining when this shipping method is available" + "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", + "type": "string" }, - "prices": { - "description": "Shipping prices based on weight, volume, or cart value", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } + "referencedId": { + "description": "Unique identity of type of entity.", + "type": "string" }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Shipping method logo or carrier image" + "quantity": { + "description": "Number of items of product.", + "type": "integer", + "format": "int64" }, - "tags": { - "description": "Tags for organizing shipping methods", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "label": { + "description": "It is a typical product name given to the line item.", + "type": "string" }, - "tax": { - "$ref": "#/components/schemas/Tax", - "description": "Tax configuration for shipping costs" - } - }, - "type": "object" - }, - "ShippingMethodPrice": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "shippingMethodId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "payload": { + "type": "object", + "properties": { + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "features": { + "type": "array" + }, + "isCloseout": { + "type": "boolean" + }, + "isNew": { + "type": "boolean" + }, + "manufacturerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "markAsTopseller": { + "type": "boolean" + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productNumber": { + "type": "string" + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "releaseDate": { + "type": "string", + "format": "date-time" + }, + "stock": { + "type": "integer", + "format": "int64" + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productType": { + "$ref": "#/components/schemas/Product/properties/type" + } + } }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", + "type": "boolean" }, - "ruleId": { - "description": "Unique identity of rule.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", + "type": "boolean" }, - "calculation": { - "description": "Shipping price calculated based on quantity, price, weight or volume of items.", + "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", + "type": "boolean" + }, + "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "calculationRuleId": { - "description": "Unique identity of rule calculation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priceDefinition": { + "type": "object", + "$ref": "#/components/schemas/CartPriceQuantity" }, - "quantityStart": { - "description": "Starting range of quantity of an item.", + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, - "quantityEnd": { - "description": "Ending range of quantity of an item.", + "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, - "currencyPrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "description": { + "description": "Description of line items in an order.", + "type": "string" + }, + "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -15880,513 +13888,688 @@ "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": { - "description": "Unique identity od snippet set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "cover": { + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, - "translationKey": { - "description": "Reference to the snippet in the template.", - "type": "string" + "product": { + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, - "value": { - "description": "Value of the key.", - "type": "string" + "orderDeliveryPositions": { + "description": "Delivery positions for this line item", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } }, - "customFields": { - "type": "object" + "downloads": { + "description": "Digital downloads associated with this line item", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "parent": { + "$ref": "#/components/schemas/OrderLineItem" }, - "updatedAt": { + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "order_line_item" + ] + }, + "translated": { + "type": "object" } }, - "type": "object" - }, - "SnippetSet": { "description": "Added since version: 6.0.0.0", "required": [ - "name", - "iso" - ], + "apiAlias", + "id", + "orderId", + "identifier", + "quantity", + "label", + "children", + "states" + ] + }, + "Product": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of snippet set.", - "type": "string" - }, - "iso": { - "description": "ISO nomenclature used to classify languages.", - "type": "string" - }, - "customFields": { + "extensions": { + "properties": { + "reviewSummaries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "c9c718522e64ffa5effb26cef94f4849" + } + } + } + } + }, + "type": "object" + }, + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "d7706d2e11bc4878ffb242403ea5b274" + } + } + } + } + }, + "type": "object" + }, + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" + }, + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" + } + } + } + } + }, + "type": "object", + "readOnly": true + }, + "items": { + "description": "Products referenced as bundle items of this bundle.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/items" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "691d502cfd0e0626cd3b058e5682ad1c" + } + } + } + } + }, + "type": "object" + }, + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" + } + } + } + } + }, + "type": "object" + }, + "bundles": { + "description": "Bundles that include this product as an item.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "9e21e19f42862a3b26cd7aae135a3f74" + } + } + } + } + }, + "type": "object" + } + }, "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": { + "versionId": { "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": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "parentVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialSceneObject": { - "properties": { - "id": { + "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "productManufacturerVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SpatialScenePrimitive": { - "properties": { - "id": { + "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "taxId": { + "description": "Unique identity of tax.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SsoProvider": { - "properties": { - "id": { + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "productMediaVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "SsoProviderCustomer": { - "properties": { - "id": { + "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "canonicalProductVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "StateMachine": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "cmsPageVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", + "type": "string" }, - "states": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } + "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", + "type": "integer", + "format": "int64" }, - "transitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - }, - "type": "object" - }, - "StateMachineHistory": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", + "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" + }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", "readOnly": true }, - "fromStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "stock": { + "description": "Indicates the number of products available.", + "type": "integer", + "format": "int64" }, - "toStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - } - }, - "type": "object" - }, - "StateMachineState": { - "description": "Added since version: 6.0.0.0", - "required": [ - "translated", - "technicalName", - "name" - ], - "properties": { - "id": { + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "technicalName": { - "description": "Technical name of StateMachineState.", + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, - "name": { + "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, - "customFields": { - "type": "object" + "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", + "type": "integer", + "format": "int64" + }, + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" + }, + "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", + "type": "number", + "format": "float" + }, + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" + }, + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" + }, + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" + }, + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" + }, + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" + }, + "length": { + "description": "The length of the product.", + "type": "number", + "format": "float" + }, + "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", + "type": "string", + "format": "date-time" + }, + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true }, - "createdAt": { - "type": "string", - "format": "date-time", + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "readOnly": true }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "StateMachineTransition": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "createdAt": { - "type": "string", - "format": "date-time", + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "readOnly": true - } - }, - "type": "object" - }, - "Subscription": { - "required": [ - "id", - "convertedOrder", - "subscriptionNumber", - "nextSchedule", - "followingNextSchedule", - "salesChannelId", - "subscriptionPlanName", - "subscriptionIntervalName", - "dateInterval", - "cronInterval", - "billingAddressId", - "shippingAddressId", - "shippingMethodId", - "paymentMethodId", - "currencyId", - "languageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "convertedOrder": { - "type": "object" + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "subscriptionNumber": { - "type": "string" + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "nextSchedule": { - "type": "string", - "format": "date-time" + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "followingNextSchedule": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "format": "date-time" + "metaDescription": { + "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "subscriptionPlanId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "keywords": { + "type": "string" }, - "subscriptionPlanName": { + "description": { "type": "string" }, - "subscriptionIntervalId": { + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "subscriptionIntervalName": { + "metaTitle": { "type": "string" }, - "dateInterval": { + "packUnit": { "type": "string" }, - "cronInterval": { + "packUnitPlural": { "type": "string" }, - "initialExecutionCount": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, - "remainingExecutionCount": { - "type": "integer", - "format": "int64" + "ogTitle": { + "type": "string" }, - "billingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "ogDescription": { + "type": "string" }, - "shippingAddressId": { + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "physical", + "digital" + ] }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedPrice": { + "type": "object", + "$ref": "#/components/schemas/CalculatedPrice" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedPrices": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "allOf": [ + { + "$ref": "#/components/schemas/CalculatedPrice" + } + ] + } }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedMaxPurchase": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" }, - "initialOrderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedCheapestPrice": { + "type": "object", + "properties": { + "unitPrice": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ReferencePrice" + }, + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + } + }, + "required": [ + "price" + ] + }, + { + "type": "null" + } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "" + }, + { + "type": "null" + } + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_cheapest_price" + ] + } + } }, - "initialOrderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isNew": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "customFields": { + "sortedProperties": { "type": "object" }, + "measurements": { + "type": "object", + "$ref": "#/components/schemas/ProductMeasurements" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16397,192 +14580,235 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "subscriptionEmployee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionEmployee" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_subscription_employee" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "a4844d7989267e34103e44248b16cf6c" - } - } - } - }, - "type": "object" - }, - "subscriptionBudget": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionBudget" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_subscription_budget" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "6b2732717e6360e8eccfd947596f4e64" - } - } - } - }, - "type": "object" - } - }, + "translated": { "type": "object" }, - "subscriptionPlan": { - "$ref": "#/components/schemas/SubscriptionPlan" + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } }, - "subscriptionInterval": { - "$ref": "#/components/schemas/SubscriptionInterval" + "parent": { + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, - "subscriptionCustomer": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "children": { + "description": "Product variants that inherit from this parent product", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "billingAddress": { - "$ref": "#/components/schemas/SubscriptionAddress" + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, - "shippingAddress": { - "$ref": "#/components/schemas/SubscriptionAddress" + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, - "addresses": { + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" + }, + "unit": { + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" + }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" + }, + "canonicalProduct": { + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" + }, + "media": { + "description": "Product images and media gallery", "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/ProductMedia" } }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "productReviews": { + "description": "Customer reviews and ratings for the product", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } }, - "orders": { + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "properties": { + "description": "Product properties and characteristics for filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "categories": { + "description": "Categories this product is assigned to", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + }, + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" } }, "tags": { + "description": "Tags for organizing and filtering products", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, - "currency": { - "$ref": "#/components/schemas/Currency" + "seoCategory": { + "$ref": "#/components/schemas/Category", + "description": "Main category used for SEO URL generation in the current sales channel" }, - "language": { - "$ref": "#/components/schemas/Language" + "apiAlias": { + "type": "string", + "enum": [ + "product" + ] }, - "initialOrder": { - "$ref": "#/components/schemas/Order" + "variantListingConfig": { + "oneOf": [ + { + "type": "object", + "properties": { + "displayParent": { + "type": "boolean" + } + } + }, + { + "type": "null" + } + ] } }, - "type": "object" + "description": "Represents a product along with detailed information required to display a variant selection.", + "required": [ + "apiAlias", + "calculatedPrice", + "calculatedPrices", + "seoCategory", + "type", + "translated", + "id", + "taxId", + "productNumber", + "stock", + "name" + ] }, - "SubscriptionAddress": { + "NewsletterStatus": { + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct", + "undefined" + ], + "description": "The subscription status. Possible values are: notSet, optIn, optOut, direct, undefined." + }, + "MediaThumbnail": { + "description": "Added since version: 6.0.0.0", "required": [ + "url", "id", - "countryId", - "subscriptionId", - "firstName", - "lastName", - "street", - "city" + "mediaId", + "width", + "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "street": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { - "type": "string" - }, - "vatId": { - "type": "string" - }, - "phoneNumber": { - "type": "string" + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "additionalAddressLine1": { - "type": "string" + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "additionalAddressLine2": { + "url": { + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", + "path": { "type": "string" }, "customFields": { @@ -16597,455 +14823,462 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "billingSubscription": { - "$ref": "#/components/schemas/Subscription" - }, - "shippingSubscription": { - "$ref": "#/components/schemas/Subscription" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - }, - "subscription": { - "$ref": "#/components/schemas/Subscription" } }, "type": "object" }, - "SubscriptionCustomer": { - "required": [ - "id", - "salutationId", - "email", - "firstName", - "lastName" - ], + "Breadcrumb": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "customerId": { + "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "$ref": "#/components/schemas/Category/properties/type" }, - "email": { - "type": "string" + "translated": { + "type": "object", + "additionalProperties": true, + "properties": { + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "$ref": "#/components/schemas/Category/properties/linkType" + }, + "internalLink": { + "type": "string" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + } + } }, - "firstName": { + "path": { "type": "string" }, - "lastName": { - "type": "string" + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } }, - "company": { - "type": "string" + "apiAlias": { + "type": "string", + "enum": [ + "breadcrumb" + ] + } + }, + "required": [ + "name", + "categoryId", + "type", + "translated", + "path", + "apiAlias" + ] + }, + "ProductPurchaseLimit": { + "type": "object", + "description": "Current quantity purchase limits for a product.", + "required": [ + "productId", + "minPurchase", + "purchaseSteps", + "maxPurchase", + "stock", + "apiAlias" + ], + "properties": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The product ID." }, - "title": { - "type": "string" + "minPurchase": { + "type": "integer", + "description": "Minimum quantity a customer can purchase." }, - "customerNumber": { - "type": "string" + "purchaseSteps": { + "type": "integer", + "description": "Step increment for quantity selection." }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } + "maxPurchase": { + "type": "integer", + "description": "Maximum quantity a customer can purchase, reflecting current stock for closeout products." }, - "customFields": { - "type": "object" + "stock": { + "type": [ + "integer", + "null" + ], + "description": "Current stock level of the product." }, - "createdAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "product_purchase_limit" + ] + } + } + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "field": { + "type": "string" } }, - "type": "object" - }, - "SubscriptionInterval": { "required": [ - "id", "name", - "delayed" - ], + "type", + "field" + ] + }, + "LineItemType": { + "type": "string", + "deprecated": true, + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity" + ] + }, + "LineItem": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "name": { - "type": "string" + "cover": { + "$ref": "#/components/schemas/Media" }, - "active": { - "type": "boolean" + "dataContextHash": { + "type": "string" }, - "dateInterval": { + "dataTimestamp": { "type": "string" }, - "cronInterval": { + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { "type": "string" }, - "delayed": { - "description": "Runtime field, cannot be used as part of the criteria.", + "good": { "type": "boolean" }, - "availabilityRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "id": { + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "label": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "modified": { + "type": "boolean" }, - "translated": { - "type": "object" + "modifiedByApp": { + "type": "boolean" }, - "subscriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Subscription" - } - } - }, - "type": "object" - }, - "SubscriptionPlanJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "payload": { + "$ref": "#/components/schemas/ProductJsonApi" }, - { - "required": [ - "id", - "name" - ], + "price": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "minimumExecutionCount": { - "type": "integer", - "format": "int64" - }, - "activeStorefrontLabel": { - "type": "boolean" - }, - "availabilityRuleId": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "discountPercentage": { - "type": "number", - "format": "float" - }, - "label": { - "type": "string" + "enum": [ + "calculated_price" + ] }, - "discountPrice": { + "calculatedTaxes": { "type": "array", "items": { - "$ref": "#/components/schemas/Price" + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "quantity": { + "type": "number" }, - "translated": { - "type": "object" + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] }, - "relationships": { - "properties": { - "subscriptions": { + "regulationPrice": { + "oneOf": [ + { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/subscriptions" - } - } + "price": { + "type": "number" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } + "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" }, - "type": "object" + "name": { + "type": "string" + } } - }, - "type": "object" + } } }, - "type": "object" - } - ] - }, - "SubscriptionPlan": { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] }, - "name": { - "type": "string" + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" }, - "description": { - "type": "string" + "quantity": { + "type": "number" }, - "active": { - "type": "boolean" + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" + } + } }, - "minimumExecutionCount": { - "type": "integer", - "format": "int64" + "referencedId": { + "type": "string" }, - "activeStorefrontLabel": { + "removable": { "type": "boolean" }, - "availabilityRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "discountPercentage": { - "type": "number", - "format": "float" - }, - "label": { - "type": "string" + "stackable": { + "type": "boolean" }, - "discountPrice": { + "states": { + "deprecated": true, "type": "array", "items": { - "$ref": "#/components/schemas/Price" + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" + "type": { + "$ref": "#/components/schemas/OrderLineItem/properties/type" }, - "subscriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Subscription" - } + "uniqueIdentifier": { + "type": "string" } }, - "type": "object" - }, - "SubscriptionPlanIntervalMapping": { "required": [ - "subscriptionIntervalId", - "subscriptionPlanId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionIntervalId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionPlanId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionPlan": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "subscriptionInterval": { - "$ref": "#/components/schemas/SubscriptionInterval" - } - }, - "type": "object" + "id", + "type" + ] }, - "SubscriptionPlanProductMapping": { + "CookieEntryCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CookieEntry" + } + }, + "CmsSection": { + "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "subscriptionPlanId" + "apiAlias", + "blocks", + "id", + "position", + "type", + "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "subscriptionPlanId": { + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "subscriptionPlan": { - "$ref": "#/components/schemas/SubscriptionPlan" + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "type": "integer", + "format": "int64" }, - "product": { - "$ref": "#/components/schemas/Product" - } - }, - "type": "object" - }, - "SubscriptionTagMapping": { - "required": [ - "subscriptionId", - "tagId" - ], - "properties": { - "id": { + "type": { + "description": "Types of sections can be `default` or `sidebar`.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "default", + "sidebar" + ] }, - "subscriptionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Name of the CMS section defined.", + "type": "string" }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", + "type": "string" }, - "subscription": { - "$ref": "#/components/schemas/Subscription" + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "SwagDelayAction": { - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "backgroundColor": { + "description": "Background color of CMS page.", + "type": "string" }, - "orderId": { + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SystemConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "configurationKey", - "configurationValue" - ], - "properties": { - "id": { + "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configurationKey": { - "description": "Config key for shop configurations.", - "type": "string" - }, - "configurationValue": { + "visibility": { "properties": { - "_value": { - "type": "object" + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" } }, "type": "object" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -17057,140 +15290,182 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "Tag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "page": { + "$ref": "#/components/schemas/CmsPage" }, - "name": { - "type": "string" + "backgroundMedia": { + "$ref": "#/components/schemas/Media" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "cms_section" + ] } }, "type": "object" }, - "Tax": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "taxRate", - "name" - ], + "ProductMeasurements": { + "type": "object", + "description": "Runtime field, cannot be used as part of the criteria. Measurements of a product, including dimensions and weight.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxRate": { - "description": "Rate of tax.", - "type": "number", - "format": "float" - }, - "name": { - "description": "Name defined for a Tax.", - "type": "string" - }, - "position": { - "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", - "type": "integer", - "format": "int64" + "width": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" + }, + "value": { + "type": "number" + } + } }, - "customFields": { - "type": "object" + "height": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" + }, + "value": { + "type": "number" + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "length": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" + }, + "value": { + "type": "number" + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "weight": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg" + }, + "value": { + "type": "number" + } + } } - }, - "type": "object" + } }, - "TaxProvider": { - "description": "Added since version: 6.5.0.0", + "CookieGroupCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CookieGroup" + } + }, + "Document": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "priority", - "name" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "active": { - "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", - "type": "boolean" - }, - "name": { - "type": "string" - }, - "priority": { - "description": "A numerical value to prioritize one of the tax providers from the list.", - "type": "integer", - "format": "int64" - }, - "processUrl": { - "description": "External URL makes request to get tax info.", - "type": "string" + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "description": "Unique identity of app.", + "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "documentMediaFileId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "documentA11yMediaFileId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "TaxRule": { - "description": "Added since version: 6.1.0.0", - "properties": { - "id": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "config": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "name", + "title" + ] + }, + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentNumber": { + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -17200,114 +15475,172 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "TaxRuleType": { - "description": "Added since version: 6.1.0.0", - "required": [ - "typeName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "order": { + "$ref": "#/components/schemas/Order" }, - "translated": { - "type": "object" + "referencedDocument": { + "$ref": "#/components/schemas/Document" + }, + "dependentDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "fileType": { + "type": "string" } }, "type": "object" }, - "Theme": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "author", - "active" - ], + "EntitySearchResult": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "author": { - "type": "string" - }, - "description": { + "entity": { "type": "string" }, - "labels": { - "type": "object" - }, - "helpTexts": { - "type": "object" + "total": { + "type": "integer", + "description": "The total number of found entities" }, - "customFields": { - "type": "object" + "aggregations": { + "type": "array", + "description": "Contains aggregated data. A simple example is the determination of the average price from a product search query.", + "items": { + "type": "object" + } }, - "previewMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "page": { + "type": "integer", + "description": "The actual page. This can be used for pagination." }, - "parentThemeId": { + "limit": { + "type": "integer", + "description": "The actual limit. This is used for pagination and goes together with the page." + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "baseConfig": { - "type": "object" + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" }, - "configValues": { - "type": "object" + "net": { + "description": "Net price for the associated currency.", + "type": "number" }, - "active": { + "linked": { + "description": "Whether gross and net prices are linked through the tax configuration.", "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "percentage": { + "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", + "type": [ + "object", + "null" + ], + "properties": { + "gross": { + "description": "Discount percentage relative to the gross list price.", + "type": "number" + }, + "net": { + "description": "Discount percentage relative to the net list price.", + "type": "number" + } + }, + "required": [ + "gross", + "net" + ] }, - "translated": { - "type": "object" + "listPrice": { + "description": "Reference list price for displaying discounts.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross list price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net list price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net list prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } + "regulationPrice": { + "description": "Reference price used for legal price disclosures.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross regulation price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net regulation price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net regulation prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] } }, - "type": "object" + "required": [ + "currencyId", + "gross", + "net" + ] }, - "Unit": { + "PropertyGroupOption": { "description": "Added since version: 6.0.0.0", "required": [ + "group", + "option", + "translated", "id", - "shortCode", + "groupId", "name" ], "properties": { @@ -17315,38 +15648,34 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "type": "string" + "groupId": { + "description": "Unique identity of property group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "position": { + "type": "integer", + "format": "int64" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", + "type": "string" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "User": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -17356,747 +15685,1135 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "group": { + "$ref": "#/components/schemas/PropertyGroup" + }, + "option": { + "type": "string" } }, "type": "object" }, - "UserAccessKey": { - "description": "Added since version: 6.0.0.0", + "CartItems": { + "type": "object", + "required": [ + "items" + ], "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 + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } } - }, - "type": "object" + } }, - "UserConfig": { - "description": "Added since version: 6.3.5.0", + "CookieRouteResponse": { + "type": "object", + "description": "Response containing cookie groups and their configuration hash.", "properties": { - "id": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "cookie_groups_hash" + ] }, - "createdAt": { + "elements": { + "type": "array", + "description": "Collection of cookie groups", + "items": { + "$ref": "#/components/schemas/CookieGroup" + } + }, + "hash": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Hash of the current cookie configuration. Can be used to detect changes in cookie configuration.", + "example": "f86b6a872cb83dbd22d838ceda1aa3d4" }, - "updatedAt": { + "languageId": { "type": "string", - "format": "date-time", - "readOnly": true + "format": "uuid", + "description": "The language ID for which the cookie configuration was generated. Used to store hashes per language.", + "example": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" + } + }, + "required": [ + "elements", + "hash", + "languageId", + "apiAlias" + ], + "example": { + "apiAlias": "cookie_groups_hash", + "elements": [ + { + "isRequired": true, + "description": "Cookies required for this shop to function:", + "name": "Technically required", + "entries": [ + { + "name": "Session", + "hidden": false, + "cookie": "session-", + "apiAlias": "cookie_entry" + }, + { + "name": "Timezone", + "hidden": false, + "cookie": "timezone", + "apiAlias": "cookie_entry" + }, + { + "value": "1", + "expiration": 30, + "name": "Cookie preferences", + "hidden": true, + "cookie": "cookie-preference", + "apiAlias": "cookie_entry" + } + ], + "apiAlias": "cookie_group" + }, + { + "isRequired": false, + "description": "Cookies used for statistics and shop performance metrics.", + "name": "Statistics", + "entries": [ + { + "value": "1", + "expiration": 30, + "name": "Google Analytics", + "hidden": false, + "cookie": "google-analytics-enabled", + "apiAlias": "cookie_entry" + } + ], + "apiAlias": "cookie_group" + }, + { + "isRequired": false, + "description": "Allows Google to collect personal data for online advertising and marketing.", + "name": "Marketing", + "entries": [ + { + "value": "1", + "expiration": 30, + "name": "Google Advertising", + "hidden": false, + "cookie": "google-ads-enabled", + "apiAlias": "cookie_entry" + } + ], + "apiAlias": "cookie_group" + }, + { + "isRequired": false, + "name": "Comfort features", + "entries": [ + { + "value": "1", + "expiration": 30, + "name": "YouTube video", + "hidden": false, + "cookie": "youtube-video", + "apiAlias": "cookie_entry" + } + ], + "apiAlias": "cookie_group" + } + ], + "hash": "f86b6a872cb83dbd22d838ceda1aa3d4", + "languageId": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" + } + }, + "ShippingMethodPageRouteResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "deliveryTimeId": { + "type": "string" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int32" + }, + "max": { + "type": "integer", + "format": "int32" + }, + "unit": { + "type": "string" + } + } + }, + "translations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "shippingMethodId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + }, + "orderDeliveries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "orderId": { + "type": "string" + }, + "shippingOrderAddressId": { + "type": "string" + }, + "shippingMethodId": { + "type": "string" + }, + "shippingDateEarliest": { + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "stateId": { + "type": "string" + } + } + } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "typeId": { + "type": "string" + }, + "languageId": { + "type": "string" + }, + "currencyId": { + "type": "string" + }, + "paymentMethodId": { + "type": "string" + }, + "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" + }, + "maintenanceIpAllowlist": { + "type": "string" + }, + "maintenanceIpWhitelist": { + "deprecated": true, + "type": "string" + }, + "mailHeaderFooterId": { + "type": "string" + }, + "customerGroupId": { + "type": "string" + }, + "hreflangActive": { + "type": "boolean" + }, + "hreflangDefaultDomainId": { + "type": "string" + } + } + } + }, + "salesChannels": { + "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" + }, + "maintenanceIpAllowlist": { + "type": "string" + }, + "maintenanceIpWhitelist": { + "deprecated": true, + "type": "string" + }, + "mailHeaderFooterId": { + "type": "string" + }, + "customerGroupId": { + "type": "string" + }, + "hreflangActive": { + "type": "boolean" + }, + "hreflangDefaultDomainId": { + "type": "string" + } + } + } + }, + "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", + "format": "float" + }, + "calculationRuleId": { + "type": "string" + } + } + } + }, + "mediaId": { + "type": "string" + }, + "media": { + "type": "object", + "properties": { + "userId": { + "type": "string" + }, + "mimeType": { + "type": "string" + }, + "fileExtension": { + "type": "string" + }, + "fileSize": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string" + }, + "metaDataRaw": { + "type": "string" + }, + "mediaTypeRaw": { + "type": "string" + }, + "uploadedAt": { + "type": "string", + "format": "date-time" + }, + "alt": { + "type": "string" + }, + "url": { + "type": "string" + }, + "fileName": { + "type": "string" + }, + "mediaFolderId": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "thumbnailsRo": { + "type": "string" + } + } + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + } + } } - }, - "type": "object" + } }, - "UserRecovery": { - "description": "Added since version: 6.0.0.0", + "CartPriceReference": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "purchaseUnit": { + "type": "number" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "referenceUnit": { + "type": "number" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Warehouse": { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitName": { + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "price": { + "type": "number" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "WarehouseGroup": { - "properties": { - "id": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "cart_price_reference" + ] }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } + }, + { + "type": "null" + } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] } }, - "type": "object" + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] }, - "Webhook": { - "description": "Added since version: 6.3.1.0", + "AggregationEntity": { + "title": "AggregationEntity", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "createdAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "entity" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" } }, - "type": "object" + "required": [ + "name", + "type", + "field", + "definition" + ] }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.0", + "AggregationFilter": { + "title": "AggregationFilter", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "createdAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "filter" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } } }, - "type": "object" - }, - "NewsletterStatus": { - "type": "string", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct", - "undefined" - ], - "description": "The subscription status. Possible values are: notSet, optIn, optOut, direct, undefined." + "required": [ + "name", + "type", + "filter" + ] }, - "Breadcrumb": { + "AggregationTerms": { + "title": "AggregationTerms", "type": "object", "properties": { "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "type": { - "$ref": "#/components/schemas/Category/properties/type" - }, - "translated": { - "type": "object", - "additionalProperties": true, - "properties": { - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "$ref": "#/components/schemas/Category/properties/linkType" - }, - "internalLink": { - "type": "string" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - } - } + "description": "The type of aggregation", + "type": "string", + "enum": [ + "terms" + ] }, - "path": { + "field": { + "description": "The field you want to aggregate over.", "type": "string" }, - "seoUrls": { + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { "type": "array", + "description": "Sorting the aggregation result.", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Sort" } - }, - "apiAlias": { - "type": "string", - "enum": [ - "breadcrumb" - ] } }, "required": [ "name", - "categoryId", "type", - "translated", - "path", - "apiAlias" + "field" ] }, - "ProductPurchaseLimit": { + "AggregationHistogram": { + "title": "AggregationHistogram", "type": "object", - "description": "Current quantity purchase limits for a product.", - "required": [ - "productId", - "minPurchase", - "purchaseSteps", - "maxPurchase", - "stock", - "apiAlias" - ], "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The product ID." + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "minPurchase": { - "type": "integer", - "description": "Minimum quantity a customer can purchase." + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "histogram" + ] }, - "purchaseSteps": { - "type": "integer", - "description": "Step increment for quantity selection." + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "maxPurchase": { - "type": "integer", - "description": "Maximum quantity a customer can purchase, reflecting current stock for closeout products." + "interval": { + "description": "The interval of the histogram", + "type": "number" }, - "stock": { - "type": [ - "integer", - "null" - ], - "description": "Current stock level of the product." + "format": { + "description": "The format of the histogram", + "type": "string" }, - "apiAlias": { - "type": "string", - "enum": [ - "product_purchase_limit" - ] + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" } - } + }, + "required": [ + "name", + "type", + "field" + ] }, - "AggregationMetrics": { + "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": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" + "range" ] }, "field": { + "description": "The field you want to aggregate over.", "type": "string" + }, + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { + "type": "object", + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] + } + ] + } } }, "required": [ "name", "type", - "field" - ] - }, - "LineItemType": { - "type": "string", - "deprecated": true, - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" + "field", + "ranges" ] }, - "LineItem": { - "type": "object", + "LandingPage": { + "description": "Added since version: 6.4.0.0", + "required": [ + "apiAlias", + "id", + "name", + "url" + ], "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cover": { - "$ref": "#/components/schemas/Media" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "dataContextHash": { + "active": { + "type": "boolean" + }, + "name": { "type": "string" }, - "dataTimestamp": { + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "metaTitle": { "type": "string" }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" + "metaDescription": { + "type": "string" }, - "description": { + "keywords": { "type": "string" }, - "good": { - "type": "boolean" + "url": { + "type": "string" }, - "id": { + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "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" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" + }, + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "landing_page" + ] + } + }, + "type": "object" + }, + "Cart": { + "type": "object", + "properties": { + "name": { + "description": "Name of the cart - for example `guest-cart`", "type": "string" }, - "label": { + "token": { + "description": "Context token identifying the cart and the user session", "type": "string" }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { - "type": "boolean" + "price": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "price": { + "errors": { "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "anyOf": [ + { "type": "array", "items": { + "$ref": "#/components/schemas/CartError" + } + }, + { + "type": "object", + "additionalProperties": { "type": "object", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { + "code": { "type": "number" }, - "taxRate": { - "type": "number" + "key": { + "type": "string" }, - "price": { + "level": { "type": "number" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" } }, "required": [ - "apiAlias", - "tax", - "taxRate", - "price" + "code", + "key", + "level", + "message", + "messageKey" ] } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "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": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" ] }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" - }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" - } - } - }, - "referencedId": { - "type": "string" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "states": { - "deprecated": true, + "deliveries": { "type": "array", "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] + "$ref": "#/components/schemas/CartDelivery" } }, - "type": { - "$ref": "#/components/schemas/OrderLineItem/properties/type" - }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "CookieEntryCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CookieEntry" - } - }, - "ProductMeasurements": { - "type": "object", - "description": "Runtime field, cannot be used as part of the criteria. Measurements of a product, including dimensions and weight.", - "properties": { - "width": { - "type": "object", - "properties": { - "unit": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm" - }, - "value": { - "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" + } } } }, - "height": { - "type": "object", - "properties": { - "unit": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm" + "modified": { + "type": "boolean" + }, + "customerComment": { + "description": "A comment that can be added to the cart.", + "oneOf": [ + { + "type": "string" }, - "value": { - "type": "number" + { + "type": "null" } - } + ] }, - "length": { - "type": "object", - "properties": { - "unit": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm" + "affiliateCode": { + "description": "An affiliate tracking code", + "oneOf": [ + { + "type": "string" }, - "value": { - "type": "number" + { + "type": "null" } - } + ] }, - "weight": { - "type": "object", - "properties": { - "unit": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg" + "campaignCode": { + "description": "A campaign tracking code", + "oneOf": [ + { + "type": "string" }, - "value": { - "type": "number" + { + "type": "null" } - } + ] + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart" + ] } - } - }, - "CookieGroupCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CookieGroup" - } + }, + "required": [ + "price", + "apiAlias" + ] }, - "EntitySearchResult": { - "type": "object", + "CmsBlock": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "slots", + "id", + "position", + "type", + "sectionId" + ], "properties": { - "entity": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "total": { - "type": "integer", - "description": "The total number of found entities" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "aggregations": { - "type": "array", - "description": "Contains aggregated data. A simple example is the determination of the average price from a product search query.", - "items": { - "type": "object" - } + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "page": { + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", - "description": "The actual page. This can be used for pagination." + "format": "int64" }, - "limit": { - "type": "integer", - "description": "The actual limit. This is used for pagination and goes together with the page." - } - } - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" }, - "gross": { - "description": "Gross price for the associated currency.", - "type": "number" + "name": { + "description": "Unique name of the CMS Block.", + "type": "string" }, - "net": { - "description": "Net price for the associated currency.", - "type": "number" + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" }, - "linked": { - "description": "Whether gross and net prices are linked through the tax configuration.", - "type": "boolean" + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" }, - "percentage": { - "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", - "type": [ - "object", - "null" - ], - "properties": { - "gross": { - "description": "Discount percentage relative to the gross list price.", - "type": "number" - }, - "net": { - "description": "Discount percentage relative to the net list price.", - "type": "number" - } - }, - "required": [ - "gross", - "net" - ] + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" }, - "listPrice": { - "description": "Reference list price for displaying discounts.", - "type": "object", - "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross list price for the associated currency.", - "type": "number" - }, - "net": { - "description": "Net list price for the associated currency.", - "type": "number" - }, - "linked": { - "description": "Whether gross and net list prices are linked through the tax configuration.", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" }, - "regulationPrice": { - "description": "Reference price used for legal price disclosures.", - "type": "object", + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross regulation price for the associated currency.", - "type": "number" + "mobile": { + "type": "boolean" }, - "net": { - "description": "Net regulation price for the associated currency.", - "type": "number" + "desktop": { + "type": "boolean" }, - "linked": { - "description": "Whether gross and net regulation prices are linked through the tax configuration.", + "tablet": { "type": "boolean" } }, - "required": [ - "gross", - "net" + "type": "object" + }, + "sectionId": { + "description": "Unique identity of section.", + "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 + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "slots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "cms_block" ] } }, - "required": [ - "currencyId", - "gross", - "net" - ] + "type": "object" }, - "CartItems": { + "CartItemsUpdate": { "type": "object", "required": [ "items" @@ -18105,2472 +16822,3338 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/LineItem" + "$ref": "#/components/schemas/CartLineItemUpdate" } } } }, - "CookieRouteResponse": { + "CartLineItemUpdate": { "type": "object", - "description": "Response containing cookie groups and their configuration hash.", + "required": [ + "id" + ], "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cookie_groups_hash" - ] + "id": { + "type": "string" }, - "elements": { - "type": "array", - "description": "Collection of cookie groups", - "items": { - "$ref": "#/components/schemas/CookieGroup" - } + "type": { + "$ref": "#/components/schemas/OrderLineItem/properties/type" }, - "hash": { - "type": "string", - "description": "Hash of the current cookie configuration. Can be used to detect changes in cookie configuration.", - "example": "f86b6a872cb83dbd22d838ceda1aa3d4" + "quantity": { + "type": "integer" }, - "languageId": { - "type": "string", - "format": "uuid", - "description": "The language ID for which the cookie configuration was generated. Used to store hashes per language.", - "example": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" - } - }, - "required": [ - "elements", - "hash", - "languageId", - "apiAlias" - ], - "example": { - "apiAlias": "cookie_groups_hash", - "elements": [ - { - "isRequired": true, - "description": "Cookies required for this shop to function:", - "name": "Technically required", - "entries": [ - { - "name": "Session", - "hidden": false, - "cookie": "session-", - "apiAlias": "cookie_entry" - }, - { - "name": "Timezone", - "hidden": false, - "cookie": "timezone", - "apiAlias": "cookie_entry" - }, - { - "value": "1", - "expiration": 30, - "name": "Cookie preferences", - "hidden": true, - "cookie": "cookie-preference", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - }, - { - "isRequired": false, - "description": "Cookies used for statistics and shop performance metrics.", - "name": "Statistics", - "entries": [ - { - "value": "1", - "expiration": 30, - "name": "Google Analytics", - "hidden": false, - "cookie": "google-analytics-enabled", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - }, - { - "isRequired": false, - "description": "Allows Google to collect personal data for online advertising and marketing.", - "name": "Marketing", - "entries": [ - { - "value": "1", - "expiration": 30, - "name": "Google Advertising", - "hidden": false, - "cookie": "google-ads-enabled", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - }, - { - "isRequired": false, - "name": "Comfort features", - "entries": [ - { - "value": "1", - "expiration": 30, - "name": "YouTube video", - "hidden": false, - "cookie": "youtube-video", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - } - ], - "hash": "f86b6a872cb83dbd22d838ceda1aa3d4", - "languageId": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" - } - }, - "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" + "referencedId": { + "type": "string" + }, + "label": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "stackable": { + "type": "boolean" + }, + "removable": { + "type": "boolean" + }, + "coverId": { + "type": "string" + }, + "priceDefinition": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "price": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "quantity": { + "type": "integer" + }, + "isCalculated": { + "type": "boolean" + }, + "listPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number" + }, + "percentage": { + "type": "number" + } } } } - }, - "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" - }, - "maintenanceIpAllowlist": { - "type": "string" - }, - "maintenanceIpWhitelist": { - "deprecated": true, - "type": "string" - }, - "mailHeaderFooterId": { - "type": "string" - }, - "customerGroupId": { - "type": "string" - }, - "hreflangActive": { - "type": "boolean" - }, - "hreflangDefaultDomainId": { - "type": "string" - } - } + } + } + } + }, + "ContextMeasurementSystemInfo": { + "type": "object", + "description": "Configuration of the measurement system used in the store, by default including units for length and weight.", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - }, - "salesChannels": { - "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" - }, - "maintenanceIpAllowlist": { - "type": "string" - }, - "maintenanceIpWhitelist": { - "deprecated": true, - "type": "string" - }, - "mailHeaderFooterId": { - "type": "string" - }, - "customerGroupId": { + } + } + } + }, + "AccountNewsletterRecipient": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/NewsletterStatus" + }, + "apiAlias": { + "type": "string", + "enum": [ + "account_newsletter_recipient" + ] + } + }, + "required": [ + "status", + "apiAlias" + ] + }, + "ProductListingCriteria": { + "allOf": [ + { + "$ref": "#/components/schemas/Criteria" + }, + { + "type": "object", + "description": "Additional search parameters for product listings", + "properties": { + "order": { + "description": "Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.", + "type": "string" + }, + "limit": { + "description": "Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings.", + "type": "integer", + "minimum": 0 + }, + "p": { + "description": "Search result page", + "type": "integer", + "default": 1 + }, + "manufacturer": { + "description": "Filter by manufacturers. List of manufacturer identifiers separated by a `|`.", + "type": "string" + }, + "min-price": { + "description": "Filters by a minimum product price. Has to be lower than the `max-price` filter.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "max-price": { + "description": "Filters by a maximum product price. Has to be higher than the `min-price` filter.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "rating": { + "description": "Filter products with a minimum average rating.", + "type": "integer" + }, + "shipping-free": { + "description": "Filters products that are marked as shipping-free.", + "type": "boolean", + "default": false + }, + "properties": { + "description": "Filters products by their properties. List of property identifiers separated by a `|`.", + "type": "string" + }, + "manufacturer-filter": { + "description": "Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "price-filter": { + "description": "Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "rating-filter": { + "description": "Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "shipping-free-filter": { + "description": "Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "property-filter": { + "description": "Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.", + "type": "boolean", + "default": true + }, + "property-whitelist": { + "description": "A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.", + "type": "string" + }, + "reduce-aggregations": { + "description": "By sending the parameter `reduce-aggregations` , the post-filters that were applied by the customer, are also applied to the aggregations. This has the consequence that only values are returned in the aggregations that would lead to further filter results. This parameter is a flag, the value has no effect.", + "oneOf": [ + { "type": "string" }, - "hreflangActive": { - "type": "boolean" - }, - "hreflangDefaultDomainId": { - "type": "string" + { + "type": "null" } - } + ] + } + } + } + ] + }, + "CartPriceQuantity": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" + ] + }, + "isCalculated": { + "type": "boolean" + }, + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" } }, - "availabilityRule": { + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { "type": "object", "properties": { - "name": { - "type": "string" + "taxRate": { + "type": "number", + "format": "float" }, - "description": { + "name": { "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", - "format": "float" - }, - "calculationRuleId": { - "type": "string" - } - } + } + }, + "type": { + "type": "string" + } + }, + "required": [ + "apiAlias" + ] + }, + "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.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" } - }, - "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" - } + ] + }, + "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.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } + ] + } + } + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" } } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" } } }, - "CartPriceReference": { - "type": "object", + "Association": { + "additionalProperties": { + "$ref": "#/components/schemas/Association" + } + }, + "CmsPage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "sections", + "id", + "type" + ], "properties": { - "purchaseUnit": { - "type": "number" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "referenceUnit": { - "type": "number" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unitName": { + "name": { "type": "string" }, - "price": { - "type": "number" + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - } - }, - { - "type": "null" + "config": { + "properties": { + "backgroundColor": { + "type": "string" } - ] + }, + "type": "object" }, - "hasRange": { - "type": "boolean" + "previewMediaId": { + "description": "Unique identity of media to be previewed.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "previewMedia": { + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" + }, + "landingPages": { + "description": "Landing pages using this CMS layout", + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "cms_page" ] } }, + "type": "object" + }, + "ProductDetailResponse": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "product": { + "$ref": "#/components/schemas/Product" + }, + "configurator": { + "type": "array", + "description": "List of property groups with their corresponding options and information on how to display them.", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" + "product" ] }, - "AggregationEntity": { - "title": "AggregationEntity", - "type": "object", + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "id", + "type", + "slot", + "blockId" + ], "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "type": "string" + }, + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, - "type": { - "description": "The type of aggregation", + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", + "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" + }, + "block": { + "$ref": "#/components/schemas/CmsBlock" + }, + "apiAlias": { "type": "string", "enum": [ - "entity" + "cms_slot" ] - }, - "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" - ] + "type": "object" }, - "AggregationFilter": { - "title": "AggregationFilter", + "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": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + "page": { + "description": "Search result page", + "type": "integer" + }, + "term": { + "description": "Search term", "type": "string" }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "filter" - ] + "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": { - "$ref": "#/components/schemas/Filters" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] } - } - }, - "required": [ - "name", - "type", - "filter" - ] - }, - "AggregationTerms": { - "title": "AggregationTerms", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" }, - "type": { - "description": "The type of aggregation", + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "query": { "type": "string", - "enum": [ - "terms" - ] + "description": "The query string to search for" }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "associations": { + "$ref": "#/components/schemas/Associations" }, - "limit": { - "description": "The number of terms to return", - "type": "number" + "post-filter": { + "type": "array", + "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, "sort": { "type": "array", - "description": "Sorting the aggregation result.", + "description": "Sorting in the search 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" - ] + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "interval": { - "description": "The interval of the histogram", - "type": "number" + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "format": { - "description": "The format of the histogram", - "type": "string" + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" }, - "timeZone": { - "description": "The timezone of the histogram", - "type": "string" + "includes": { + "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } - }, - "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)", + "NoneFieldsCriteria": { "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": { - "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" - ] + "page": { + "description": "Search result page", + "type": "integer" }, - "field": { - "description": "The field you want to aggregate over.", + "term": { + "description": "Search term", "type": "string" }, - "ranges": { - "description": "The ranges of the aggregation", + "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": { - "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" - ] + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "query": { + "type": "string", + "description": "The query string to search for" + }, + "associations": { + "$ref": "#/components/schemas/Associations" + }, + "post-filter": { + "type": "array", + "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, { - "type": "object", - "title": "From only", - "properties": { - "from": { - "type": "string", - "description": "The lower bound of the range" - } - }, - "required": [ - "from" - ] + "$ref": "#/components/schemas/EqualsFilter" }, { - "type": "object", - "title": "To only", - "properties": { - "to": { - "type": "string", - "description": "The upper bound of the range" - } - }, - "required": [ - "to" - ] + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } ] } - } - }, - "required": [ - "name", - "type", - "field", - "ranges" - ] - }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "$ref": "#/components/schemas/Sort" + } }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } }, - "lineItems": { - "description": "All items within the cart", + "grouping": { "type": "array", + "description": "Perform groupings over certain fields", "items": { - "$ref": "#/components/schemas/LineItem" + "type": "string", + "description": "Name of a field" } }, - "errors": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "anyOf": [ + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" + }, + "includes": { + "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" + } + } + }, + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Includes": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "title": "AggregationEntity", + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartError" - } + "$ref": "#/components/schemas/AggregationEntity" }, { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "key": { - "type": "string" - }, - "level": { - "type": "number" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } - }, - "required": [ - "code", - "key", - "level", - "message", - "messageKey" - ] - } + "$ref": "#/components/schemas/SubAggregations" } ] }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] }, - "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" - } + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/SubAggregations" } - } + ] }, - "modified": { - "type": "boolean" + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] }, - "customerComment": { - "description": "A comment that can be added to the cart.", - "oneOf": [ + { + "title": "AggregationRange", + "allOf": [ { - "type": "string" + "$ref": "#/components/schemas/AggregationRange" }, { - "type": "null" + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" } ] + } + } + }, + "TotalCountMode": { + "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", + "type": "string", + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" + ] + }, + "Query": { + "type": "object", + "properties": { + "score": { + "type": "number" }, - "affiliateCode": { - "description": "An affiliate tracking code", + "query": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/SimpleFilter" }, { - "type": "null" - } - ] - }, - "campaignCode": { - "description": "A campaign tracking code", - "oneOf": [ + "$ref": "#/components/schemas/EqualsFilter" + }, { - "type": "string" + "$ref": "#/components/schemas/MultiNotFilter" }, { - "type": "null" + "$ref": "#/components/schemas/RangeFilter" } ] + } + }, + "additionalProperties": true + }, + "Sort": { + "type": "object", + "properties": { + "field": { + "type": "string" }, - "apiAlias": { + "order": { "type": "string", "enum": [ - "cart" + "ASC", + "DESC" ] + }, + "naturalSorting": { + "type": "boolean" + }, + "type": { + "type": "string" } }, "required": [ - "price", - "apiAlias" + "field", + "order" ] }, - "CartItemsUpdate": { - "type": "object", - "required": [ - "items" - ], - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartLineItemUpdate" + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - } + ] } }, - "CartLineItemUpdate": { + "SimpleFilter": { "type": "object", - "required": [ - "id" - ], "properties": { - "id": { - "type": "string" - }, "type": { - "$ref": "#/components/schemas/OrderLineItem/properties/type" - }, - "quantity": { - "type": "integer" + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] }, - "referencedId": { + "field": { "type": "string" }, - "label": { + "value": { "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] }, - "payload": { - "type": "object" - }, - "stackable": { - "type": "boolean" - }, - "removable": { - "type": "boolean" - }, - "coverId": { + "field": { "type": "string" }, - "priceDefinition": { - "type": "object", - "properties": { - "type": { + "value": { + "oneOf": [ + { "type": "string" }, - "price": { - "type": "number" - }, - "percentage": { + { "type": "number" }, - "quantity": { - "type": "integer" - }, - "isCalculated": { + { "type": "boolean" }, - "listPrice": { - "type": "number" - }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number" - }, - "percentage": { - "type": "number" - } - } - } + { + "type": "null" } - } + ] } - } + }, + "required": [ + "type", + "field", + "value" + ] }, - "ContextMeasurementSystemInfo": { + "MultiNotFilter": { "type": "object", - "description": "Configuration of the measurement system used in the store, by default including units for length and weight.", "properties": { - "system": { + "type": { "type": "string", "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + "multi", + "not" + ] }, - "units": { + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] + }, + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "operator", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "type": "string" + }, + "parameters": { "type": "object", - "description": "Units used in the measurement system.", "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." + "gte": { + "type": "number" }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "gt": { + "type": "number" + }, + "lte": { + "type": "number" + }, + "lt": { + "type": "number" } } } - } + }, + "required": [ + "type", + "field", + "parameters" + ] }, - "AccountNewsletterRecipient": { + "CookieGroup": { "type": "object", "properties": { - "status": { - "$ref": "#/components/schemas/NewsletterStatus" + "isRequired": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "cookie": { + "type": "string" + }, + "value": { + "type": "string" + }, + "expiration": { + "type": "integer" + }, + "entries": { + "$ref": "#/components/schemas/CookieEntryCollection" }, "apiAlias": { "type": "string", "enum": [ - "account_newsletter_recipient" + "cookie_group" ] } }, + "not": { + "allOf": [ + { + "required": [ + "cookie" + ] + }, + { + "required": [ + "entries" + ] + } + ] + }, "required": [ - "status", + "name", + "isRequired", "apiAlias" ] }, - "ProductListingCriteria": { - "allOf": [ - { - "$ref": "#/components/schemas/Criteria" + "ProductMedia": { + "description": "Added since version: 6.0.0.0", + "required": [ + "media", + "id", + "productId", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of the media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "The order of the images to be displayed for a product.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { "type": "object", - "description": "Additional search parameters for product listings", "properties": { - "order": { - "description": "Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.", - "type": "string" - }, - "limit": { - "description": "Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings.", - "type": "integer", - "minimum": 0 - }, - "p": { - "description": "Search result page", - "type": "integer", - "default": 1 - }, - "manufacturer": { - "description": "Filter by manufacturers. List of manufacturer identifiers separated by a `|`.", - "type": "string" - }, - "min-price": { - "description": "Filters by a minimum product price. Has to be lower than the `max-price` filter.", - "type": "integer", - "minimum": 0, - "default": 0 - }, - "max-price": { - "description": "Filters by a maximum product price. Has to be higher than the `min-price` filter.", - "type": "integer", - "minimum": 0, - "default": 0 - }, - "rating": { - "description": "Filter products with a minimum average rating.", - "type": "integer" - }, - "shipping-free": { - "description": "Filters products that are marked as shipping-free.", - "type": "boolean", - "default": false - }, - "properties": { - "description": "Filters products by their properties. List of property identifiers separated by a `|`.", - "type": "string" - }, - "manufacturer-filter": { - "description": "Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.", - "type": "boolean", - "default": true - }, - "price-filter": { - "description": "Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.", - "type": "boolean", - "default": true - }, - "rating-filter": { - "description": "Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.", - "type": "boolean", - "default": true - }, - "shipping-free-filter": { - "description": "Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.", - "type": "boolean", - "default": true - }, - "property-filter": { - "description": "Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.", - "type": "boolean", - "default": true - }, - "property-whitelist": { - "description": "A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.", - "type": "string" + "earliest": { + "type": "string", + "format": "date-time" }, - "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" - } - ] + "latest": { + "type": "string", + "format": "date-time" } } + }, + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" } - ] + } }, - "CartPriceQuantity": { - "type": "object", + "StateMachineState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "translated", + "technicalName", + "name" + ], "properties": { - "apiAlias": { + "id": { "type": "string", - "enum": [ - "cart_price_quantity" - ] - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" + "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number" + "technicalName": { + "description": "Technical name of StateMachineState.", + "type": "string" }, - "quantity": { - "type": "number" + "name": { + "type": "string" }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, + "customFields": { "type": "object" }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "type": { - "type": "string" + "translated": { + "type": "object" } }, - "required": [ - "apiAlias" - ] + "type": "object" }, - "ProductListingFlags": { + "ReferencePrice": { "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.", + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/ListPrice" }, { "type": "null" } ] }, - "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.", + "regulationPrice": { "oneOf": [ { - "type": "string" + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } + }, + { + "type": "null" + } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" }, { "type": "null" } ] } - } + }, + "required": [ + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] }, - "CartDelivery": { + "OrderRouteResponse": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { + "orders": { "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "allOf": [ + { + "type": "object", + "required": [ + "elements" + ], + "properties": { + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } }, - "latest": { - "type": "string", - "format": "date-time" + { + "$ref": "#/components/schemas/EntitySearchResult" } - } + ] }, - "location": { + "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": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" + "customerId": { + "type": "string" }, - "state": { - "$ref": "#/components/schemas/CountryState" + "salesChannelId": { + "type": "string" } } }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } + "products": { + "$ref": "#/components/schemas/ProductListingResult" + } + } + }, + "Sitemap": { + "type": "object", + "properties": { + "filename": { + "type": "string" }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "created": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "filename", + "created" + ] + }, + "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}$" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "foreignKey": { + "description": "The key that references to product or category entity ID.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", + "type": "string", + "enum": [ + "frontend.navigation.page", + "frontend.landing.page", + "frontend.detail.page" + ] + }, + "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", + "type": "string" + }, + "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", + "type": "string" + }, + "isCanonical": { + "description": "When set to true, search redirects to the main URL.", + "type": "boolean" + }, + "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", + "type": "boolean" + }, + "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", + "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", + "title": "SeoUrlEntity" }, - "Association": { - "additionalProperties": { - "$ref": "#/components/schemas/Association" - } + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" + ] }, - "ProductDetailResponse": { + "ListPrice": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", + "description": "", "properties": { - "product": { - "$ref": "#/components/schemas/Product" + "discount": { + "type": "number" }, - "configurator": { - "type": "array", - "description": "List of property groups with their corresponding options and information on how to display them.", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] } }, "required": [ - "product" + "apiAlias" ] }, - "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)", + "OrderLineItemDownload": { + "description": "Added since version: 6.4.19.0", + "required": [ + "media", + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted" + ], "properties": { - "page": { - "description": "Search result page", - "type": "integer" - }, - "term": { - "description": "Search term", - "type": "string" - }, - "limit": { - "description": "Number of items per result page", - "type": "integer" - }, - "filter": { - "type": "array", - "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "ids": { - "type": "array", - "description": "List of ids to search for", - "items": { - "type": "string" - } + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "query": { + "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", - "description": "The query string to search for" + "pattern": "^[0-9a-f]{32}$" }, - "associations": { - "$ref": "#/components/schemas/Associations" + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "post-filter": { - "type": "array", - "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" - } + "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" }, - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", + "type": "boolean" }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" - } + "customFields": { + "type": "object" }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "includes": { - "$ref": "#/components/schemas/Includes" + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" }, - "excludes": { - "$ref": "#/components/schemas/Excludes" + "media": { + "$ref": "#/components/schemas/Media" } - } + }, + "type": "object" }, - "NoneFieldsCriteria": { + "CalculatedPrice": { "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)", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "page": { - "description": "Search result page", - "type": "integer" - }, - "term": { - "description": "Search term", - "type": "string" + "unitPrice": { + "type": "number" }, - "limit": { - "description": "Number of items per result page", - "type": "integer" + "quantity": { + "type": "number" }, - "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" - } - ] - } + "rawTotal": { + "type": "number" }, - "ids": { - "type": "array", - "description": "List of ids to search for", - "items": { - "type": "string" - } + "totalPrice": { + "type": "number" }, - "query": { + "taxStatus": { "type": "string", - "description": "The query string to search for" - }, - "associations": { - "$ref": "#/components/schemas/Associations" + "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" - } - }, - "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" - }, - "excludes": { - "$ref": "#/components/schemas/Excludes" - } - } - }, - "Associations": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Criteria" - } - }, - "Includes": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "Excludes": { - "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": [ - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] + "positionPrice": { + "type": "number" }, - { - "title": "AggregationHistogram", - "allOf": [ + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "oneOf": [ { - "$ref": "#/components/schemas/AggregationHistogram" + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } }, { - "$ref": "#/components/schemas/SubAggregations" + "type": "null" } ] }, - { - "title": "AggregationRange", - "allOf": [ + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ { - "$ref": "#/components/schemas/AggregationRange" + "type": "string", + "format": "^[0-9a-f]{32}$" }, { - "$ref": "#/components/schemas/SubAggregations" + "type": "null" } ] - } - ] - }, - "SubAggregations": { - "type": "object", - "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/AggregationHistogram" - }, - { - "$ref": "#/components/schemas/AggregationRange" - } + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" ] - } - } - }, - "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" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } } - ] + } } }, - "additionalProperties": true + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules", + "rawTotal", + "taxStatus" + ] }, - "Sort": { - "type": "object", + "Category": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "breadcrumb", + "children", + "childCount", + "translated", + "type", + "id", + "name" + ], "properties": { - "field": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "order": { + "parentId": { "type": "string", - "enum": [ - "ASC", - "DESC" - ] + "pattern": "^[0-9a-f]{32}$" }, - "naturalSorting": { + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media added to identify category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "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" + "breadcrumb": { + "type": "array", + "items": { + "type": "string", + "additionalProperties": false }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - }, - "SimpleFilter": { - "type": "object", - "properties": { + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "number", + "format": "int64", + "readOnly": true + }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string", "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" + "page", + "link", + "folder" ] }, - "field": { + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, - "value": { + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" + }, + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { "type": "string" - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "EqualsFilter": { - "type": "object", - "properties": { - "type": { + }, + "customFields": { + "type": "object" + }, + "linkType": { "type": "string", "enum": [ - "equals" + "category", + "product", + "external", + "landing_page" ] }, - "field": { + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { "type": "string" }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, + "seoUrl": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "additionalProperties": true, + "properties": { + "breadcrumb": { + "type": "array", + "items": { + "type": "string" + } } + }, + "required": [ + "breadcrumb" ] - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "MultiNotFilter": { - "type": "object", - "properties": { - "type": { + }, + "parent": { + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." + }, + "children": { + "description": "Child categories within this category for hierarchical navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "media": { + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" + }, + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "apiAlias": { "type": "string", "enum": [ - "multi", - "not" + "category" ] + } + }, + "type": "object" + }, + "CookieEntry": { + "type": "object", + "properties": { + "cookie": { + "type": "string" }, - "operator": { + "value": { + "type": "string" + }, + "expiration": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "apiAlias": { "type": "string", "enum": [ - "and", - "or", - "nor", - "nand" + "cookie_entry" ] - }, - "queries": { - "$ref": "#/components/schemas/Filters" } }, "required": [ - "type", - "operator", - "queries" + "cookie", + "hidden", + "apiAlias" ] }, - "RangeFilter": { + "CartListPrice": { "type": "object", + "description": "", "properties": { - "type": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { "type": "string", "enum": [ - "range" + "cart_list_price" ] - }, - "field": { - "type": "string" - }, - "parameters": { - "type": "object", - "properties": { - "gte": { - "type": "number" - }, - "gt": { - "type": "number" - }, - "lte": { - "type": "number" - }, - "lt": { - "type": "number" - } - } } }, "required": [ - "type", - "field", - "parameters" + "apiAlias" ] }, - "CookieGroup": { - "type": "object", + "CustomerAddressBody": { + "description": "Added since version: 6.0.0.0", + "required": [ + "countryId", + "firstName", + "lastName", + "city", + "street" + ], "properties": { - "isRequired": { - "type": "boolean" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "description": { + "lastName": { "type": "string" }, - "cookie": { + "zipcode": { "type": "string" }, - "value": { + "city": { "type": "string" }, - "expiration": { - "type": "integer" + "company": { + "type": "string" }, - "entries": { - "$ref": "#/components/schemas/CookieEntryCollection" + "street": { + "type": "string" }, - "apiAlias": { - "type": "string", - "enum": [ - "cookie_group" - ] + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, - "not": { - "allOf": [ - { - "required": [ - "cookie" - ] - }, - { - "required": [ - "entries" - ] - } - ] - }, - "required": [ - "name", - "isRequired", - "apiAlias" - ] + "type": "object" }, - "CartDeliveryPosition": { + "MeasurementUnits": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "description": "Configuration of the measurement system", "properties": { - "deliveryDate": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { "type": "object", + "description": "Units used in the measurement system.", "properties": { - "earliest": { + "length": { "type": "string", - "format": "date-time" + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." }, - "latest": { + "weight": { "type": "string", - "format": "date-time" + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } } - }, - "identifier": { - "type": "string" - }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" } } }, - "ReferencePrice": { + "CustomerAddressRead": { "type": "object", "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "price": { - "type": "number" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "apiAlias": { + "createdAt": { "type": "string", - "enum": [ - "cart_price_reference" - ] + "format": "date-time" }, - "listPrice": { + "updatedAt": { "oneOf": [ { - "$ref": "#/components/schemas/ListPrice" + "type": "string", + "format": "date-time" }, { "type": "null" } ] }, - "regulationPrice": { + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { "oneOf": [ { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - } + "$ref": "#/components/schemas/CountryState" }, { "type": "null" } ] }, - "hasRange": { - "type": "boolean" + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "required": [ + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" + ] + }, + "ProductJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$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" + ] + } + } + } + } + } }, - "variantId": { - "oneOf": [ - { + { + "required": [ + "id", + "taxId", + "productNumber", + "stock", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "manufacturerId": { + "description": "Unique identity of the manufacturer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "description": "Unique identity of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", + "type": "string" + }, + "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", + "type": "boolean" + }, + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", + "readOnly": true + }, + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" + }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "description": "Indicates the number of products available.", + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", + "type": "string" + }, + "ean": { + "description": "Indicates EAN of the product.", + "type": "string" + }, + "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", + "type": "integer", + "format": "int64" + }, + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" + }, + "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", + "type": "number", + "format": "float" + }, + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" + }, + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" + }, + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" + }, + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" + }, + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" + }, + "length": { + "description": "The length of the product.", + "type": "number", + "format": "float" + }, + "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", - "format": "^[0-9a-f]{32}$" + "format": "date-time" }, - { - "type": "null" - } - ] - } - }, - "required": [ - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] - }, - "OrderRouteResponse": { - "type": "object", - "properties": { - "orders": { - "type": "object", - "allOf": [ - { - "type": "object", - "required": [ - "elements" - ], - "properties": { - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true }, - { - "$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" + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "salesChannelId": { - "type": "string" - } - } - }, - "products": { - "$ref": "#/components/schemas/ProductListingResult" - } - } - }, - "Sitemap": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "created": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "filename", - "created" - ] - }, - "NavigationType": { - "type": "string", - "enum": [ - "main-navigation", - "footer-navigation", - "service-navigation" - ] - }, - "ListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] - } - }, - "required": [ - "apiAlias" - ] - }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "rawTotal": { - "type": "number" - }, - "totalPrice": { - "type": "number" - }, - "taxStatus": { - "type": "string", - "enum": [ - "net", - "tax-free" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { + "propertyIds": { + "type": "array", + "items": { "type": "string", - "enum": [ - "cart_tax_calculated" - ] + "pattern": "^[0-9a-f]{32}$" }, - "tax": { - "type": "number" + "readOnly": true + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "taxRate": { - "type": "number" + "readOnly": true + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number" - } + "readOnly": true }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaDescription": { + "type": "string" + }, + "name": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "description": { + "type": "string" + }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, + "metaTitle": { + "type": "string" + }, + "packUnit": { + "type": "string" }, - { - "type": "null" - } - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" + "packUnitPlural": { + "type": "string" }, - { - "type": "null" - } - ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" - }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - } + "customFields": { + "type": "object" }, - { - "type": "null" - } - ] - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" + "ogTitle": { + "type": "string" }, - { - "type": "null" - } - ] - }, - "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" - ] - }, - "CookieEntry": { - "type": "object", - "properties": { - "cookie": { - "type": "string" - }, - "value": { - "type": "string" - }, - "expiration": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "hidden": { - "type": "boolean" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cookie_entry" - ] - } - }, - "required": [ - "cookie", - "hidden", - "apiAlias" - ] - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] - } - }, - "required": [ - "apiAlias" - ] - }, - "CustomerAddressBody": { - "description": "Added since version: 6.0.0.0", - "required": [ - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "properties": { - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "street": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "additionalAddressLine1": { - "type": "string" - }, - "additionalAddressLine2": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." + "ogDescription": { + "type": "string" }, - "weight": { + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "CustomerAddressRead": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "oneOf": [ - { + "physical", + "digital" + ] + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, + "calculatedPrice": { + "type": "object" + }, + "calculatedPrices": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "calculatedMaxPurchase": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "calculatedCheapestPrice": { + "type": "object" + }, + "isNew": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "sortedProperties": { + "type": "object" + }, + "measurements": { + "type": "object" + }, + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - { - "type": "null" - } - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "oneOf": [ - { - "$ref": "#/components/schemas/CountryState" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - { - "type": "null" + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/downloads" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_download" + }, + "id": { + "type": "string", + "example": "d07d50a751bc6ddf12bf3af0efee9b45" + } + } + } + } + }, + "type": "object" + }, + "parent": { + "description": "Unique identity of the product.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "description": "Product variants that inherit from this parent product", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "deliveryTime": { + "description": "Estimated delivery time for the product", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "delivery_time" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c888ae25a7bd42057370e31f7e01044" + } + } + } + }, + "type": "object" + }, + "tax": { + "description": "Tax configuration (rate and calculation rules)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/tax" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" + } + } + } + }, + "type": "object" + }, + "manufacturer": { + "description": "Product manufacturer or brand information", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/manufacturer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_manufacturer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c2904bca62b22443d6cf5e9d89cab204" + } + } + } + }, + "type": "object" + }, + "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/unit" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "unit" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3e34bdebd9bd5edda27e8728904a2552" + } + } + } + }, + "type": "object" + }, + "cover": { + "description": "Main product image displayed in listings and detail pages", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/cover" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "41d0e299ca1abeb2094852da042165c7" + } + } + } + }, + "type": "object" + }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "description": "Custom CMS page layout for the product detail page", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "023995a50b56c0de077323e958b2bbcd" + } + } + } + }, + "type": "object" + }, + "media": { + "description": "Product images and media gallery", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + }, + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/crossSellings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "example": "89936e14544d1b403cecef938101b6b0" + } + } + } + } + }, + "type": "object" + }, + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_configurator_setting" + }, + "id": { + "type": "string", + "example": "c0827fee13725d41f1fd7e292243f5aa" + } + } + } + } + }, + "type": "object" + }, + "productReviews": { + "description": "Customer reviews and ratings for the product", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/productReviews" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } + } + } + }, + "type": "object" + }, + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/mainCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "main_category" + }, + "id": { + "type": "string", + "example": "1fb731fc4139cbb575429e28846f0c39" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } + } + } + } + }, + "type": "object" + }, + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/options" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "93da65a9fd0004d9477aeac024e08e15" + } + } + } + } + }, + "type": "object" + }, + "properties": { + "description": "Product properties and characteristics for filtering", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/properties" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "74693d2fc58b46bd06410f278e39aa71" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "description": "Categories this product is assigned to", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + }, + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/streams" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "example": "2f6f4768f1c2d7c8f1f54823723f1a70" + } + } + } + } + }, + "type": "object" + }, + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "7f0702d3a90d965b8c9158c451f43fdb" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "description": "Tags for organizing and filtering products", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "seoCategory": { + "description": "Main category used for SEO URL generation in the current sales channel", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/seoCategory" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9354d004d12e03d35ad8292bf0bb234d" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } - ] - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + }, + "type": "object" } - }, - "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" ] }, "CrossSellingElement": { @@ -20843,6 +20426,74 @@ } } }, + "CustomerGroup": { + "description": "Added since version: 6.0.0.0", + "required": [ + "translated", + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationSeoMetaDescription": { + "type": "string" + }, + "registrationTitle": { + "type": "string" + } + } + } + }, + "type": "object" + }, "NavigationRouteResponse": { "type": "array", "items": { @@ -21457,6 +21108,97 @@ "example": "product" } } + }, + "BundleItem": { + "type": "object", + "required": [ + "productId", + "quantity", + "min", + "required" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantity": { + "type": "integer", + "minimum": 1 + }, + "min": { + "type": "integer", + "minimum": 1 + }, + "max": { + "type": "integer" + }, + "required": { + "type": "boolean" + }, + "position": { + "type": "integer" + }, + "showBundleOnItemPdp": { + "type": "boolean" + }, + "product": { + "type": "object" + }, + "apiAlias": { + "type": "string", + "example": "bundle_item" + } + } + }, + "BundleDiscount": { + "type": "object", + "required": [ + "id", + "type", + "value" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string", + "enum": [ + "absolute", + "percentage" + ] + }, + "value": { + "type": "number" + }, + "maxValue": { + "type": "number" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "preventCombination": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "apiAlias": { + "type": "string", + "example": "bundle_discount" + } + } } }, "responses": {