From e04226765708f06f09799c0cda7486e12914ef78 Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Fri, 10 Jul 2026 10:10:56 +0000 Subject: [PATCH] [create-pull-request] automated change --- storeapi.json | 21669 ++++++++++++++++++++++++------------------------ 1 file changed, 10842 insertions(+), 10827 deletions(-) diff --git a/storeapi.json b/storeapi.json index a9dd749..d512144 100644 --- a/storeapi.json +++ b/storeapi.json @@ -1092,179 +1092,326 @@ } ] }, - "Category": { + "CountryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "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": [ - "apiAlias", - "breadcrumb", - "children", - "childCount", - "translated", - "type", "id", - "name" + "name", + "addressFormat" ], "properties": { "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of category's version." + "description": "Unique identity of the country." }, - "parentId": { + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent category." + "description": "Name of the country." }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent category's version." + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "type": "string" }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the category's version under which the new category is to be created." + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", + "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" }, - "breadcrumb": { - "type": "array", - "items": { - "type": "string", - "additionalProperties": false - }, - "readOnly": true, - "description": "Breadcrumbs offer the users on the website the option to quickly find their way back to the homepage or another level of the website using internal links." + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" }, - "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, - "description": "Number of categories below the main category." - }, - "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.", + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string", - "description": "Name of the category." + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" ], - "description": "linkType : `external`, `category`, `product`, `landing_page`." - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "When a particular category is clicked, it gets redirected to internal link." - }, - "externalLink": { - "type": "string", - "description": "When a particular category is clicked, it gets redirected to external link." - }, - "linkNewTab": { - "type": "boolean", - "description": "Category opens in a new tab of the browser." - }, - "description": { - "type": "string", - "description": "Information about the category." - }, - "metaTitle": { - "type": "string", - "description": "A page title indexed by search engines and appears in search results listings." + "properties": { + "enabled": { + "type": "boolean", + "description": "The boolean value is `true` if the tax for the customer apply." + }, + "currencyId": { + "type": "string", + "description": "Unique identity of currency." + }, + "amount": { + "type": "number", + "format": "float", + "description": "Sum of money to be paid by the customer." + } + }, + "type": "object" }, - "metaDescription": { - "type": "string", - "description": "A short description of the page for search results listings." + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "The boolean value is `true`, if the tax for the company apply." + }, + "currencyId": { + "type": "string", + "description": "Unique identity of currency." + }, + "amount": { + "type": "number", + "format": "float", + "description": "Sum of money to be paid by the company." + } + }, + "type": "object" }, - "keywords": { - "type": "string", - "description": "Keywords that help to search the category." + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page's version." + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" }, - "customEntityTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true + "addressFormat": { + "type": "object", + "description": "The address format with recipient's name, building number, street name, city, state and ZIP code on different lines as required." }, - "seoUrl": { - "description": "Runtime field, cannot be used as part of the criteria.", + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -1277,236 +1424,119 @@ }, "translated": { "type": "object", - "additionalProperties": true, - "properties": { - "breadcrumb": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "breadcrumb" - ], "description": "Contains the translations of all translated fields." }, - "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", + "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/CountryState" } }, - "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" - } + "taxFree": { + "description": "When tax doesn't apply for a particular country, then the boolean value is `true`." }, - "apiAlias": { - "type": "string", - "enum": [ - "category" - ] + "companyTaxFree": { + "description": "When a registered company is free from paying taxes, then the boolean value is `true`." } }, "type": "object" }, - "CmsBlock": { + "CountryStateJsonApi": { "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}$", - "description": "Unique identity of CMS Block version." - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS Section version." - }, - "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" + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "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" - }, - "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": { + { + "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" - }, - "sectionId": { - "description": "Unique identity of section.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "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": { + "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", - "sections", "id", - "type" + "countryId", + "shortCode", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page version." + "description": "Unique identity of the country's state." }, - "name": { + "countryId": { + "description": "Unique identity of the country.", "type": "string", - "description": "Name of the CMS page." - }, - "type": { - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "description": "This field will be implemented in the future.", + "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" + "name": { + "type": "string", + "description": "Name of the country's state." }, - "config": { - "properties": { - "backgroundColor": { - "type": "string", - "description": "Background color of the CMS page." - } - }, - "type": "object" + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" }, - "previewMediaId": { - "description": "Unique identity of media to be previewed.", - "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" }, "customFields": { "type": "object", @@ -1525,371 +1555,110 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." - }, - "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" }, - "CmsSection": { + "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "blocks", - "id", - "position", - "type", - "pageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS section." - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page version." - }, - "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 `sidebar` or `fullwidth`.", - "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": { - "properties": { - "mobile": { - "type": "boolean", - "description": "When `true`, CMS layout can be viewed in mobile mode." - }, - "desktop": { - "type": "boolean", - "description": "When `true`, CMS layout can be viewed in desktop mode." - }, - "tablet": { - "type": "boolean", - "description": "When `true`, CMS layout can be viewed in tablet mode." - } - }, - "type": "object" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "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": { - "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "id", - "type", - "slot", - "blockId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS slot." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS block version." - }, - "fieldConfig": { - "type": "object", - "description": "Con info of cms slot" - }, - "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" - }, - "locked": { - "type": "boolean", - "description": "When locked, then CMS slot config element cannot be configured." - }, - "config": { - "type": "object", - "description": "Specifies detailed information about how the component is to be rendered." - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "data": { - "type": "object", - "readOnly": true, - "description": "Each cms slot (element) has a config that has values defined in the admin. When cms loads, each Resolver class adds the resolved config data to this value." - }, - "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", - "description": "Contains the translations of all translated fields." - }, - "block": { - "$ref": "#/components/schemas/CmsBlock" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cms_slot" - ] - }, - "VersionId": { - "description": "Unique identity of CMS slot's version." - } - }, - "type": "object" - }, - "CountryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, { "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" - }, - "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", @@ -1902,184 +1671,117 @@ }, "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}$", - "description": "Unique identity of the country." + "description": "Unique identity of currency." }, - "name": { - "type": "string", - "description": "Name of the country." + "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", + "description": "Acronym for international currencies. For example, USD." }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" + "name": { + "type": "string", + "description": "Full name of the currency. For example, US-Dollar." }, - "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "customerTax": { + "itemRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean", - "description": "The boolean value is `true` if the tax for the customer apply." - }, - "currencyId": { - "type": "string", - "description": "Unique identity of currency." + "decimals": { + "type": "integer", + "format": "int64", + "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." }, - "amount": { + "interval": { "type": "number", "format": "float", - "description": "Sum of money to be paid by the customer." + "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." + }, + "roundForNet": { + "type": "boolean", + "description": "The cash rounding applied on net prices. " } }, "type": "object" }, - "companyTax": { + "totalRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean", - "description": "The boolean value is `true`, if the tax for the company apply." - }, - "currencyId": { - "type": "string", - "description": "Unique identity of currency." + "decimals": { + "type": "integer", + "format": "int64", + "description": "It defines the round off amount to the nearest decimal points applied on the cart’s total amount. If set to 2, it rounds off to two significant decimal points." }, - "amount": { + "interval": { "type": "number", "format": "float", - "description": "Sum of money to be paid by the company." + "description": "The interval defines the cart’s total amount round off interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." + }, + "roundForNet": { + "type": "boolean", + "description": "The cash rounding applied on cart’s total net prices. " } }, "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", - "description": "The address format with recipient's name, building number, street name, city, state and ZIP code on different lines as required." - }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -2093,122 +1795,101 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the country's currency rounding." }, - "states": { - "description": "States/provinces/regions within the country", - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - }, - "taxFree": { - "description": "When tax doesn't apply for a particular country, then the boolean value is `true`." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "companyTaxFree": { - "description": "When a registered company is free from paying taxes, then the boolean value is `true`." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "CountryStateJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a custom entity." }, - { - "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": { + "CustomField": { "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "countryId", - "shortCode", - "name" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the country's state." + "description": "Unique identity of a custom field." }, - "countryId": { - "description": "Unique identity of the country.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" + "format": "date-time", + "readOnly": true }, - "name": { + "updatedAt": { "type": "string", - "description": "Name of the country's state." - }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomFieldSet": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a custom field set." }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomFieldSetRelation": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a custom field set relation." }, "createdAt": { "type": "string", @@ -2219,15 +1900,11 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "CurrencyJsonApi": { + "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -2236,96 +1913,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 - $", + "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.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "shortName": { + "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, - "name": { + "city": { + "description": "Name of customer's city.", "type": "string" }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" + "company": { + "description": "Name of customer's company.", + "type": "string" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "street": { + "description": "Name of customer's street.", + "type": "string" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" + "department": { + "description": "Name of customer's department.", + "type": "string" }, - "customFields": { - "type": "object" + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "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" }, - "totalRounding": { - "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" + }, + "isDefaultShippingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -2337,7 +2014,96 @@ "format": "date-time", "readOnly": true }, - "translated": { + "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" } }, @@ -2345,110 +2111,13 @@ } ] }, - "Currency": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" - ], + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of currency." - }, - "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", - "description": "Acronym for international currencies. For example, USD." - }, - "name": { - "type": "string", - "description": "Full name of the currency. For example, US-Dollar." - }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64", - "description": "It defines the cash round off applied on the cart line items to the nearest decimal points. If set to 2, it rounds off to two significant decimal points." - }, - "interval": { - "type": "number", - "format": "float", - "description": "The interval of item rounding defines the cash rounding interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." - }, - "roundForNet": { - "type": "boolean", - "description": "The cash rounding applied on net prices. " - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64", - "description": "It defines the round off amount to the nearest decimal points applied on the cart’s total amount. If set to 2, it rounds off to two significant decimal points." - }, - "interval": { - "type": "number", - "format": "float", - "description": "The interval defines the cart’s total amount round off interval in terms of how high or low should it be rounded. For example, 0.05 signifies the value gets rounded off to nearest 5 cents." - }, - "roundForNet": { - "type": "boolean", - "description": "The cash rounding applied on cart’s total net prices. " - } - }, - "type": "object" + "description": "Unique identity of the customer recovery account." }, "createdAt": { "type": "string", @@ -2459,42 +2128,58 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "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}$", - "description": "Unique identity of the country's currency rounding." + "description": "Unique identity of the customer tag." }, - "createdAt": { + "customerId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the customer." }, - "updatedAt": { + "tagId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the tag." + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "CustomEntity": { - "description": "Added since version: 6.4.9.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a custom entity." + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "customerId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the customer's wishlist." + }, + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -2505,17 +2190,37 @@ "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}$", - "description": "Unique identity of a custom field." + "description": "Unique identity of the product in customer wishlist." + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." }, "createdAt": { "type": "string", @@ -2530,13 +2235,42 @@ }, "type": "object" }, - "CustomFieldSet": { + "DeliveryTime": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "min", + "max", + "unit" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a custom field set." + "description": "Unique identity of delivery time." + }, + "name": { + "type": "string", + "description": "Name given to delivery time." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -2547,56 +2281,97 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "CustomFieldSetRelation": { + "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentTypeId", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a custom field set relation." + "description": "Unique identity of the document base config." + }, + "documentTypeId": { + "description": "Unique identity of the document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "logoId": { + "description": "Unique identity of the company logo.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the document.", + "type": "string" + }, + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, + "config": { + "type": "object", + "deprecated": true, + "description": "Specifies detailed information about the component." + }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true + }, + "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}$", - "description": "Unique identity of the customer." + "description": "Unique identity of document's base config sales channel." }, - "groupId": { - "description": "Unique identity of customer group.", + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -2605,148 +2380,157 @@ "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.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", + "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}$" - }, - "customerNumber": { - "description": "Unique number assigned to identity a customer.", - "type": "string" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the document type." }, - "salutationId": { - "description": "Unique identity of salutation.", + "name": { "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.", - "type": "string" + "description": "Name of the document type." }, - "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "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": "Password hash for account recovery.", - "type": "string" - }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", - "type": "boolean" + "format": "date-time", + "readOnly": true }, - "firstLogin": { - "description": "To capture date and time of customer's first login.", + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "Flow": { + "description": "Added since version: 6.4.6.0", + "properties": { + "id": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of flow." }, - "lastLogin": { - "description": "To capture date and time of customer's last login.", + "createdAt": { "type": "string", - "format": "date-time" - }, - "birthday": { - "description": "To capture customer's birthday details.", - "type": "string" + "format": "date-time", + "readOnly": true }, - "lastOrderDate": { - "description": "Captures last order date.", + "updatedAt": { "type": "string", "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}$", + "description": "Unique identity of flow." }, - "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" + }, + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of flow template." }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", + "createdAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Unique identity tag names given to the line item." - }, - "requestedGroupId": { - "description": "Unique identity of requested group.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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}$", + "description": "Unique identity of import-export file." }, - "createdById": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "updatedById": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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}$", + "description": "Unique identity of import-export log." }, "createdAt": { "type": "string", @@ -2757,122 +2541,196 @@ "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}$", + "description": "Unique identity of import-export profile." }, - "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": { + "createdAt": { "type": "string", - "enum": [ - "customer" - ] + "format": "date-time", + "readOnly": true }, - "defaultPaymentMethodId": { - "description": "Unique identity of default payment method." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "company": { - "description": "Company name of the customer." + "translated": { + "type": "object" }, - "vatIds": { - "description": "Unique identity of VAT." + "Integration": { + "description": "Unique identity of integration." + } + }, + "type": "object" + }, + "Integration": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "description": "Account type can be personal or business." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "extensions": { - "properties": { - "specificFeatures": { - "description": "To store additional data to a customer from extensions." - } - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "type": "object", - "oneOf": [ + "type": "object" + }, + "LandingPageJsonApi": { + "description": "Added since version: 6.4.0.0", + "allOf": [ { - "required": [ - "accountType" - ], - "properties": { - "accountType": { - "type": "string", - "enum": [ - "private" - ] - } - } + "$ref": "#/components/schemas/resource" }, { "required": [ - "accountType", - "vatIds", - "company" + "id", + "name", + "url" ], "properties": { - "accountType": { + "id": { "type": "string", - "enum": [ - "business" - ] + "pattern": "^[0-9a-f]{32}$" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "company": { + "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" } - } + }, + "type": "object" } ] }, - "CustomerAddressJsonApi": { + "LanguageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -2881,97 +2739,38 @@ { "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.", - "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.", + "name": { + "description": "Name of the language.", "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "active": { + "type": "boolean" }, "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", @@ -2984,7 +2783,8 @@ }, "relationships": { "properties": { - "country": { + "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -2992,7 +2792,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, @@ -3001,19 +2801,20 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "countryState": { + "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -3021,7 +2822,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, @@ -3030,19 +2831,20 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, - "salutation": { + "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -3050,7 +2852,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" } } }, @@ -3059,123 +2861,97 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "6ef2035242b8fcb7b61c3a41850e60b3" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerAddress": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "properties": { - "id": { + }, + "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": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of customer's address." - }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of language." }, - "countryId": { - "description": "Unique identity of country.", + "parentId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent language." }, - "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.", - "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.", + "name": { + "description": "Name of the language.", "type": "string" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "active": { + "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "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", @@ -3186,63 +2962,58 @@ "format": "date-time", "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" + "parent": { + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, - "countryState": { - "$ref": "#/components/schemas/CountryState" + "locale": { + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "translationCode": { + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" + }, + "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}$", - "description": "Unique identity of the customer's group." + "description": "Unique identity of locale." + }, + "code": { + "description": "Code given to the locale. For example: en-CA.", + "type": "string" }, "name": { "type": "string", - "description": "Name of the customer group." + "description": "Name of the locale. For example: English." }, - "displayGross": { - "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", - "type": "boolean" + "territory": { + "type": "string", + "description": "Name of the location. For example: Canada." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "registrationActive": { - "description": "To enable the registration of partner customer group.", - "type": "boolean" - }, - "registrationTitle": { - "type": "string", - "description": "Title defined for the customer group during registration." - }, - "registrationIntroduction": { - "type": "string", - "description": "A brief description about the registration." - }, - "registrationOnlyCompanyRegistration": { - "type": "boolean", - "description": "Register as a company rather than as a private customer group." - }, - "registrationSeoMetaDescription": { - "type": "string", - "description": "A short description of the registration page for search results listings." - }, "createdAt": { "type": "string", "format": "date-time", @@ -3255,32 +3026,18 @@ }, "translated": { "type": "object", - "properties": { - "name": { - "type": "string" - }, - "registrationIntroduction": { - "type": "string" - }, - "registrationSeoMetaDescription": { - "type": "string" - }, - "registrationTitle": { - "type": "string" - } - }, "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "CustomerRecovery": { - "description": "Added since version: 6.1.0.0", + "LogEntry": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer recovery account." + "description": "Unique identity of log entry." }, "createdAt": { "type": "string", @@ -3295,95 +3052,44 @@ }, "type": "object" }, - "CustomerTag": { + "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ - "customerId", - "tagId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer tag." + "description": "Unique identity of mail's header and footer component." }, - "customerId": { + "systemDefault": { + "type": "boolean", + "description": "Unused field. To be removed in future." + }, + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer." + "description": "Name of the MailHeaderFooter." }, - "tagId": { + "description": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the tag." + "description": "Description of the MailHeaderFooter." }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "CustomerWishlist": { - "description": "Added since version: 6.3.4.0", - "required": [ - "id", - "customerId" - ], - "properties": { - "id": { + "headerHtml": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer's wishlist." + "description": "HTML header content." }, - "customerId": { - "description": "Unique identity of the customer.", + "headerPlain": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Textual header content." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - }, - "type": "object" - }, - "CustomerWishlistProduct": { - "description": "Added since version: 6.3.4.0", - "required": [ - "id", - "productId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product in customer wishlist." - }, - "productId": { - "description": "Unique identity of the product.", + "footerHtml": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "HTML footer content." }, - "productVersionId": { + "footerPlain": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's version." + "description": "Textual footer content." }, "createdAt": { "type": "string", @@ -3394,42 +3100,42 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "DeliveryTime": { + "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "name", - "min", - "max", - "unit" + "subject", + "contentHtml", + "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of delivery time." + "description": "Unique identity of mail template." }, - "name": { - "type": "string", - "description": "Name given to delivery time." + "systemDefault": { + "type": "boolean", + "description": "Unused field. To be removed in future." }, - "min": { - "description": "Minimum delivery time taken.", - "type": "integer", - "format": "int64" + "senderName": { + "type": "string", + "description": "Name of the sender in the mail." }, - "max": { - "description": "Maximum delivery time taken.", - "type": "integer", - "format": "int64" + "contentHtml": { + "type": "string", + "description": "HTML content in the mail." }, - "unit": { - "description": "Unit in which the delivery time is defined. For example, days or hours.", - "type": "string" + "contentPlain": { + "type": "string", + "description": "Textual content in the mail." }, "customFields": { "type": "object", @@ -3448,168 +3154,78 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." + }, + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } } }, "type": "object" }, - "Document": { + "MailTemplateMedia": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode" + "mailTemplateId", + "languageId", + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document." - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document type." - }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of reference document." + "description": "Unique identity of mail template's media." }, - "orderId": { + "mailTemplateId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the order." + "description": "Unique identity of the mail template." }, - "documentMediaFileId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document media file." - }, - "documentA11yMediaFileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of the language." }, - "orderVersionId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the order's version." - }, - "config": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "required": [ - "name", - "title" - ], - "description": "Specifies detailed information about how the component is to be rendered." - }, - "sent": { - "type": "boolean", - "description": "When `true`, the document is already sent to the customer." - }, - "static": { - "type": "boolean", - "description": "When `true`, the document is uploaded else it is generated by the system." - }, - "deepLinkCode": { - "type": "string", - "description": "It is a generated special code linked to email. It is used to access details of guest customer actions." - }, - "documentNumber": { - "type": "string" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "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" - } + "description": "Unique identity of the media." }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" + "position": { + "type": "integer", + "format": "int64", + "description": "The order of multiple media templates defined is specified using numerical values like 1,2,3, etc." }, - "documentA11yMediaFile": { + "media": { "$ref": "#/components/schemas/Media" - }, - "fileType": { - "type": "string", - "description": "Type of file like PDF." } }, "type": "object" }, - "DocumentBaseConfig": { + "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentTypeId", + "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the document base config." - }, - "documentTypeId": { - "description": "Unique identity of the document type.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "logoId": { - "description": "Unique identity of the company logo.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of mail template type." }, "name": { - "description": "Name of the document.", - "type": "string" - }, - "filenamePrefix": { - "description": "A prefix name added to the file name separated by an underscore.", - "type": "string" - }, - "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" + "type": "string", + "description": "Name of the mail template." }, - "documentNumber": { - "description": "Unique number associated with every document.", + "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "customFields": { @@ -3621,47 +3237,110 @@ "format": "date-time", "readOnly": true }, - "config": { - "type": "object", - "deprecated": true, - "description": "Specifies detailed information about the component." - }, "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", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "DocumentBaseConfigSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentBaseConfigId" + "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", + "productId", + "categoryId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document's base config sales channel." + "description": "Unique identity of main category." }, - "documentBaseConfigId": { - "description": "Unique identity of document's base config.", + "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." + }, + "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "description": "Unique identity of document type.", + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the category's version." + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -3678,30 +3357,42 @@ }, "type": "object" }, - "DocumentType": { - "description": "Added since version: 6.0.0.0", + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "technicalName", - "name" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the document type." + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "measurementSystemId": { "type": "string", - "description": "Name of the document type." + "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Technical name of document type.", + "default": { + "type": "boolean" + }, + "type": { "type": "string" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -3714,19 +3405,27 @@ "readOnly": true }, "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "type": "object" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, - "Flow": { - "description": "Added since version: 6.4.6.0", + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "technicalName" + ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of flow." + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" }, "createdAt": { "type": "string", @@ -3737,38 +3436,26 @@ "type": "string", "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}$", - "description": "Unique identity of flow." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "translated": { + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } } }, "type": "object" }, - "FlowTemplate": { - "description": "Added since version: 6.4.18.0", + "MediaDefaultFolder": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of flow template." + "description": "Unique identity of media default folder." }, "createdAt": { "type": "string", @@ -3783,13 +3470,13 @@ }, "type": "object" }, - "ImportExportFile": { + "MediaFolder": { "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of import-export file." + "description": "Unique identity of media folder." }, "createdAt": { "type": "string", @@ -3804,13 +3491,13 @@ }, "type": "object" }, - "ImportExportLog": { + "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of import-export log." + "description": "Unique identity of media folder configuration." }, "createdAt": { "type": "string", @@ -3825,39 +3512,63 @@ }, "type": "object" }, - "ImportExportProfile": { + "MediaTag": { "description": "Added since version: 6.0.0.0", + "required": [ + "mediaId", + "tagId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of import-export profile." + "description": "Unique identity of the media tag." }, - "createdAt": { + "mediaId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the media." }, - "updatedAt": { + "tagId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the tag." }, - "translated": { - "type": "object" + "media": { + "$ref": "#/components/schemas/Media" }, - "Integration": { - "description": "Unique identity of integration." + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "Integration": { + "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "width", + "height" + ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of media thumbnail size defined." + }, + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -3872,203 +3583,155 @@ }, "type": "object" }, - "LandingPageJsonApi": { - "description": "Added since version: 6.4.0.0", + "NewsletterRecipientJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { - "required": [ - "id", - "name", - "url" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "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 + "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" } }, "type": "object" } ] }, - "LandingPage": { - "description": "Added since version: 6.4.0.0", - "required": [ - "apiAlias", - "id", - "name", - "url" - ], + "NewsletterRecipient": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of landing page." + "description": "Unique identity of newsletter recipient." }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of landing page version." - }, - "active": { - "type": "boolean", - "description": "When boolean value is `true`, respective landing pages are enlisted for use." + "format": "date-time", + "readOnly": true }, - "name": { + "updatedAt": { "type": "string", - "description": "Name of landing page." + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Notification": { + "description": "Added since version: 6.4.7.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of notification." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "slotConfig": { - "type": "object" + "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", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of number range." }, - "metaTitle": { + "createdAt": { "type": "string", - "description": "A page title indexed by search engines and appears in search results listings." + "format": "date-time", + "readOnly": true }, - "metaDescription": { + "updatedAt": { "type": "string", - "description": "A short description of the page for search results listings." + "format": "date-time", + "readOnly": true }, - "keywords": { + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "NumberRangeSalesChannel": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", - "description": "The keywords that help to search the landing page." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Sales channels's number rage." }, - "url": { + "createdAt": { "type": "string", - "description": "URL of the landing page." + "format": "date-time", + "readOnly": true }, - "cmsPageId": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "NumberRangeState": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the CMS Page." + "description": "Unique identity of number range's state." }, - "cmsPageVersionId": { + "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}$", - "description": "Unique identity of the CMS Page's version." + "description": "Unique identity of number range's type." }, "createdAt": { "type": "string", @@ -4083,249 +3746,98 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." - }, - "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" }, - "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" - } - } - }, - "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": { + "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "localeId", - "name" + "countryId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language." + "description": "Unique identity of order's address." }, - "parentId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent language." + "description": "Unique identity of OrderAddresses version." }, - "localeId": { - "description": "Unique identity of locale.", + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { - "description": "Unique identity of translation code.", + "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the language.", + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "active": { - "type": "boolean" + "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.", + "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -4336,53 +3848,72 @@ "format": "date-time", "readOnly": true }, - "parent": { - "$ref": "#/components/schemas/Language", - "description": "Unique identity of language." - }, - "locale": { - "$ref": "#/components/schemas/Locale", - "description": "Locale defining regional settings (date, time, number formats)" + "country": { + "$ref": "#/components/schemas/Country" }, - "translationCode": { - "$ref": "#/components/schemas/Locale", - "description": "Locale used for translating content" + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "children": { - "description": "Child languages inheriting from this parent language", - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "Locale": { + "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "code", - "name", - "territory" + "email", + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of locale." + "description": "Unique identity of order customer." }, - "code": { - "description": "Code given to the locale. For example: en-CA.", + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderCustomer's version." + }, + "email": { + "description": "Email address of the customer.", "type": "string" }, - "name": { + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "description": "Name of the locale. For example: English." + "pattern": "^[0-9a-f]{32}$" }, - "territory": { - "type": "string", - "description": "Name of the location. For example: Canada." + "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": { + "type": "string" + }, + "description": "Unique identity of VAT." + }, + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" }, "customFields": { "type": "object", @@ -4398,72 +3929,151 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "LogEntry": { + "OrderDelivery": { "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}$", - "description": "Unique identity of log entry." + "description": "Unique identity of Order's delivery." }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderDelivery's version." }, - "updatedAt": { + "orderId": { + "description": "Unique identity of order.", "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MailHeaderFooter": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail's header and footer component." - }, - "systemDefault": { - "type": "boolean", - "description": "Unused field. To be removed in future." + "description": "Unique identity of order's version." }, - "name": { + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", - "description": "Name of the MailHeaderFooter." + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "shippingOrderAddressVersionId": { "type": "string", - "description": "Description of the MailHeaderFooter." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order's shipping address version." }, - "headerHtml": { + "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", - "description": "HTML header content." + "pattern": "^[0-9a-f]{32}$" }, - "headerPlain": { + "stateId": { + "description": "Unique identity of state.", "type": "string", - "description": "Textual header content." + "pattern": "^[0-9a-f]{32}$" }, - "footerHtml": { + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tracking code is a unique URL code assigned to each package, which allows you to monitor the movement of the parcel." + }, + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", - "description": "HTML footer content." + "format": "date-time" }, - "footerPlain": { + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", - "description": "Textual footer content." + "format": "date-time" + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float", + "description": "Shipping cost of product per item (where, quantity=1)." + }, + "totalPrice": { + "type": "number", + "format": "float", + "description": "Shipping cost of product based on quantity." + }, + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." + }, + "calculatedTaxes": { + "type": "object", + "description": "Contains calculated taxes based on shipping costs/methods." + }, + "taxRules": { + "type": "object", + "description": "Pricing based on multiple taxes." + }, + "referencePrice": { + "type": "object", + "description": "Original cost price of the product." + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float", + "description": "Price of each line item." + }, + "discount": { + "type": "number", + "format": "float", + "description": "Absolute discount on each line item." + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Discount in percentage." + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float", + "description": "Contains cheapest price from last 30 days as per EU law." + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -4475,41 +4085,147 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "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" + } } }, "type": "object" }, - "MailTemplate": { + "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": [ - "subject", - "contentHtml", - "contentPlain" + "id", + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail template." + "description": "Unique identity of order delivery position." }, - "systemDefault": { - "type": "boolean", - "description": "Unused field. To be removed in future." + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderDeliveryPosition's version." }, - "senderName": { + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", - "description": "Name of the sender in the mail." + "pattern": "^[0-9a-f]{32}$" }, - "contentHtml": { + "orderDeliveryVersionId": { "type": "string", - "description": "HTML content in the mail." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order delivery's version." }, - "contentPlain": { + "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", - "description": "Textual content in the mail." + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of line item's version in an order." + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." + }, + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." + }, + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." + }, + "calculatedTaxes": { + "type": "object", + "description": "Contains calculated taxes based on order delivery price." + }, + "taxRules": { + "type": "object", + "description": "Pricing based on multiple taxes." + }, + "referencePrice": { + "type": "object", + "description": "Original cost price of the product." + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float", + "description": "Price of each line item." + }, + "discount": { + "type": "number", + "format": "float", + "description": "Absolute discount on each line item." + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Discount in percentage." + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float", + "description": "Contains cheapest price from last 30 days as per EU law." + } + }, + "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", @@ -4524,199 +4240,152 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - }, - "mailTemplateType": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateMedia" - } } }, "type": "object" }, - "MailTemplateMedia": { + "OrderTag": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "mailTemplateId", - "languageId", - "mediaId" + "orderId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail template's media." + "description": "Unique identity of order tag." }, - "mailTemplateId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the mail template." + "description": "Unique identity of order." }, - "languageId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the language." + "description": "Unique identity of order's version." }, - "mediaId": { + "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media." + "description": "Unique identity of tag given for an order." }, - "position": { - "type": "integer", - "format": "int64", - "description": "The order of multiple media templates defined is specified using numerical values like 1,2,3, etc." + "order": { + "$ref": "#/components/schemas/Order" }, - "media": { - "$ref": "#/components/schemas/Media" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "MailTemplateType": { + "OrderTransaction": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "technicalName", - "name" + "orderId", + "paymentMethodId", + "amount", + "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail template type." + "description": "Unique identity of order transaction." }, - "name": { + "versionId": { "type": "string", - "description": "Name of the mail template." - }, - "technicalName": { - "description": "Technical name of mail template.", - "type": "string" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderTransaction's version." }, - "createdAt": { + "orderId": { + "description": "Unique identity of an order.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "orderVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of an order's version." }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "MainCategoryJsonApi": { - "description": "Added since version: 6.1.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { + "amount": { "required": [ - "id", - "productId", - "categoryId", - "salesChannelId" + "unitPrice", + "totalPrice", + "quantity" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." }, - "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}$", - "description": "Unique identity of main category." - }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's version." + "validationData": { + "type": "object" }, - "categoryId": { - "description": "Unique identity of the category.", + "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the category's version." - }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -4727,46 +4396,159 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" + }, + "captures": { + "description": "Payment captures for this transaction", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + }, + "shippingCosts": { + "properties": { + "calculatedTaxes": { + "description": "Contains calculated taxes based on shipping costs/methods." + }, + "taxRules": { + "description": "Pricing based on multiple taxes." + }, + "referencePrice": { + "description": "Original cost price of the product." + }, + "listPrice": { + "properties": { + "price": { + "description": "Price of each line item." + }, + "discount": { + "description": "Absolute discount on each line item." + }, + "percentage": { + "description": "Discount in percentage." + } + } + }, + "regulationPrice": { + "properties": { + "price": { + "description": "Contains cheapest price from last 30 days as per EU law." + } + } + } + } } }, "type": "object" }, - "MeasurementDisplayUnit": { - "description": "Added since version: 6.7.1.0", + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", "required": [ "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" + "orderTransactionId", + "stateId", + "amount" ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture." }, - "measurementSystemId": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture's version." + }, + "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "default": { - "type": "boolean" + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction version." }, - "type": { - "type": "string" + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { + "externalReference": { + "description": "External payment provider token.", "type": "string" }, - "factor": { - "type": "number", - "format": "float" + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." + }, + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." + }, + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." + }, + "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" }, - "precision": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -4778,134 +4560,156 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "measurementSystem": { - "$ref": "#/components/schemas/MeasurementSystem" - } - }, - "type": "object" - }, - "MeasurementSystem": { - "description": "Added since version: 6.7.1.0", - "required": [ - "id", - "technicalName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "transaction": { + "$ref": "#/components/schemas/OrderTransaction" }, - "technicalName": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "units": { + "refunds": { "type": "array", "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + }, + "shippingCosts": { + "properties": { + "calculatedTaxes": { + "description": "Contains calculated taxes based on shipping costs/methods." + }, + "taxRules": { + "description": "Pricing based on multiple taxes." + }, + "referencePrice": { + "description": "Original cost price of the product." + }, + "listPrice": { + "properties": { + "price": { + "description": "Price of each line item." + }, + "discount": { + "description": "Absolute discount on each line item." + }, + "percentage": { + "description": "Discount in percentage." + } + } + }, + "regulationPrice": { + "properties": { + "price": { + "description": "Contains cheapest price from last 30 days as per EU law." + } + } + } } } }, "type": "object" }, - "Media": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefund": { + "description": "Added since version: 6.4.12.0", "required": [ - "apiAlias", - "fileExtension", - "fileName", - "hasFile", - "path", - "private", - "url", - "id" + "id", + "captureId", + "stateId", + "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "description": "Unique identity of order transaction capture refund." }, - "mimeType": { - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture refund's version." }, - "fileExtension": { - "description": "Type of file indication. For example: jpeg, png.", - "type": "string" + "captureId": { + "description": "Unique identity of order transaction capture.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "uploadedAt": { - "description": "Date and time at which media was added.", + "captureVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture's version." }, - "fileName": { - "description": "Name of the media file uploaded.", + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token. ", "type": "string" }, - "fileSize": { - "description": "Size of the file media file uploaded.", - "type": "integer", - "format": "int64", - "readOnly": true + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" }, - "metaData": { - "type": "object", - "readOnly": true, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "height": { - "type": "integer", - "format": "int64" + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." }, - "width": { + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." + }, + "quantity": { "type": "integer", - "format": "int64" + "format": "int64", + "description": "Number of items of each product." + }, + "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" } }, - "description": "Details of the media file uploaded." - }, - "config": { "type": "object" }, - "alt": { - "type": "string", - "description": "Alternate text for media." - }, - "title": { - "type": "string", - "description": "Title name give to the media." - }, - "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" - }, - "private": { - "description": "When `true`, the media display is kept private.", - "type": "boolean" - }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -4920,205 +4724,165 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "thumbnails": { - "description": "Generated thumbnail images in various sizes", + "transactionCapture": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "positions": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } }, - "apiAlias": { - "type": "string", - "enum": [ - "media" - ] - }, - "extensions": { - "description": "To store additional data to a media from extensions." + "shippingCosts": { + "properties": { + "calculatedTaxes": { + "description": "Contains calculated taxes based on shipping costs/methods." + }, + "taxRules": { + "description": "Pricing based on multiple taxes." + }, + "referencePrice": { + "description": "Original cost price of the product." + }, + "listPrice": { + "properties": { + "price": { + "description": "Price of each line item." + }, + "discount": { + "description": "Absolute discount on each line item." + }, + "percentage": { + "description": "Discount in percentage." + } + } + }, + "regulationPrice": { + "properties": { + "price": { + "description": "Contains cheapest price from last 30 days as per EU law." + } + } + } + } } }, "type": "object" }, - "MediaDefaultFolder": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media default folder." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MediaFolder": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media folder." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MediaFolderConfiguration": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media folder configuration." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "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}$", - "description": "Unique identity of the media tag." + "description": "Unique identity of order transaction capture refund position." }, - "mediaId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media." + "description": "Unique identity of order transaction capture refund position's version." }, - "tagId": { + "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the tag." - }, - "media": { - "$ref": "#/components/schemas/Media" + "pattern": "^[0-9a-f]{32}$" }, - "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}$", - "description": "Unique identity of media thumbnail." + "description": "Unique identity of order transaction capture refund's version." }, - "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 - }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order line item version." }, - "url": { - "description": "Public url of media thumbnail.", + "externalReference": { + "description": "External payment provider token.", "type": "string" }, - "path": { + "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MediaThumbnailSize": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "width", - "height" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media thumbnail size defined." - }, - "width": { - "description": "Width of the thumbnail.", + "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, - "height": { - "description": "Height of the thumbnail.", - "type": "integer", - "format": "int64" + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." + }, + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." + }, + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." + }, + "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", @@ -5133,65 +4897,211 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "NewsletterRecipientJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "orderTransactionCaptureRefund": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + }, + "shippingCosts": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedTaxes": { + "description": "Contains calculated taxes based on shipping costs/methods." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "taxRules": { + "description": "Pricing based on multiple taxes." }, - "updatedAt": { - "type": "string", + "referencePrice": { + "description": "Original cost price of the product." + }, + "listPrice": { + "properties": { + "price": { + "description": "Price of each line item." + }, + "discount": { + "description": "Absolute discount on each line item." + }, + "percentage": { + "description": "Discount in percentage." + } + } + }, + "regulationPrice": { + "properties": { + "price": { + "description": "Contains cheapest price from last 30 days as per EU law." + } + } + } + } + } + }, + "type": "object" + }, + "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", + "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" } ] }, - "NewsletterRecipient": { + "PaymentMethod": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of newsletter recipient." + "description": "Unique identity of payment method." }, - "createdAt": { + "name": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Name of the payment method." }, - "updatedAt": { + "distinguishableName": { "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Notification": { - "description": "Added since version: 6.4.7.0", - "properties": { - "id": { + "readOnly": true, + "description": "System identifier name for payment method." + }, + "description": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of notification." + "description": "A short description about the payment method." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "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", @@ -5202,20 +5112,28 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + }, + "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": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number range." + "description": "Unique identity of a plugin." }, "createdAt": { "type": "string", @@ -5234,34 +5152,52 @@ }, "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}$", - "description": "Unique identity of Sales channels's number rage." + "description": "Unique identity of Product configurator setting." }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product configurator setting version." }, - "updatedAt": { + "productId": { + "description": "Unique identity of product.", "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "NumberRangeState": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number range's state." + "description": "Unique identity of product version." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -5272,20 +5208,57 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "NumberRangeType": { - "description": "Added since version: 6.0.0.0", + "ProductCrossSelling": { + "description": "Added since version: 6.1.0.0", "required": [ - "typeName" + "id", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number range's type." + "description": "Unique identity of product cross selling." + }, + "name": { + "type": "string", + "description": "Name defined for Product cross selling." + }, + "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", @@ -5304,268 +5277,199 @@ }, "type": "object" }, - "Order": { - "description": "Added since version: 6.0.0.0", + "ProductCrossSellingAssignedProducts": { + "description": "Added since version: 6.2.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product CrossSelling Assigned Products." + }, + "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": [ - "documents", - "orderDate", - "stateMachineState", - "price", "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor" + "productId", + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "description": "Unique identity downloaded product." }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order version." - }, - "orderNumber": { - "description": "Unique number associated with every order.", - "type": "string" + "description": "Unique identity of downloaded product's version." }, - "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}$", - "description": "Unique identity of the billing address version." + "description": "Unique identity of Product version." }, - "primaryOrderDeliveryId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "primaryOrderDeliveryVersionId": { - "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" }, - "primaryOrderTransactionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "primaryOrderTransactionVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "currencyId": { - "description": "Unique identity of the currency.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "languageId": { - "description": "Unique identity of the language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "product": { + "$ref": "#/components/schemas/Product" }, - "salesChannelId": { - "description": "Unique identity of the sales channel.", + "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}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Exported Product." }, - "orderDateTime": { - "description": "Timestamp when the order was placed.", + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - "orderDate": { - "description": "Date when the order was placed.", + "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}$", + "description": "Unique identity of product feature set." }, - "price": { - "required": [ - "netPrice", - "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" - ], - "properties": { - "netPrice": { - "type": "number", - "format": "float", - "description": "Net price of the product." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Gross price of the product." - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "positionPrice": { - "type": "number", - "format": "float", - "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc." - }, - "rawTotal": { - "type": "number", - "format": "float", - "description": "The total value before rounding off." - }, - "taxStatus": { - "type": "string", - "description": "TaxStatus takes `Free`, `Net` or `Gross` as values." - } - }, - "type": "object", - "$ref": "#/components/schemas/CalculatedPrice" - }, - "amountTotal": { - "description": "Gross price of the order.", - "type": "number", - "format": "float", + "createdAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "amountNet": { - "description": "Net price of the order.", - "type": "number", - "format": "float", + "updatedAt": { + "type": "string", + "format": "date-time", "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 + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "ProductKeywordDictionary": { + "description": "Added since version: 6.0.0.0", + "required": [ + "languageId", + "keyword" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of product keyword." }, - "taxStatus": { - "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "languageId": { + "description": "Unique identity of the language.", "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Shipping cost of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Shipping cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "calculatedTaxes": { - "type": "object", - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "type": "object", - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "type": "object", - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Price of each line item." - }, - "discount": { - "type": "number", - "format": "float", - "description": "Absolute discount on each line item." - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Discount in percentage." - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Contains cheapest price from last 30 days as per EU law." - } - }, - "type": "object" - } - }, - "type": "object" - }, - "shippingTotal": { - "description": "Total shipping cost of the ordered product.", - "type": "number", - "format": "float", - "readOnly": true - }, - "currencyFactor": { - "description": "Rate at which currency is exchanged.", - "type": "number", - "format": "float" - }, - "deepLinkCode": { - "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", + "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}$", + "description": "Unique identity of the Product Manufacturer." }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the ProductManufacturer's version." }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "type": "string" + "mediaId": { + "description": "Unique identity of the media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customerComment": { - "description": "Comments given by comments.", - "type": "string" + "link": { + "type": "string", + "description": "URL of the manufacturer's portal." }, - "source": { - "description": "Source of orders either via normal order placement or subscriptions.", - "type": "string" + "name": { + "type": "string", + "description": "Name of the product manufacturer." }, - "taxCalculationType": { - "type": "string" + "description": { + "type": "string", + "description": "A detailed description of product manufacturer." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "createdById": { - "description": "Unique identity of createdBy.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "description": "Unique identity of updatedBy.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -5576,169 +5480,122 @@ "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" - } + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "documents": { - "description": "Generated documents (invoices, delivery notes, credit notes)", - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "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}$", + "description": "Unique identity of the product's price." }, - "tags": { - "description": "Tags assigned to the order for organization and filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "extensions": { - "description": "To store additional data to an order from extensions." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "OrderAddress": { + "ProductReview": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "countryId", - "firstName", - "lastName", - "street", - "city" + "productId", + "salesChannelId", + "languageId", + "title", + "content" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's address." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderAddresses version." + "description": "Unique identity of the product's review." }, - "countryId": { - "description": "Unique identity of country.", + "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { - "description": "Unique identity of state.", + "productVersionId": { "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" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." }, - "city": { - "description": "Name of the city.", - "type": "string" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "company": { - "description": "Name of the company.", - "type": "string" + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "department": { - "description": "Name of the department.", + "externalUser": { + "description": "External user name.", "type": "string" }, "title": { - "description": "Title name given to customer like DR. , Prof., etc.", + "description": "Title of product review.", "type": "string" }, - "phoneNumber": { - "description": "Phone number of the customer.", + "content": { + "description": "Short description or subject of the project review.", "type": "string" }, - "additionalAddressLine1": { - "description": "Additional address input if necessary.", - "type": "string" + "points": { + "description": "A floating point number given to rate a product.", + "type": "number", + "format": "float" }, - "additionalAddressLine2": { - "description": "Additional address input if necessary.", - "type": "string" + "status": { + "description": "When status is set, the rating is made visible.", + "type": "boolean" }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", + "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "vatId": { - "description": "Unique identity of VAT.", + "createdAt": { "type": "string", - "deprecated": true + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductSearchConfig": { + "description": "Added since version: 6.3.5.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product Search Configuration." }, "createdAt": { "type": "string", @@ -5749,77 +5606,77 @@ "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}$", + "description": "Unique identity of Product Search Configuration field." }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "OrderCustomer": { + "ProductSearchKeyword": { "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "email", - "firstName", - "lastName" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order customer." + "description": "Unique identity of Product Search Keyword." }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderCustomer's version." - }, - "email": { - "description": "Email address of the customer.", - "type": "string" + "format": "date-time", + "readOnly": true }, - "salutationId": { - "description": "Unique identity of salutation.", + "updatedAt": { "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" + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductSorting": { + "description": "Added since version: 6.3.2.0", + "required": [ + "key", + "priority", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product sorting." }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Unique identity of VAT." + "key": { + "type": "string", + "description": "A keyword associated to identify product sorting." }, - "customerNumber": { - "description": "Unique number assigned to the customer.", - "type": "string" + "priority": { + "type": "integer", + "format": "int64", + "description": "A numerical value to prioritize the product sorting." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "label": { + "type": "string", + "description": "Label given to a product sorting." }, "createdAt": { "type": "string", @@ -5831,151 +5688,90 @@ "format": "date-time", "readOnly": true }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "OrderDelivery": { + "ProductStream": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", - "stateId", - "shippingDateEarliest", - "shippingDateLatest" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Order's delivery." + "description": "Unique identity of product stream." }, - "versionId": { + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderDelivery's version." + "description": "Name of the Dynamic Group to be created." }, - "orderId": { - "description": "Unique identity of order.", + "description": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Description of the Dynamic group to be created." }, - "orderVersionId": { + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "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", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's version." + "format": "date-time", + "readOnly": true }, - "shippingOrderAddressId": { - "description": "Unique identity of order's shipping address.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "shippingOrderAddressVersionId": { + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "ProductStreamFilter": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's shipping address version." + "description": "Unique identity of product stream filter." }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "createdAt": { "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" - }, - "description": "Tracking code is a unique URL code assigned to each package, which allows you to monitor the movement of the parcel." + "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" + }, + "ProductVisibility": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", - "format": "date-time" - }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Shipping cost of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Shipping cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "calculatedTaxes": { - "type": "object", - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "type": "object", - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "type": "object", - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Price of each line item." - }, - "discount": { - "type": "number", - "format": "float", - "description": "Absolute discount on each line item." - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Discount in percentage." - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Contains cheapest price from last 30 days as per EU law." - } - }, - "type": "object" - } - }, - "type": "object" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of product visibility." }, "createdAt": { "type": "string", @@ -5986,148 +5782,20 @@ "type": "string", "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" - } } }, "type": "object" }, - "OrderDeliveryPosition": { + "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "orderDeliveryId", - "orderLineItemId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order delivery position." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderDeliveryPosition's version." - }, - "orderDeliveryId": { - "description": "Unique identity of order delivery.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderDeliveryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order delivery's version." - }, - "orderLineItemId": { - "description": "Unique identity of line items in an order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of line item's version in an order." - }, - "price": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "calculatedTaxes": { - "type": "object", - "description": "Contains calculated taxes based on order delivery price." - }, - "taxRules": { - "type": "object", - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "type": "object", - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Price of each line item." - }, - "discount": { - "type": "number", - "format": "float", - "description": "Absolute discount on each line item." - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Discount in percentage." - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Contains cheapest price from last 30 days as per EU law." - } - }, - "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" + "description": "Unique identity of promotion." }, "customFields": { "type": "object", @@ -6142,248 +5810,163 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "OrderLineItem": { + "PromotionDiscount": { "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}$", - "description": "Unique identity of OrderLineItem." + "description": "Unique identity of promotion discount." }, - "versionId": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "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}$", - "description": "Unique identity of OrderLineItem's version." + "description": "Unique identity of promotion discount price." }, - "orderId": { - "description": "Unique identity of order.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderVersionId": { + "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}$", - "description": "Unique identity of order's version." + "description": "Unique identity of promotion individual code." }, - "productId": { - "description": "Unique identity of product.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "productVersionId": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "PromotionSalesChannel": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of products's version." + "description": "Unique identity of promotion on sales channel." }, - "promotionId": { - "description": "Unique identity of product.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "parentId": { + "updatedAt": { + "type": "string", + "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}$", - "description": "Unique identity of parent product." + "description": "Unique identity of promotion set group." }, - "parentVersionId": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "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}$", - "description": "Unique identity of parent's version." + "description": "Unique identity of property group." }, - "coverId": { - "description": "Unique identity of cover image.", + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Name of the property group." }, - "identifier": { - "description": "It is a unique identity of an item in cart before its converted to an order.", - "type": "string" + "description": { + "type": "string", + "description": "Description on property group." }, - "referencedId": { - "description": "Unique identity of type of entity.", + "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, - "quantity": { - "description": "Number of items of product.", - "type": "integer", - "format": "int64" - }, - "label": { - "description": "It is a typical product name given to the line item.", + "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, - "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" - } - }, - "description": "Any data related to product is passed." - }, - "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.", + "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, - "stackable": { - "description": "Allows to change the quantity of the line item when set to true.", + "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { - "description": "Position of line items placed in an order.", "type": "integer", - "format": "int64" + "format": "int64", + "description": "The order of the tabs of your defined property groups. Enter numerical values like 1,2,3, etc.to adjust their order of display." }, - "priceDefinition": { + "customFields": { "type": "object", - "$ref": "#/components/schemas/CartPriceQuantity", - "description": "Description of how the price has to be calculated. For example, in percentage or absolute value, etc." - }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "deprecated": true, - "description": "Internal field." + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -6395,97 +5978,37 @@ "format": "date-time", "readOnly": true }, - "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" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "children": { + "options": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/PropertyGroupOption" } - }, - "apiAlias": { - "type": "string", - "enum": [ - "order_line_item" - ] - }, - "extensions": { - "type": "object", - "description": "To store additional data to an order line item from extensions." - }, - "translated": { - "type": "object" } }, "type": "object" }, - "OrderLineItemDownload": { - "description": "Added since version: 6.4.19.0", + "Rule": { + "description": "Added since version: 6.0.0.0", "required": [ - "media", - "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Order line item downloaded digital products." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Order line item downloaded version." - }, - "orderLineItemId": { - "description": "Unique identity of Order line item.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Order line item's version." - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of rule." }, - "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" + "name": { + "description": "Name of the rule defined.", + "type": "string" }, - "accessGranted": { - "description": "When boolean value is `true`, the digital product is allowed to download.", - "type": "boolean" + "description": { + "description": "Description of the rule.", + "type": "string" }, "customFields": { "type": "object", @@ -6501,154 +6024,162 @@ "format": "date-time", "readOnly": true }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "media": { - "$ref": "#/components/schemas/Media" + "extensions": { + "description": "To store additional data to a rule from extensions." } }, "type": "object" }, - "OrderTag": { + "RuleCondition": { "description": "Added since version: 6.0.0.0", - "required": [ - "orderId", - "tagId" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order tag." - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "description": "Unique identity of rule condition." }, - "orderVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's version." + "format": "date-time", + "readOnly": true }, - "tagId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tag given for an order." - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "tag": { - "$ref": "#/components/schemas/Tag" + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "OrderTransaction": { + "SalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", + "languageId", + "customerGroupId", + "currencyId", "paymentMethodId", - "amount", - "stateId" + "shippingMethodId", + "countryId", + "navigationCategoryId", + "name", + "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction." + "description": "Unique identity of sales channel." }, - "versionId": { + "languageId": { + "description": "Unique identity of language used.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "description": "Unique identity of currency used.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method used.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryId": { + "description": "Unique identity of navigation category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderTransaction's version." + "description": "Unique identity of navigation category's version." }, - "orderId": { - "description": "Unique identity of an order.", + "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", + "type": "integer", + "format": "int64" + }, + "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "footerCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of an order's version." + "description": "Unique identity of footer category's version." }, - "paymentMethodId": { - "description": "Unique identity of payment method.", + "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "amount": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "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" + "serviceCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of service category's version." }, - "validationData": { - "type": "object" + "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of state.", + "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": "Name of the sales channel." + }, + "shortName": { + "description": "A short name for sales channel.", + "type": "string" + }, + "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", + "type": "string" + }, + "configuration": { + "type": "object" + }, + "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -6663,154 +6194,122 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current payment transaction state (e.g., open, paid, cancelled)" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + }, + "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": "Payment method used for this transaction" + "description": "Default payment method for the sales channel" }, - "captures": { - "description": "Payment captures for this transaction", + "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/OrderTransactionCapture" + "$ref": "#/components/schemas/SalesChannelDomain" } }, - "shippingCosts": { - "properties": { - "calculatedTaxes": { - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "description": "Price of each line item." - }, - "discount": { - "description": "Absolute discount on each line item." - }, - "percentage": { - "description": "Discount in percentage." - } - } - }, - "regulationPrice": { - "properties": { - "price": { - "description": "Contains cheapest price from last 30 days as per EU law." - } - } - } - } + "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" }, - "OrderTransactionCapture": { - "description": "Added since version: 6.4.12.0", + "SalesChannelAnalytics": { + "description": "Added since version: 6.2.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of sales channel analytics." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SalesChannelDomain": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderTransactionId", - "stateId", - "amount" + "url", + "salesChannelId", + "languageId", + "currencyId", + "snippetSetId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture." + "description": "Unique identity of sales channel domain." }, - "versionId": { + "url": { + "description": "URL of the sales channel domain.", + "type": "string" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture's version." + "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionVersionId": { + "currencyId": { + "description": "Unique identity of currency.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction version." + "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "description": "Unique identity of order state.", + "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" }, - "amount": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "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" + "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", + "type": "boolean" }, "customFields": { "type": "object", @@ -6826,160 +6325,65 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "transaction": { - "$ref": "#/components/schemas/OrderTransaction" + "language": { + "$ref": "#/components/schemas/Language" }, - "refunds": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } + "currency": { + "$ref": "#/components/schemas/Currency" }, - "shippingCosts": { - "properties": { - "calculatedTaxes": { - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "description": "Price of each line item." - }, - "discount": { - "description": "Absolute discount on each line item." - }, - "percentage": { - "description": "Discount in percentage." - } - } - }, - "regulationPrice": { - "properties": { - "price": { - "description": "Contains cheapest price from last 30 days as per EU law." - } - } - } - } + "salesChannelDefaultHreflang": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "OrderTransactionCaptureRefund": { - "description": "Added since version: 6.4.12.0", - "required": [ - "id", - "captureId", - "stateId", - "amount" - ], + "SalesChannelFile": { + "description": "Added since version: 6.7.12.0", "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund." + "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund's version." + "format": "date-time", + "readOnly": true }, - "captureId": { - "description": "Unique identity of order transaction capture.", + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture's version." + "format": "date-time", + "readOnly": true }, - "stateId": { - "description": "Unique identity of order state.", + "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}$" }, - "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", - "description": "Price of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, "createdAt": { "type": "string", "format": "date-time", @@ -6989,170 +6393,20 @@ "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" - } - }, - "shippingCosts": { - "properties": { - "calculatedTaxes": { - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "description": "Price of each line item." - }, - "discount": { - "description": "Absolute discount on each line item." - }, - "percentage": { - "description": "Discount in percentage." - } - } - }, - "regulationPrice": { - "properties": { - "price": { - "description": "Contains cheapest price from last 30 days as per EU law." - } - } - } - } } }, "type": "object" }, - "OrderTransactionCaptureRefundPosition": { - "description": "Added since version: 6.4.12.0", + "SalesChannelType": { + "description": "Added since version: 6.0.0.0", "required": [ - "id", - "refundId", - "orderLineItemId", - "amount" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund position." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund position's version." - }, - "refundId": { - "description": "Unique identity of order transaction capture refund.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "refundVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund's version." - }, - "orderLineItemId": { - "description": "Unique identity of order line item.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order line item version." - }, - "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": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], - "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." - }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Cost of product based on quantity." - }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." - }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "description": "Unique identity of sales channel type." }, "createdAt": { "type": "string", @@ -7164,49 +6418,14 @@ "format": "date-time", "readOnly": true }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "orderTransactionCaptureRefund": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - }, - "shippingCosts": { - "properties": { - "calculatedTaxes": { - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "description": "Pricing based on multiple taxes." - }, - "referencePrice": { - "description": "Original cost price of the product." - }, - "listPrice": { - "properties": { - "price": { - "description": "Price of each line item." - }, - "discount": { - "description": "Absolute discount on each line item." - }, - "percentage": { - "description": "Discount in percentage." - } - } - }, - "regulationPrice": { - "properties": { - "price": { - "description": "Contains cheapest price from last 30 days as per EU law." - } - } - } - } + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "PaymentMethodJsonApi": { + "SalutationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -7215,51 +6434,32 @@ { "required": [ "id", - "technicalName", - "name" + "salutationKey", + "displayName", + "letterName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, - "distinguishableName": { - "type": "string", - "readOnly": true - }, - "description": { + "displayName": { "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" + "letterName": { + "type": "string" }, "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" + "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", @@ -7273,102 +6473,47 @@ }, "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": { + "Salutation": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "technicalName", - "name" + "salutationKey", + "displayName", + "letterName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of payment method." + "description": "Unique identity of salutation." }, - "name": { - "type": "string", - "description": "Name of the payment method." + "salutationKey": { + "description": "Technical name given to salutation. For example: mr", + "type": "string" }, - "distinguishableName": { + "displayName": { "type": "string", - "readOnly": true, - "description": "System identifier name for payment method." + "description": "Name given for salutation and displayed in storefront. For example: Mr" }, - "description": { + "letterName": { "type": "string", - "description": "A short description about the payment method." + "description": "Name given for salutation and used in the mail templates. For example, Dear Mr" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "position": { - "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "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", @@ -7382,24 +6527,17 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." - }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Payment method logo or icon image" } }, "type": "object" }, - "Plugin": { + "ScheduledTask": { "description": "Added since version: 6.0.0.0", - "required": [ - "label" - ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a plugin." + "description": "Unique identity of scheduled task." }, "createdAt": { "type": "string", @@ -7410,388 +6548,211 @@ "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}$", + "description": "Unique identity of a script." }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "ProductJsonApi": { + "SeoUrlJsonApi": { "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" - ] - } - } - } - } - } + "$ref": "#/components/schemas/resource" }, { "required": [ "id", - "taxId", - "productNumber", - "stock", - "name" + "languageId", + "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}$" }, - "parentId": { + "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentVersionId": { + "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "manufacturerId": { - "description": "Unique identity of the manufacturer.", + "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.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, - "productManufacturerVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", + "type": "string" }, - "unitId": { - "description": "Unique identity of the unit.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", + "type": "string" }, - "taxId": { - "description": "Unique identity of tax.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isCanonical": { + "description": "When set to true, search redirects to the main URL.", + "type": "boolean" }, - "coverId": { - "description": "Unique identity of a ProductMedia item used as product cover.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", + "type": "boolean" }, - "productMediaVersionId": { - "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" }, - "deliveryTimeId": { - "description": "Unique identity of delivery time.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "error": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, - "canonicalProductId": { - "description": "Unique identity of canonical product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, - "canonicalProductVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "cmsPageVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "openGraphMediaId": { - "description": "Media used as Open Graph image for social media sharing.", + "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}$", + "description": "Unique identity of Seo Url template." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "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}$" }, - "productNumber": { - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", + "name": { "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" + "technicalName": { + "type": "string" }, "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.", + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "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.", + "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" }, - "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" + "customFields": { + "type": "object" }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", + "mediaId": { + "description": "Unique identity of media.", "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" + "pattern": "^[0-9a-f]{32}$" }, - "descriptionTeaser": { - "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", - "readOnly": true - }, - "metaTitle": { - "type": "string" - }, - "packUnit": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "packUnitPlural": { + "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, - "customFields": { - "type": "object" - }, - "ogTitle": { + "description": { "type": "string" }, - "ogDescription": { + "trackingUrl": { "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" - }, - "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", @@ -7807,8 +6768,8 @@ }, "relationships": { "properties": { - "downloads": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -7816,101 +6777,7 @@ "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" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" } } }, @@ -7931,68 +6798,8 @@ }, "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)", + "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -8000,7 +6807,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/unit" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" } } }, @@ -8009,20 +6816,20 @@ "properties": { "type": { "type": "string", - "example": "unit" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "3e34bdebd9bd5edda27e8728904a2552" + "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, - "cover": { - "description": "Main product image displayed in listings and detail pages", + "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -8030,29 +6837,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cover" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method_price" + }, + "id": { + "type": "string", + "example": "afae32efe0f84fece3f96b377b768b33" + } } } } }, "type": "object" }, - "openGraphMedia": { - "description": "Open Graph image for social media sharing", + "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -8060,7 +6869,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" } } }, @@ -8074,15 +6883,15 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "bbda52d941a3452369a00f2880f4f358" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "cmsPage": { - "description": "Custom CMS page layout for the product detail page", + "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -8090,29 +6899,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "canonicalProduct": { - "description": "Canonical product reference for variant consolidation and SEO purposes", + "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -8120,7 +6931,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" } } }, @@ -8129,426 +6940,12 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "tax" }, "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" + "example": "06565e5611f23fdf8cc43e5077b92b54" } } } @@ -8563,442 +6960,271 @@ } ] }, - "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}$", - "description": "Unique identity of the product." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's version." - }, - "parentId": { + "ShippingMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "deliveryTimeId", + "name" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the parent product." + "description": "Unique identity of shipping method." }, - "parentVersionId": { + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the parent product's version." + "description": "Name of the shipping method." }, - "manufacturerId": { - "description": "Unique identity of the manufacturer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "technicalName": { + "type": "string" }, - "productManufacturerVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's manufacturer version." + "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", + "type": "boolean" }, - "unitId": { - "description": "Unique identity of the unit.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" }, - "taxId": { - "description": "Unique identifier of tax.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "coverId": { - "description": "Unique identifier of a ProductMedia item used as product cover.", + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productMediaVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identifier of product's media version." - }, "deliveryTimeId": { - "description": "Unique identifier of delivery time.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "canonicalProductId": { - "description": "Unique identifier of canonical product.", + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "canonicalProductVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", + "type": "string" }, - "cmsPageId": { - "description": "Unique identifier of CMS page.", + "description": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Description of each shipping method." }, - "cmsPageVersionId": { + "trackingUrl": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identifier of CMS page's version." + "description": "This URL allows to track packages." }, - "openGraphMediaId": { - "description": "Media used as Open Graph image for social media sharing.", + "createdAt": { "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", + "format": "date-time", "readOnly": true }, - "stock": { - "description": "Indicate the number of product/s currently in stock. As soon as the order status of an order is set to completed, the stock is reduced.", - "type": "integer", - "format": "int64" - }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", + "updatedAt": { "type": "string", + "format": "date-time", "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" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "ratingAverage": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "number", - "format": "float", - "readOnly": true + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "availabilityRule": { + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, - "propertyIds": { + "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "$ref": "#/components/schemas/ShippingMethodPrice" + } }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "media": { + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, - "streamIds": { + "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "$ref": "#/components/schemas/Tag" + } }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "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}$", + "description": "Unique identity of shipping method price." }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "ruleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sales": { - "description": "Runtime field, cannot be used as part of the criteria.", + "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", - "format": "int64", - "readOnly": true + "format": "int64" }, - "metaDescription": { + "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", - "description": "A short description of the product for search results listings." + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string", - "description": "Name of the product." + "quantityStart": { + "description": "Starting range of quantity of an item.", + "type": "number", + "format": "float" }, - "keywords": { - "type": "string", - "description": "Keywords that give additional information about the Product." + "quantityEnd": { + "description": "Ending range of quantity of an item.", + "type": "number", + "format": "float" }, - "description": { - "type": "string", - "description": "Description of the product." + "currencyPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + }, + "description": "Contains currency-based price." }, - "descriptionTeaser": { - "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "createdAt": { "type": "string", + "format": "date-time", "readOnly": true }, - "metaTitle": { + "updatedAt": { "type": "string", - "description": "A page title indexed by search engines and appears in search results listings." - }, - "packUnit": { + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Snippet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "setId", + "translationKey", + "value" + ], + "properties": { + "id": { "type": "string", - "description": "Type of packing. For example, bottle, tin, crate, etc." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of snippet." }, - "packUnitPlural": { + "setId": { + "description": "Unique identity od snippet set.", "type": "string", - "description": "Type of packing in plural. For example, bottles, tins, crates, etc." - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "pattern": "^[0-9a-f]{32}$" }, - "ogTitle": { + "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, - "ogDescription": { + "value": { + "description": "Value of the key.", "type": "string" }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true, - "description": "Internal field." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "calculatedPrice": { - "type": "object", - "$ref": "#/components/schemas/CalculatedPrice", - "description": "Runtime field, cannot be used as part of the criteria." + "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}$", + "description": "Unique identity of snippet set." }, - "calculatedPrices": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "allOf": [ - { - "$ref": "#/components/schemas/CalculatedPrice" - } - ] - }, - "description": "Runtime field, cannot be used as part of the criteria." + "name": { + "description": "Name of snippet set.", + "type": "string" }, - "calculatedMaxPurchase": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" + "iso": { + "description": "ISO nomenclature used to classify languages.", + "type": "string" }, - "calculatedCheapestPrice": { + "customFields": { "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" - ] - } - }, - "description": "Runtime field, cannot be used as part of the criteria." - }, - "isNew": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "sortedProperties": { - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "measurements": { - "type": "object", - "$ref": "#/components/schemas/ProductMeasurements" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "snippets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + }, + "type": "object" + }, + "StateMachine": { + "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of state machine." }, "createdAt": { "type": "string", @@ -9014,221 +7240,356 @@ "type": "object", "description": "Contains the translations of all translated fields." }, - "downloads": { - "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "states": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/StateMachineState" } }, - "parent": { - "$ref": "#/components/schemas/Product", - "description": "Unique identity of the product." - }, - "children": { - "description": "Product variants that inherit from this parent product", + "transitions": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/StateMachineTransition" } + } + }, + "type": "object" + }, + "StateMachineHistory": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of state machine history." }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime", - "description": "Time taken for the product to reach the customer. If a delivery time is defined in the product, it overwrites the delivery time of a shipping method." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tax": { - "$ref": "#/components/schemas/Tax", - "description": "Tax configuration (rate and calculation rules)" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer", - "description": "Product manufacturer or brand information" + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "unit": { - "$ref": "#/components/schemas/Unit", - "description": "Product unit of measure (e.g., piece, liter, kg)" + "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}$", + "description": "Unique identity of state machine transition." }, - "cover": { - "$ref": "#/components/schemas/ProductMedia", - "description": "Main product image displayed in listings and detail pages" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "openGraphMedia": { - "$ref": "#/components/schemas/Media", - "description": "Open Graph image for social media sharing" + "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": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of system configuration." }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "Custom CMS page layout for the product detail page" + "configurationKey": { + "description": "Config key for shop configurations.", + "type": "string" }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product", - "description": "Canonical product reference for variant consolidation and SEO purposes" + "configurationValue": { + "properties": { + "_value": { + "type": "object", + "description": "Config value for shop configurations." + } + }, + "type": "object" }, - "media": { - "description": "Product images and media gallery", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "configuratorSettings": { - "description": "Variant configurator settings defining available options for product variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "productReviews": { - "description": "Customer reviews and ratings for the product", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "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}$", + "description": "Unique identity of tag." + }, + "name": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Tax": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "taxRate", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of tax." + }, + "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.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "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}$", + "description": "Unique identity of tax provider." }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", + "type": "boolean" }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "name": { + "type": "string", + "description": "Name of the tax provider." }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "priority": { + "description": "A numerical value to prioritize one the tax providers from the list.", + "type": "integer", + "format": "int64" }, - "properties": { - "description": "Product properties and characteristics for filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "processUrl": { + "description": "External URL makes request to get tax info.", + "type": "string" }, - "categories": { - "description": "Categories this product is assigned to", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tags": { - "description": "Tags for organizing and filtering products", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "seoCategory": { - "$ref": "#/components/schemas/Category", - "description": "Main category used for SEO URL generation in the current sales channel" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "TaxRule": { + "description": "Added since version: 6.1.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of tax rule." }, - "apiAlias": { + "createdAt": { "type": "string", - "enum": [ - "product" - ] + "format": "date-time", + "readOnly": true }, - "variantListingConfig": { - "oneOf": [ - { - "type": "object", - "properties": { - "displayParent": { - "type": "boolean" - } - } - }, - { - "type": "null" - } - ] + "updatedAt": { + "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}$", + "description": "Unique identity of tax rule type." }, - "mainVariantId": { - "description": "Unique identity of main variant." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "externalReference": { - "description": "External payment provider token." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "ProductConfiguratorSetting": { + "Theme": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "optionId" + "name", + "author", + "active" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product configurator setting." + "description": "Unique identity of Theme." }, - "versionId": { + "technicalName": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product configurator setting version." + "description": "Technical name of Theme." }, - "productId": { - "description": "Unique identity of product.", + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Name of theme which is translatable." }, - "productVersionId": { + "author": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product version." + "description": "Name of the company." }, - "mediaId": { - "description": "Unique identity of media.", + "description": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Description of the theme." }, - "optionId": { - "description": "Unique identity of option.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "labels": { + "type": "object", + "description": "Identification label given to theme." }, - "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" + "helpTexts": { + "type": "object", + "description": "Texts from config element." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "previewMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of media used for previewing the theme." + }, + "parentThemeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent theme." + }, + "baseConfig": { + "type": "object", + "description": "Config elements of theme like header, color, etc" + }, + "configValues": { + "type": "object" + }, + "active": { + "type": "boolean", + "description": "When boolean value is `true`, the created theme can be made usable." + }, "createdAt": { "type": "string", "format": "date-time", @@ -9239,56 +7600,46 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + }, "media": { - "$ref": "#/components/schemas/Media" + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" + "ConfigValues": { + "description": "Chosen values for the configuration." } }, "type": "object" }, - "ProductCrossSelling": { - "description": "Added since version: 6.1.0.0", + "Unit": { + "description": "Added since version: 6.0.0.0", "required": [ "id", + "shortCode", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product cross selling." - }, - "name": { - "type": "string", - "description": "Name defined for Product cross selling." - }, - "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" + "description": "Unique identity of Unit." }, - "type": { - "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", - "type": "string" + "shortCode": { + "type": "string", + "description": "Short name for unit, e.g., m, kg." }, - "active": { - "description": "When set to active, the cross-selling feature is enabled.", - "type": "boolean" + "name": { + "type": "string", + "description": "Full name of the unit, e.g., Meter, kilogram." }, - "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" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -9307,13 +7658,13 @@ }, "type": "object" }, - "ProductCrossSellingAssignedProducts": { - "description": "Added since version: 6.2.0.0", + "User": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product CrossSelling Assigned Products." + "description": "Unique identity of user." }, "createdAt": { "type": "string", @@ -9328,47 +7679,34 @@ }, "type": "object" }, - "ProductDownload": { - "description": "Added since version: 6.4.19.0", - "required": [ - "id", - "productId", - "mediaId" - ], + "UserAccessKey": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity downloaded product." + "description": "Unique identity of user access key." }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of downloaded product's version." + "format": "date-time", + "readOnly": true }, - "productId": { - "description": "Unique identity of Product.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "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}$", - "description": "Unique identity of Product version." - }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "description": "Unique identity of user configuration." }, "createdAt": { "type": "string", @@ -9379,23 +7717,17 @@ "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", + "UserRecovery": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Exported Product." + "description": "Unique identity of user recovery." }, "createdAt": { "type": "string", @@ -9410,16 +7742,13 @@ }, "type": "object" }, - "ProductFeatureSet": { - "description": "Added since version: 6.3.0.0", - "required": [ - "name" - ], + "Webhook": { + "description": "Added since version: 6.3.1.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product feature set." + "description": "Unique identity of webhook." }, "createdAt": { "type": "string", @@ -9430,71 +7759,84 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "ProductKeywordDictionary": { - "description": "Added since version: 6.0.0.0", - "required": [ - "languageId", - "keyword" - ], + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product keyword." + "description": "Unique identity of webhook event log." }, - "languageId": { - "description": "Unique identity of the language.", + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "keyword": { - "description": "The keywords that help to search the product.", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "ProductManufacturer": { + "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", - "name" + "mediaId", + "width", + "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the Product Manufacturer." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the ProductManufacturer's version." + "description": "Unique identity of media thumbnail." }, "mediaId": { - "description": "Unique identity of the media.", + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "link": { + "mediaThumbnailSizeId": { "type": "string", - "description": "URL of the manufacturer's portal." + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string", - "description": "Name of the product manufacturer." + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "description": { - "type": "string", - "description": "A detailed description of product manufacturer." + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "url": { + "description": "Public url of media thumbnail.", + "type": "string" + }, + "path": { + "type": "string" }, "customFields": { "type": "object", @@ -9509,333 +7851,303 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - }, - "media": { - "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "ProductMedia": { - "description": "Added since version: 6.0.0.0", - "required": [ - "media", - "id", - "productId", - "mediaId" - ], + "Breadcrumb": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the Product Media." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the ProductMedia version." - }, - "productId": { - "description": "Unique identity of the product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's version." + "name": { + "type": "string" }, - "mediaId": { - "description": "Unique identity of the media.", + "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "The order of the images to be displayed for a product.", - "type": "integer", - "format": "int64" + "type": { + "$ref": "#/components/schemas/Category/properties/type" }, - "customFields": { + "translated": { "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "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" + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "path": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } }, - "media": { - "$ref": "#/components/schemas/Media" + "apiAlias": { + "type": "string", + "enum": [ + "breadcrumb" + ] } }, - "type": "object" + "required": [ + "name", + "categoryId", + "type", + "translated", + "path", + "apiAlias" + ] }, - "ProductPrice": { - "description": "Added since version: 6.0.0.0", + "ProductPurchaseLimit": { + "type": "object", + "description": "Current quantity purchase limits for a product.", + "required": [ + "productId", + "minPurchase", + "purchaseSteps", + "maxPurchase", + "stock", + "apiAlias" + ], "properties": { - "id": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's price." + "description": "The product ID." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "minPurchase": { + "type": "integer", + "description": "Minimum quantity a customer can purchase." }, - "updatedAt": { + "purchaseSteps": { + "type": "integer", + "description": "Step increment for quantity selection." + }, + "maxPurchase": { + "type": "integer", + "description": "Maximum quantity a customer can purchase, reflecting current stock for closeout products." + }, + "stock": { + "type": [ + "integer", + "null" + ], + "description": "Current stock level of the product." + }, + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "product_purchase_limit" + ] } - }, - "type": "object" + } }, - "ProductReview": { + "Customer": { "description": "Added since version: 6.0.0.0", "required": [ + "apiAlias", + "activeBillingAddress", + "activeShippingAddress", "id", - "productId", + "groupId", "salesChannelId", "languageId", - "title", - "content" + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's review." + "description": "Unique identity of the customer." }, - "productId": { - "description": "Unique identity of the product.", + "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's version." - }, "salesChannelId": { - "description": "Unique identity of the sales channel.", + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { - "description": "Unique identity of the language.", + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalUser": { - "description": "External user name.", - "type": "string" + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "title": { - "description": "Title of product review.", - "type": "string" + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "content": { - "description": "Short description or subject of the project review.", - "type": "string" + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "points": { - "description": "A floating point number given to rate a product.", - "type": "number", - "format": "float" + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" }, - "status": { - "description": "When status is set, the rating is made visible.", - "type": "boolean" + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "comment": { - "description": "Detailed review about the product.", + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "lastName": { + "description": "Last name of the customer.", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "ProductSearchConfig": { - "description": "Added since version: 6.3.5.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product Search Configuration." + "email": { + "description": "Email ID of the customer.", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" }, - "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}$", - "description": "Unique identity of Product Search Configuration field." + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" }, - "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}$", - "description": "Unique identity of Product Search Keyword." + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" }, - "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": { + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product sorting." + "format": "date-time" }, - "key": { + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", - "description": "A keyword associated to identify product sorting." + "format": "date-time" }, - "priority": { - "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize the product sorting." + "hash": { + "description": "Password hash for account recovery.", + "type": "string" }, - "label": { + "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", - "description": "Label given to a product sorting." + "format": "date-time" }, - "createdAt": { + "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "ProductStream": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream." + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "name": { - "type": "string", - "description": "Name of the Dynamic Group to be created." + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true }, - "description": { - "type": "string", - "description": "Description of the Dynamic group to be created." + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "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" + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Unique identity tag names given to the line item." }, - "createdAt": { + "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "createdById": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "ProductStreamFilter": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "updatedById": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream filter." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -9846,208 +8158,467 @@ "type": "string", "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}$", - "description": "Unique identity of product visibility." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Promotion": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion." + "language": { + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, - "updatedAt": { + "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", - "format": "date-time", - "readOnly": true + "enum": [ + "customer" + ] }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "defaultPaymentMethodId": { + "description": "Unique identity of default payment method." + }, + "company": { + "description": "Company name of the customer." + }, + "vatIds": { + "description": "Unique identity of VAT." + }, + "accountType": { + "description": "Account type can be personal or business." + }, + "extensions": { + "properties": { + "specificFeatures": { + "description": "To store additional data to a customer from extensions." + } + } + } + }, + "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" + } + } } - }, - "type": "object" + ] }, - "PromotionDiscount": { - "description": "Added since version: 6.0.0.0", + "AggregationMetrics": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion discount." + "name": { + "type": "string" }, - "createdAt": { + "type": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "field": { + "type": "string" } }, - "type": "object" + "required": [ + "name", + "type", + "field" + ] }, - "PromotionDiscountPrices": { - "description": "Added since version: 6.0.0.0", + "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}$", - "description": "Unique identity of promotion discount price." + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "cover": { + "$ref": "#/components/schemas/Media" }, - "updatedAt": { + "dataContextHash": { + "type": "string" + }, + "dataTimestamp": { + "type": "string" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "PromotionIndividualCode": { - "description": "Added since version: 6.0.0.0", - "properties": { + "description": "Description of line items in an order." + }, + "good": { + "type": "boolean", + "description": "When set to true, it indicates the line item is physical else it is virtual." + }, "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion individual code." + "description": "Unique identity of line item." }, - "createdAt": { + "label": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "It is a typical product name given to the line item." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "PromotionSalesChannel": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion on sales channel." + "modified": { + "type": "boolean", + "description": "When boolean value is `true`, line items are said to be modified." + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "$ref": "#/components/schemas/ProductJsonApi" + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "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", + "description": "Number of items of product." + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" + } + } }, - "createdAt": { + "referencedId": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Unique identity of type of entity." }, - "updatedAt": { - "type": "string", - "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}$", - "description": "Unique identity of promotion set group." + "removable": { + "type": "boolean", + "description": "Allows the line item to be removable from the cart when set to true." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "stackable": { + "type": "boolean", + "description": "Allows to change the quantity of the line item when set to true." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "states": { + "deprecated": true, + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/OrderLineItem/properties/type", + "description": "Type refers to the entity type of an item whether it is product or promotion for instance." + }, + "uniqueIdentifier": { + "type": "string" } }, - "type": "object" + "required": [ + "id", + "type" + ] }, - "PropertyGroup": { + "CookieEntryCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CookieEntry" + } + }, + "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ + "apiAlias", + "blocks", "id", - "name" + "position", + "type", + "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of property group." + "description": "Unique identity of CMS section." }, - "name": { + "cmsPageVersionId": { "type": "string", - "description": "Name of the property group." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS page version." }, - "description": { + "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 `sidebar` or `fullwidth`.", "type": "string", - "description": "Description on property group." + "enum": [ + "default", + "sidebar" + ] }, - "displayType": { - "description": "Property groups can be displayed in the form of text, image, dropdown or color.", + "name": { + "description": "Name of the CMS section defined.", "type": "string" }, - "sortingType": { - "description": "Sorting the property group by name or position.", + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, - "filterable": { - "description": "When set to true, the property will be displayed in the product filter of product lists.", - "type": "boolean" + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" }, - "visibleOnProductDetailPage": { - "description": "When set to true, the property groups are displayed on product detail page.", - "type": "boolean" + "backgroundColor": { + "description": "Background color of CMS page.", + "type": "string" }, - "position": { - "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined property groups. Enter numerical values like 1,2,3, etc.to adjust their order of display." + "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": { + "properties": { + "mobile": { + "type": "boolean", + "description": "When `true`, CMS layout can be viewed in mobile mode." + }, + "desktop": { + "type": "boolean", + "description": "When `true`, CMS layout can be viewed in desktop mode." + }, + "tablet": { + "type": "boolean", + "description": "When `true`, CMS layout can be viewed in tablet mode." + } + }, + "type": "object" }, "customFields": { "type": "object", @@ -10063,111 +8634,191 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "page": { + "$ref": "#/components/schemas/CmsPage" }, - "options": { + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/CmsBlock" } + }, + "apiAlias": { + "type": "string", + "enum": [ + "cms_section" + ] } }, "type": "object" }, - "PropertyGroupOption": { + "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" + } + } + }, + "height": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" + }, + "value": { + "type": "number" + } + } + }, + "length": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" + }, + "value": { + "type": "number" + } + } + }, + "weight": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg" + }, + "value": { + "type": "number" + } + } + } + } + }, + "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "group", - "option", - "translated", - "id", - "groupId", - "name" + "apiAlias", + "fileExtension", + "fileName", + "hasFile", + "path", + "private", + "url", + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of property group option." - }, - "groupId": { - "description": "Unique identity of property group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string", - "description": "Name of the property group option." - }, - "position": { - "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined property group options. Enter numerical values like 1,2,3, etc.to adjust their order of display." + "description": "Unique identity of media." }, - "colorHexCode": { - "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" }, - "createdAt": { + "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 }, - "translated": { + "metaData": { "type": "object", - "description": "Contains the translations of all translated fields." + "readOnly": true, + "properties": { + "height": { + "type": "integer", + "format": "int64" + }, + "width": { + "type": "integer", + "format": "int64" + } + }, + "description": "Details of the media file uploaded." }, - "media": { - "$ref": "#/components/schemas/Media" + "config": { + "type": "object" }, - "group": { - "$ref": "#/components/schemas/PropertyGroup" + "alt": { + "type": "string", + "description": "Alternate text for media." }, - "option": { - "type": "string" - } - }, - "type": "object" - }, - "Rule": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "title": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule." + "description": "Title name give to the media." }, - "name": { - "description": "Name of the rule defined.", + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "description": { - "description": "Description of the rule.", + "path": { "type": "string" }, + "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", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -10182,161 +8833,109 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "description": "To store additional data to a rule from extensions." - } - }, - "type": "object" - }, - "RuleCondition": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule condition." + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "thumbnails": { + "description": "Generated thumbnail images in various sizes", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "media" + ] + }, + "extensions": { + "description": "To store additional data to a media from extensions." } }, "type": "object" }, - "SalesChannel": { + "CookieGroupCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CookieGroup" + } + }, + "Document": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "languageId", - "customerGroupId", - "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "name", - "homeEnabled" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." - }, - "languageId": { - "description": "Unique identity of language used.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { - "description": "Unique identity of customer group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "description": "Unique identity of currency used.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "description": "Unique identity of payment method used.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "navigationCategoryId": { - "description": "Unique identity of navigation category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of document." }, - "navigationCategoryVersionId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of navigation category's version." - }, - "navigationCategoryDepth": { - "description": "It determines the number of levels of subcategories in the storefront category menu.", - "type": "integer", - "format": "int64" - }, - "footerCategoryId": { - "description": "Unique identity of footer category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of document type." }, - "footerCategoryVersionId": { + "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of footer category's version." - }, - "serviceCategoryId": { - "description": "Unique identity of service category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of reference document." }, - "serviceCategoryVersionId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of service category's version." - }, - "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" + "description": "Unique identity of the order." }, - "businessTimeZone": { - "description": "Business timezone used for sales-channel-specific rendering. Added since version: 6.7.13.0.", - "type": "string" + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of document media file." }, - "name": { + "documentA11yMediaFileId": { "type": "string", - "description": "Name of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { - "description": "A short name for sales channel.", - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the order's version." }, - "taxCalculationType": { - "description": "Tax calculation types are `horizontal` and `vertical`.", - "type": "string" + "config": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "name", + "title" + ], + "description": "Specifies detailed information about how the component is to be rendered." }, - "configuration": { - "type": "object" + "sent": { + "type": "boolean", + "description": "When `true`, the document is already sent to the customer." }, - "active": { - "description": "When boolean value is `true`, the sales channel is enabled.", - "type": "boolean" + "static": { + "type": "boolean", + "description": "When `true`, the document is uploaded else it is generated by the system." }, - "hreflangActive": { - "description": "When set to true, the sales channel pages are available in different languages.", - "type": "boolean" + "deepLinkCode": { + "type": "string", + "description": "It is a generated special code linked to email. It is used to access details of guest customer actions." }, - "maintenance": { - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", - "type": "boolean" + "documentNumber": { + "type": "string" }, "customFields": { "type": "object", @@ -10352,121 +8951,205 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - }, - "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" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod", - "description": "Default shipping method for the sales channel" + "order": { + "$ref": "#/components/schemas/Order" }, - "country": { - "$ref": "#/components/schemas/Country", - "description": "Default country for the sales channel" + "referencedDocument": { + "$ref": "#/components/schemas/Document" }, - "domains": { - "description": "Domain URLs configured for the sales channel", + "dependentDocuments": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/Document" } }, - "navigationCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for navigation menu" - }, - "footerCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for footer navigation" + "documentMediaFile": { + "$ref": "#/components/schemas/Media" }, - "serviceCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for service pages" + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" }, - "hreflangDefaultDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" + "fileType": { + "type": "string", + "description": "Type of file like PDF." } }, "type": "object" }, - "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "EntitySearchResult": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel analytics." + "entity": { + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "total": { + "type": "integer", + "description": "The total number of found entities" }, - "updatedAt": { + "aggregations": { + "type": "array", + "description": "Contains aggregated data. A simple example is the determination of the average price from a product search query.", + "items": { + "type": "object" + } + }, + "page": { + "type": "integer", + "description": "The actual page. This can be used for pagination." + }, + "limit": { + "type": "integer", + "description": "The actual limit. This is used for pagination and goes together with the page." + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net prices are linked through the tax configuration.", + "type": "boolean" + }, + "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" + ] + }, + "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" + ] + }, + "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" + ] }, - "SalesChannelDomain": { + "PropertyGroupOption": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "url", - "salesChannelId", - "languageId", - "currencyId", - "snippetSetId" + "group", + "option", + "translated", + "id", + "groupId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel domain." - }, - "url": { - "description": "URL of the sales channel domain.", - "type": "string" + "description": "Unique identity of property group option." }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of language used.", + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Name of the property group option." }, - "currencyId": { - "description": "Unique identity of currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "position": { + "type": "integer", + "format": "int64", + "description": "The order of the tabs of your defined property group options. Enter numerical values like 1,2,3, etc.to adjust their order of display." }, - "snippetSetId": { - "description": "Unique identity of snippet set.", + "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", + "type": "string" + }, + "mediaId": { + "description": "Unique identity of media.", "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.", + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "customFields": { @@ -10483,991 +9166,1151 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "currency": { - "$ref": "#/components/schemas/Currency" + "media": { + "$ref": "#/components/schemas/Media" }, - "salesChannelDefaultHreflang": { - "$ref": "#/components/schemas/SalesChannel" + "group": { + "$ref": "#/components/schemas/PropertyGroup" + }, + "option": { + "type": "string" } }, "type": "object" }, - "SalesChannelFile": { - "description": "Added since version: 6.7.12.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" + }, + "properties": { + "id": { + "description": "Unique identity of cart item." + }, + "modified": { + "description": "When boolean value is `true`, the cart is said to be modified." + } + } } - }, - "type": "object" + } }, - "SalesChannelTrackingCustomer": { - "description": "Added since version: 6.7.9.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" } }, - "type": "object" + "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" + } }, - "SalesChannelTrackingOrder": { - "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 - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" - }, - "SalesChannelType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel type." + "name": { + "description": "Name of the shipping method." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "description": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc." }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "SalutationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "deliveryTimeId": { + "description": "Unique identity of the delivery time." }, - { - "required": [ - "id", - "salutationKey", - "displayName", - "letterName" - ], + "deliveryTime": { "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" + "name": { + "description": "Name given to delivery time." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "min": { + "description": "Minimum delivery time taken." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "max": { + "description": "Maximum delivery time taken." }, - "translated": { - "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}$", - "description": "Unique identity of salutation." - }, - "salutationKey": { - "description": "Technical name given to salutation. For example: mr", - "type": "string" - }, - "displayName": { - "type": "string", - "description": "Name given for salutation and displayed in storefront. For example: Mr" - }, - "letterName": { - "type": "string", - "description": "Name given for salutation and used in the mail templates. For example, Dear Mr" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "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", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "ScheduledTask": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of scheduled task." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "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}$", - "description": "Unique identity of a script." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SeoUrlJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours." + } + } }, - { - "required": [ - "id", - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo" - ], + "translations": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shippingMethodId": { + "description": "Unique identity of shipping method." }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Name of the shipping method." }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "description": "A short description of the shipping method." + } + } + }, + "orderDeliveries": { + "properties": { + "orderId": { + "description": "Unique identity of order." }, - "foreignKey": { - "description": "The key that references to product or category entity ID.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shippingOrderAddressId": { + "description": "Unique identity of shipping order address." }, - "routeName": { - "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string", - "enum": [ - "frontend.detail.page", - "frontend.navigation.page", - "frontend.landing.page" - ] + "shippingMethodId": { + "description": "Unique identity of shipping method." }, - "pathInfo": { - "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", - "type": "string" + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products." }, - "seoPathInfo": { - "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", - "type": "string" + "shippingDateLatest": { + "description": "Date and time of latest delivery of products." }, - "isCanonical": { - "description": "When set to true, search redirects to the main URL.", - "type": "boolean" + "stateId": { + "description": "Unique identity of state." + } + } + }, + "salesChannelDefaultAssignments": { + "properties": { + "stateId": { + "description": "Unique identity of state." }, - "isModified": { - "description": "When boolean value is `true`, the seo url is changed.", - "type": "boolean" + "languageId": { + "description": "Unique identity of language." }, - "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" + "currencyId": { + "description": "Unique identity of currency." }, - "error": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "paymentMethodId": { + "description": "Unique identity of payment method." }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "shippingMethodId": { + "description": "Unique identity of shipping method." }, - "customFields": { - "type": "object" + "countryId": { + "description": "Unique identity of country." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "navigationCategoryId": { + "description": "Unique identity of navigation category." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "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}$", - "description": "Unique identity of Seo Url." - }, - "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.detail.page", - "frontend.navigation.page", - "frontend.landing.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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "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": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Seo Url template." - }, - "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "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}$" + "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu." + }, + "footerCategoryId": { + "description": "Unique identity of footer category." + }, + "serviceCategoryId": { + "description": "Unique identity of service category." }, "name": { - "type": "string" - }, - "technicalName": { - "type": "string" + "description": "Name of the sales channel." }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", - "type": "boolean" + "shortName": { + "description": "A short name for sales channel." }, - "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" + "accessKey": { + "description": "Access key to store api." }, - "customFields": { - "type": "object" + "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the sales channel's storefront." }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "maintenanceIpWhitelist": { + "description": "Array of IP address allowed to access the sales channel." }, - "taxType": { - "description": "Refers `Free`, `Net` or `Gross` type of taxes.", - "type": "string" + "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer." }, - "description": { - "type": "string" + "customerGroupId": { + "description": "Unique identity of customer group." }, - "trackingUrl": { - "type": "string" + "hreflangActive": { + "description": "When boolean value is `true`, the sales channel pages are available in different languages." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain." + } + } + }, + "salesChannels": { + "properties": { + "stateId": { + "description": "Unique identity of state." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "languageId": { + "description": "Unique identity of language." }, - "translated": { - "type": "object" + "currencyId": { + "description": "Unique identity of currency." }, - "relationships": { - "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", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method_price" - }, - "id": { - "type": "string", - "example": "afae32efe0f84fece3f96b377b768b33" - } - } - } - } - }, - "type": "object" - }, - "media": { - "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" - } - } - } - }, - "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" - }, - "tax": { - "description": "Tax configuration for shipping costs", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "paymentMethodId": { + "description": "Unique identity of payment method." + }, + "shippingMethodId": { + "description": "Unique identity of shipping method." + }, + "countryId": { + "description": "Unique identity of country." + }, + "navigationCategoryId": { + "description": "Unique identity of navigation category." + }, + "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu." + }, + "footerCategoryId": { + "description": "Unique identity of footer category." + }, + "serviceCategoryId": { + "description": "Unique identity of service category." + }, + "name": { + "description": "Name of the sales channel." + }, + "shortName": { + "description": "A short name for sales channel." + }, + "accessKey": { + "description": "Access key to store api." + }, + "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." + }, + "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." + }, + "maintenanceIpWhitelist": { + "description": "Array of IP address allowed to access the sales channel." + }, + "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer." + }, + "customerGroupId": { + "description": "Unique identity of customer group." + }, + "hreflangActive": { + "description": "When boolean value is `true``, the sales channel pages are available in different languages." + }, + "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain." } - }, - "type": "object" + } + }, + "availabilityRule": { + "properties": { + "name": { + "description": "Unique name for the rule." + }, + "description": { + "description": "A short description about the rule." + }, + "priority": { + "description": "A numerical value to prioritize one of the rules from the list." + }, + "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage." + } + } + }, + "availabilityRuleId": { + "description": "Unique identity of availability rule." + }, + "prices": { + "properties": { + "shippingMethodId": { + "description": "Unique identity of shipping method." + }, + "currencyId": { + "description": "Unique identity of currency." + }, + "ruleId": { + "description": "Unique identity of rule." + }, + "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items." + }, + "quantityStart": { + "description": "Starting range of quantity of an item." + }, + "quantityEnd": { + "description": "Ending range of quantity of an item." + }, + "price": { + "description": "Shipping method price after applied rules." + }, + "calculationRuleId": { + "description": "Unique identity of calculation rule." + } + } + }, + "mediaId": { + "description": "Unique identity of media." + }, + "media": { + "properties": { + "userId": { + "description": "Unique identity of user." + }, + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg." + }, + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png." + }, + "fileSize": { + "description": "Size of the file media file uploaded." + }, + "title": { + "description": "Title name give to the media." + }, + "metaDataRaw": { + "description": "Details of the media file uploaded." + }, + "alt": { + "description": "Alternate text for media." + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria." + }, + "fileName": { + "description": "Name of the media file uploaded." + }, + "mediaFolderId": { + "description": "Unique identity of media folder." + }, + "private": { + "description": "Boolean value is `true` to keep the media display private." + } + } + }, + "tags": { + "properties": { + "name": { + "description": "Name of the tag." + } + } } - ] + } }, - "ShippingMethod": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "deliveryTimeId", - "name" - ], + "CartPriceReference": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method." + "purchaseUnit": { + "type": "number" }, - "name": { - "type": "string", - "description": "Name of the shipping method." + "referenceUnit": { + "type": "number" }, - "technicalName": { + "unitName": { "type": "string" }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", - "type": "boolean" + "price": { + "type": "number" }, - "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" + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + } + }, + { + "type": "null" + } + ] }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "hasRange": { + "type": "boolean" }, - "taxType": { - "description": "Refers `Free`, `Net` or `Gross` type of taxes.", + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "AggregationEntity": { + "title": "AggregationEntity", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "description": { + "type": { + "description": "The type of aggregation", "type": "string", - "description": "Description of each shipping method." + "enum": [ + "entity" + ] }, - "trackingUrl": { - "type": "string", - "description": "This URL allows to track packages." + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] + }, + "AggregationFilter": { + "title": "AggregationFilter", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "updatedAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime", - "description": "Estimated delivery time information" - }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule", - "description": "Rule defining when this shipping method is available" + "enum": [ + "filter" + ] }, - "prices": { - "description": "Shipping prices based on weight, volume, or cart value", + "filter": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Filters" } + } + }, + "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" }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Shipping method logo or carrier image" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "terms" + ] }, - "tags": { - "description": "Tags for organizing shipping methods", + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { "type": "array", + "description": "Sorting the aggregation result.", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Sort" } - }, - "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" - ], + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method price." + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "type": { + "description": "The type of aggregation", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "histogram" + ] }, - "ruleId": { - "description": "Unique identity of rule.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "calculation": { - "description": "Shipping price calculated based on quantity, price, weight or volume of items.", - "type": "integer", - "format": "int64" + "interval": { + "description": "The interval of the histogram", + "type": "number" }, - "calculationRuleId": { - "description": "Unique identity of rule calculation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": { + "description": "The format of the histogram", + "type": "string" }, - "quantityStart": { - "description": "Starting range of quantity of an item.", - "type": "number", - "format": "float" + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "quantityEnd": { - "description": "Ending range of quantity of an item.", - "type": "number", - "format": "float" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "range" + ] }, - "currencyPrice": { + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "ranges": { + "description": "The ranges of the aggregation", "type": "array", "items": { - "$ref": "#/components/schemas/Price" - }, - "description": "Contains currency-based price." - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + ] + } + ] + } } }, - "type": "object" + "required": [ + "name", + "type", + "field", + "ranges" + ] }, - "Snippet": { - "description": "Added since version: 6.0.0.0", + "LandingPage": { + "description": "Added since version: 6.4.0.0", "required": [ - "setId", - "translationKey", - "value" + "apiAlias", + "id", + "name", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of snippet." + "description": "Unique identity of landing page." }, - "setId": { - "description": "Unique identity od snippet set.", + "versionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of landing page version." }, - "translationKey": { - "description": "Reference to the snippet in the template.", - "type": "string" + "active": { + "type": "boolean", + "description": "When boolean value is `true`, respective landing pages are enlisted for use." }, - "value": { - "description": "Value of the key.", - "type": "string" + "name": { + "type": "string", + "description": "Name of landing page." }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "slotConfig": { + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "SnippetSet": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name", - "iso" - ], - "properties": { - "id": { + "metaTitle": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of snippet set." - }, - "name": { - "description": "Name of snippet set.", - "type": "string" + "description": "A page title indexed by search engines and appears in search results listings." }, - "iso": { - "description": "ISO nomenclature used to classify languages.", - "type": "string" + "metaDescription": { + "type": "string", + "description": "A short description of the page for search results listings." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "keywords": { + "type": "string", + "description": "The keywords that help to search the landing page." }, - "createdAt": { + "url": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "URL of the landing page." }, - "updatedAt": { + "cmsPageId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the CMS Page." }, - "snippets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - }, - "type": "object" - }, - "StateMachine": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine." + "description": "Unique identity of the CMS Page's version." }, "createdAt": { "type": "string", @@ -11483,262 +10326,269 @@ "type": "object", "description": "Contains the translations of all translated fields." }, - "states": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" }, - "transitions": { + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SeoUrl" } - } - }, - "type": "object" - }, - "StateMachineHistory": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine history." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true - }, - "fromStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "toStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "enum": [ + "landing_page" + ] } }, "type": "object" }, - "StateMachineState": { - "description": "Added since version: 6.0.0.0", - "required": [ - "translated", - "technicalName", - "name" - ], + "Cart": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine state." - }, - "technicalName": { - "description": "Technical name of StateMachineState.", - "type": "string" - }, "name": { - "type": "string", - "description": "Display name of StateMachineState." + "description": "Name of the cart - for example `guest-cart`", + "type": "string" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "price": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "translated": { + "errors": { "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "StateMachineTransition": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine transition." + "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": { + "code": { + "type": "number" + }, + "key": { + "type": "string" + }, + "level": { + "type": "number" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + }, + "required": [ + "code", + "key", + "level", + "message", + "messageKey" + ] + } + } + ], + "properties": { + "key": { + "description": "Unique key for every message." + }, + "level": { + "description": "Types of level - Notice, warning and error. " + }, + "message": { + "description": "A persistent error passed from the shopping cart calculation processes to the user end." + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } }, - "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": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of system configuration." + "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" + } + } + }, + "properties": { + "paymentMethodId": { + "description": "Unique identity of payment method." + } + } }, - "configurationKey": { - "description": "Config key for shop configurations.", - "type": "string" + "modified": { + "type": "boolean", + "description": "It signifies any changes to cart." }, - "configurationValue": { - "properties": { - "_value": { - "type": "object", - "description": "Config value for shop configurations." + "customerComment": { + "description": "A comment that can be added to the cart.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" } - }, - "type": "object" + ] }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "affiliateCode": { + "description": "An affiliate tracking code", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "campaignCode": { + "description": "A campaign tracking code", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "cart" + ] }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "id": { + "description": "Unique identity of cart." } }, - "type": "object" + "required": [ + "price", + "apiAlias" + ] }, - "Tag": { + "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ + "apiAlias", + "slots", "id", - "name" + "position", + "type", + "sectionId" ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tag." - }, - "name": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS Block version." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Tax": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "taxRate", - "name" - ], - "properties": { - "id": { + "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax." + "description": "Unique identity of CMS Section version." }, - "taxRate": { - "description": "Rate of tax.", - "type": "number", - "format": "float" + "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": "Name defined for a Tax.", + "description": "Unique name of the CMS Block.", "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.", - "type": "integer", - "format": "int64" + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" }, - "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}$", - "description": "Unique identity of tax provider." + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" }, - "active": { - "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", - "type": "boolean" + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" }, - "name": { + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", - "description": "Name of the tax provider." + "pattern": "^[0-9a-f]{32}$" }, - "priority": { - "description": "A numerical value to prioritize one the tax providers from the list.", - "type": "integer", - "format": "int64" + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" }, - "processUrl": { - "description": "External URL makes request to get tax info.", + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, - "appId": { - "description": "Unique identity of app.", + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11756,221 +10606,679 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "slots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + }, + "apiAlias": { + "type": "string", + "enum": [ + "cms_block" + ] } }, "type": "object" }, - "TaxRule": { - "description": "Added since version: 6.1.0.0", + "CartItemsUpdate": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartLineItemUpdate" + } + } + } + }, + "CartLineItemUpdate": { + "type": "object", + "required": [ + "id" + ], "properties": { "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax rule." + "type": "string" }, - "createdAt": { + "type": { + "$ref": "#/components/schemas/OrderLineItem/properties/type" + }, + "quantity": { + "type": "integer" + }, + "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" + } + } + } + } + } + } + } + }, + "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", - "format": "date-time", - "readOnly": true + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "updatedAt": { + "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." + } + } + } + } + }, + "AccountNewsletterRecipient": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/NewsletterStatus" + }, + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "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" + }, + { + "type": "null" + } + ] + } + } } - }, - "type": "object" - }, - "TaxRuleType": { - "description": "Added since version: 6.1.0.0", - "required": [ - "typeName" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax rule type." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "filter": { + "properties": { + "type": { + "description": "To filter the results and aggregations with filter types like ==, >=, etc." + }, + "field": { + "description": "To filter the results and aggregations by field like an property identifier." + }, + "value": { + "description": "To filter the results and aggregations by value." + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "sort": { + "properties": { + "field": { + "description": "Sort the search results by field like an property identifier." + }, + "order": { + "description": "Sort the search results of orders by ascending or descending." + }, + "naturalSorting": { + "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." + } + } }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "post-filter": { + "properties": { + "type": { + "description": "To filter only the results but not the aggregations with filter types like ==, >=, etc." + }, + "field": { + "description": "To filter only the results but not the aggregations by field like an property identifier." + }, + "value": { + "description": "To filter only the results but not the aggregations by value." + } + } } - }, - "type": "object" + } }, - "Theme": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "author", - "active" - ], + "CartPriceQuantity": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Theme." - }, - "technicalName": { - "type": "string", - "description": "Technical name of Theme." - }, - "name": { - "type": "string", - "description": "Name of theme which is translatable." - }, - "author": { - "type": "string", - "description": "Name of the company." - }, - "description": { + "apiAlias": { "type": "string", - "description": "Description of the theme." - }, - "labels": { - "type": "object", - "description": "Identification label given to theme." - }, - "helpTexts": { - "type": "object", - "description": "Texts from config element." + "enum": [ + "cart_price_quantity" + ] }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "isCalculated": { + "type": "boolean" }, - "previewMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media used for previewing the theme." + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" }, - "parentThemeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent theme." + "price": { + "type": "number" }, - "baseConfig": { - "type": "object", - "description": "Config elements of theme like header, color, etc" + "quantity": { + "type": "number" }, - "configValues": { + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, "type": "object" }, - "active": { - "type": "boolean", - "description": "When boolean value is `true`, the created theme can be made usable." + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "only-aggregations": { + "description": "If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + }, + "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" + } + } }, - "translated": { + "location": { "type": "object", - "description": "Contains the translations of all translated fields." + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } }, - "media": { + "positions": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/CartDeliveryPosition" } }, - "ConfigValues": { - "description": "Chosen values for the configuration." + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" } - }, - "type": "object" + } }, - "Unit": { + "OrderLineItem": { "description": "Added since version: 6.0.0.0", "required": [ + "apiAlias", "id", - "shortCode", - "name" + "orderId", + "identifier", + "quantity", + "label", + "children", + "states" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Unit." + "description": "Unique identity of OrderLineItem." }, - "shortCode": { + "versionId": { "type": "string", - "description": "Short name for unit, e.g., m, kg." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderLineItem's version." }, - "name": { + "orderId": { + "description": "Unique identity of order.", "type": "string", - "description": "Full name of the unit, e.g., Meter, kilogram." - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order's version." }, - "updatedAt": { + "productId": { + "description": "Unique identity of product.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "User": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user." + "description": "Unique identity of products's version." }, - "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 - } - }, - "type": "object" - }, - "UserAccessKey": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent product." + }, + "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user access key." + "description": "Unique identity of parent's version." + }, + "coverId": { + "description": "Unique identity of cover image.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", + "type": "string" + }, + "referencedId": { + "description": "Unique identity of type of entity.", + "type": "string" + }, + "quantity": { + "description": "Number of items of product.", + "type": "integer", + "format": "int64" + }, + "label": { + "description": "It is a typical product name given to the line item.", + "type": "string" + }, + "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" + } + }, + "description": "Any data related to product is passed." + }, + "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", + "description": "Description of how the price has to be calculated. For example, in percentage or absolute value, etc." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true, + "description": "Internal field." }, "createdAt": { "type": "string", @@ -11981,80 +11289,111 @@ "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}$", - "description": "Unique identity of user configuration." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "cover": { + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, - "updatedAt": { + "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", - "format": "date-time", - "readOnly": true + "enum": [ + "order_line_item" + ] + }, + "extensions": { + "type": "object", + "description": "To store additional data to an order line item from extensions." + }, + "translated": { + "type": "object" } }, "type": "object" }, - "UserRecovery": { + "Association": { + "additionalProperties": { + "$ref": "#/components/schemas/Association" + } + }, + "CmsPage": { "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "sections", + "id", + "type" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user recovery." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "description": "Unique identity of CMS page." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "Webhook": { - "description": "Added since version: 6.3.1.0", - "properties": { - "id": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of webhook." + "description": "Unique identity of CMS page version." }, - "createdAt": { + "name": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Name of the CMS page." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.0", - "properties": { - "id": { + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" + }, + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string", + "description": "Background color of the CMS page." + } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of webhook event log." + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -12065,3541 +11404,4131 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "NewsletterStatus": { - "type": "string", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct", - "undefined" - ], - "description": "The subscription status. Possible values are: notSet, optIn, optOut, direct, undefined." - }, - "Breadcrumb": { - "type": "object", - "properties": { - "name": { - "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" - } - } - }, - "path": { - "type": "string" + "description": "Contains the translations of all translated fields." }, - "seoUrls": { + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" - } - }, - "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." - }, - "minPurchase": { - "type": "integer", - "description": "Minimum quantity a customer can purchase." - }, - "purchaseSteps": { - "type": "integer", - "description": "Step increment for quantity selection." + "$ref": "#/components/schemas/CmsSection" + } }, - "maxPurchase": { - "type": "integer", - "description": "Maximum quantity a customer can purchase, reflecting current stock for closeout products." + "previewMedia": { + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, - "stock": { - "type": [ - "integer", - "null" - ], - "description": "Current stock level of the product." + "landingPages": { + "description": "Landing pages using this CMS layout", + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } }, "apiAlias": { "type": "string", "enum": [ - "product_purchase_limit" - ] - } - } - }, - "AggregationMetrics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" + "cms_page" ] - }, - "field": { - "type": "string" } }, - "required": [ - "name", - "type", - "field" - ] - }, - "LineItemType": { - "type": "string", - "deprecated": true, - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" - ] + "type": "object" }, - "LineItem": { + "ProductDetailResponse": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "children": { + "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/LineItem" + "$ref": "#/components/schemas/PropertyGroup" } }, - "cover": { - "$ref": "#/components/schemas/Media" + "id": { + "description": "Unique identity of product detail response." }, - "dataContextHash": { - "type": "string" + "available": { + "description": "When boolean value is true, the product is available for purchase." }, - "dataTimestamp": { - "type": "string" + "isCloseout": { + "description": "Boolean value to check if the product is still buyable when stock value is 0." }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" + "displayGroup": { + "description": "Internal field." }, - "description": { - "type": "string", - "description": "Description of line items in an order." + "manufacturerNumber": { + "description": "Unique number of the product manufacturer." }, - "good": { - "type": "boolean", - "description": "When set to true, it indicates the line item is physical else it is virtual." + "stock": { + "description": "Quantity of product available." }, + "sortedProperties": { + "description": "Properties of the product that are sorted" + } + }, + "required": [ + "product" + ] + }, + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "id", + "type", + "slot", + "blockId" + ], + "properties": { "id": { "type": "string", - "description": "Unique identity of line item." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS slot." }, - "label": { + "versionId": { "type": "string", - "description": "It is a typical product name given to the line item." + "pattern": "^[0-9a-f]{32}$" }, - "modified": { - "type": "boolean", - "description": "When boolean value is `true`, line items are said to be modified." + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS block version." }, - "modifiedByApp": { - "type": "boolean" + "fieldConfig": { + "type": "object", + "description": "Con info of cms slot" }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" + "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" }, - "price": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "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" - ] + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", + "type": "string" }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "locked": { + "type": "boolean", + "description": "When locked, then CMS slot config element cannot be configured." }, - "quantity": { - "type": "number", - "description": "Number of items of product." + "config": { + "type": "object", + "description": "Specifies detailed information about how the component is to be rendered." }, - "quantityInformation": { + "customFields": { "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" - } - } + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "referencedId": { + "data": { + "type": "object", + "readOnly": true, + "description": "Each cms slot (element) has a config that has values defined in the admin. When cms loads, each Resolver class adds the resolved config data to this value." + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", - "description": "Unique identity of type of entity." + "pattern": "^[0-9a-f]{32}$" }, - "removable": { - "type": "boolean", - "description": "Allows the line item to be removable from the cart when set to true." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "stackable": { - "type": "boolean", - "description": "Allows to change the quantity of the line item when set to true." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "states": { - "deprecated": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "type": { - "$ref": "#/components/schemas/OrderLineItem/properties/type", - "description": "Type refers to the entity type of an item whether it is product or promotion for instance." + "block": { + "$ref": "#/components/schemas/CmsBlock" }, - "uniqueIdentifier": { - "type": "string" + "apiAlias": { + "type": "string", + "enum": [ + "cms_slot" + ] + }, + "VersionId": { + "description": "Unique identity of CMS slot's version." } }, - "required": [ - "id", - "type" - ] - }, - "CookieEntryCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CookieEntry" - } + "type": "object" }, - "ProductMeasurements": { + "Criteria": { "type": "object", - "description": "Runtime field, cannot be used as part of the criteria. Measurements of a product, including dimensions and weight.", + "description": "Criteria to query entities.", "properties": { - "width": { - "type": "object", + "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" + } + ] + }, "properties": { - "unit": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm" + "type": { + "description": "To filter the results and aggregations with filter types like ==, >=, etc." + }, + "field": { + "description": "To filter the results and aggregations by field like an property identifier." }, "value": { - "type": "number" + "description": "To filter the results and aggregations by value." } } }, - "height": { - "type": "object", - "properties": { - "unit": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm" - }, - "value": { - "type": "number" - } + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" } }, - "length": { - "type": "object", + "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" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + }, "properties": { - "unit": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm" + "type": { + "description": "To filter only the results but not the aggregations with filter types like ==, >=, etc." + }, + "field": { + "description": "To filter only the results but not the aggregations by field like an property identifier." }, "value": { - "type": "number" + "description": "To filter only the results but not the aggregations by value." } } }, - "weight": { - "type": "object", + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "$ref": "#/components/schemas/Sort" + }, "properties": { - "unit": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg" + "field": { + "description": "Sort the search results by field like an property identifier." }, - "value": { - "type": "number" + "order": { + "description": "Sort the search results of orders by ascending or descending." + }, + "naturalSorting": { + "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." } } + }, + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + }, + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } + }, + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } + }, + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" + }, + "includes": { + "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, - "CookieGroupCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CookieGroup" - } - }, - "EntitySearchResult": { + "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": { - "entity": { + "page": { + "description": "Search result page", + "type": "integer" + }, + "term": { + "description": "Search term", "type": "string" }, - "total": { - "type": "integer", - "description": "The total number of found entities" + "limit": { + "description": "Number of items per result page", + "type": "integer" + }, + "filter": { + "type": "array", + "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "query": { + "type": "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" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "$ref": "#/components/schemas/Sort" + } }, "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" + "$ref": "#/components/schemas/Aggregation" } }, - "page": { - "type": "integer", - "description": "The actual page. This can be used for pagination." + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "limit": { - "type": "integer", - "description": "The actual limit. This is used for pagination and goes together with the page." + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" + }, + "includes": { + "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, - "Price": { + "Associations": { "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross price for the associated currency.", - "type": "number" - }, - "net": { - "description": "Net price for the associated currency.", - "type": "number" - }, - "linked": { - "description": "Whether gross and net prices are linked through the tax configuration.", - "type": "boolean" + "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" }, - "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" + { + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" }, - "net": { - "description": "Discount percentage relative to the net list price.", - "type": "number" + { + "$ref": "#/components/schemas/SubAggregations" } - }, - "required": [ - "gross", - "net" ] }, - "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}$" + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" }, - "gross": { - "description": "Gross list price for the associated currency.", - "type": "number" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "net": { - "description": "Net list price for the associated currency.", - "type": "number" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "linked": { - "description": "Whether gross and net list prices are linked through the tax configuration.", - "type": "boolean" + { + "$ref": "#/components/schemas/SubAggregations" } - }, - "required": [ - "gross", - "net" ] }, - "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}$" + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "gross": { - "description": "Gross regulation price for the associated currency.", - "type": "number" + { + "$ref": "#/components/schemas/AggregationEntity" }, - "net": { - "description": "Net regulation price for the associated currency.", - "type": "number" + { + "$ref": "#/components/schemas/AggregationFilter" }, - "linked": { - "description": "Whether gross and net regulation prices are linked through the tax configuration.", - "type": "boolean" + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" } - }, - "required": [ - "gross", - "net" ] } - }, - "required": [ - "currencyId", - "gross", - "net" + } + }, + "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" ] }, - "CartItems": { + "Query": { "type": "object", - "required": [ - "items" - ], "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - }, - "properties": { - "id": { - "description": "Unique identity of cart item." + "score": { + "type": "number" + }, + "query": { + "oneOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "modified": { - "description": "When boolean value is `true`, the cart is said to be modified." + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - } + ] } - } + }, + "additionalProperties": true }, - "CookieRouteResponse": { + "Sort": { "type": "object", - "description": "Response containing cookie groups and their configuration hash.", "properties": { - "apiAlias": { + "field": { + "type": "string" + }, + "order": { "type": "string", "enum": [ - "cookie_groups_hash" + "ASC", + "DESC" ] }, - "elements": { - "type": "array", - "description": "Collection of cookie groups", - "items": { - "$ref": "#/components/schemas/CookieGroup" - } - }, - "hash": { - "type": "string", - "description": "Hash of the current cookie configuration. Can be used to detect changes in cookie configuration.", - "example": "f86b6a872cb83dbd22d838ceda1aa3d4" + "naturalSorting": { + "type": "boolean" }, - "languageId": { - "type": "string", - "format": "uuid", - "description": "The language ID for which the cookie configuration was generated. Used to store hashes per language.", - "example": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" + "type": { + "type": "string" } }, "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" - } + "field", + "order" + ] }, - "ShippingMethodPageRouteResponse": { + "Filters": { "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" - } - } - } + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "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" - } - } - } + { + "$ref": "#/components/schemas/EqualsFilter" }, - "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" - } - } - } + { + "$ref": "#/components/schemas/MultiNotFilter" }, - "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" - } - } + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] + }, + "field": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multi", + "not" + ] + }, + "operator": { + "type": "string", + "enum": [ + "and", + "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", + "properties": { + "gte": { + "type": "number" + }, + "gt": { + "type": "number" + }, + "lte": { + "type": "number" + }, + "lt": { + "type": "number" } + } + } + }, + "required": [ + "type", + "field", + "parameters" + ] + }, + "CookieGroup": { + "type": "object", + "properties": { + "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": [ + "cookie_group" + ] + } + }, + "not": { + "allOf": [ + { + "required": [ + "cookie" + ] }, - "availabilityRule": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "invalid": { - "type": "boolean" - } + { + "required": [ + "entries" + ] + } + ] + }, + "required": [ + "name", + "isRequired", + "apiAlias" + ] + }, + "ProductMedia": { + "description": "Added since version: 6.0.0.0", + "required": [ + "media", + "id", + "productId", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the Product Media." + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the ProductMedia version." + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "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", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + }, + "StateMachineState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "translated", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of state machine state." + }, + "technicalName": { + "description": "Technical name of StateMachineState.", + "type": "string" + }, + "name": { + "type": "string", + "description": "Display name of StateMachineState." + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "ReferencePrice": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ListPrice" + }, + { + "type": "null" } - }, - "availabilityRuleId": { - "type": "string" - }, - "prices": { - "type": "array", - "items": { + ] + }, + "regulationPrice": { + "oneOf": [ + { "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" + "type": "number" }, - "calculationRuleId": { - "type": "string" + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } } + }, + { + "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" - } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" } - }, - "tags": { - "type": "array", - "items": { + ] + } + }, + "required": [ + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "OrderRouteResponse": { + "type": "object", + "properties": { + "orders": { + "type": "object", + "allOf": [ + { "type": "object", + "required": [ + "elements" + ], "properties": { - "name": { - "type": "string" + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } } } + }, + { + "$ref": "#/components/schemas/EntitySearchResult" + } + ] + }, + "paymentChangeable": { + "type": "object", + "description": "The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.", + "additionalProperties": { + "type": "boolean" + } + } + }, + "required": [ + "orders" + ] + }, + "WishlistLoadRouteResponse": { + "type": "object", + "required": [ + "products" + ], + "properties": { + "wishlist": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identity of the customer." + }, + "salesChannelId": { + "type": "string", + "description": "Unique identity of the sales channel." } } + }, + "products": { + "$ref": "#/components/schemas/ProductListingResult" + } + } + }, + "Sitemap": { + "type": "object", + "properties": { + "filename": { + "type": "string", + "description": "Name of the file which holds a list of all URL's." + }, + "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}$", + "description": "Unique identity of Seo Url." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, + "type": "object", + "title": "SeoUrlEntity" + }, + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" + ] + }, + "Order": { + "description": "Added since version: 6.0.0.0", + "required": [ + "documents", + "orderDate", + "stateMachineState", + "price", + "id", + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor" + ], "properties": { - "name": { - "description": "Name of the shipping method." + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order." }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order version." }, - "description": { - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc." + "orderNumber": { + "description": "Unique number associated with every order.", + "type": "string" }, - "deliveryTimeId": { - "description": "Unique identity of the delivery time." + "billingAddressId": { + "description": "Unique identity of the billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "deliveryTime": { - "properties": { - "name": { - "description": "Name given to delivery time." - }, - "min": { - "description": "Minimum delivery time taken." - }, - "max": { - "description": "Maximum delivery time taken." - }, - "unit": { - "description": "Unit in which the delivery time is defined. For example, days or hours." - } - } + "billingAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the billing address version." }, - "translations": { - "properties": { - "shippingMethodId": { - "description": "Unique identity of shipping method." - }, - "name": { - "description": "Name of the shipping method." - }, - "description": { - "description": "A short description of the shipping method." - } - } + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveries": { - "properties": { - "orderId": { - "description": "Unique identity of order." - }, - "shippingOrderAddressId": { - "description": "Unique identity of shipping order address." - }, - "shippingMethodId": { - "description": "Unique identity of shipping method." - }, - "shippingDateEarliest": { - "description": "Date and time of earliest delivery of products." - }, - "shippingDateLatest": { - "description": "Date and time of latest delivery of products." - }, - "stateId": { - "description": "Unique identity of state." - } - } + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salesChannelDefaultAssignments": { - "properties": { - "stateId": { - "description": "Unique identity of state." - }, - "languageId": { - "description": "Unique identity of language." - }, - "currencyId": { - "description": "Unique identity of currency." - }, - "paymentMethodId": { - "description": "Unique identity of payment method." - }, - "shippingMethodId": { - "description": "Unique identity of shipping method." - }, - "countryId": { - "description": "Unique identity of country." - }, - "navigationCategoryId": { - "description": "Unique identity of navigation category." - }, - "navigationCategoryDepth": { - "description": "It determines the number of levels of subcategories in the storefront category menu." - }, - "footerCategoryId": { - "description": "Unique identity of footer category." - }, - "serviceCategoryId": { - "description": "Unique identity of service category." - }, - "name": { - "description": "Name of the sales channel." - }, - "shortName": { - "description": "A short name for sales channel." - }, - "accessKey": { - "description": "Access key to store api." - }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the sales channel's storefront." - }, - "maintenance": { - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." - }, - "maintenanceIpWhitelist": { - "description": "Array of IP address allowed to access the sales channel." - }, - "mailHeaderFooterId": { - "description": "Unique identity of mail header and footer." - }, - "customerGroupId": { - "description": "Unique identity of customer group." - }, - "hreflangActive": { - "description": "When boolean value is `true`, the sales channel pages are available in different languages." - }, - "hreflangDefaultDomainId": { - "description": "Unique identity of hreflangDefaultDomain." - } - } + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salesChannels": { - "properties": { - "stateId": { - "description": "Unique identity of state." - }, - "languageId": { - "description": "Unique identity of language." - }, - "currencyId": { - "description": "Unique identity of currency." - }, - "paymentMethodId": { - "description": "Unique identity of payment method." - }, - "shippingMethodId": { - "description": "Unique identity of shipping method." - }, - "countryId": { - "description": "Unique identity of country." - }, - "navigationCategoryId": { - "description": "Unique identity of navigation category." + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "description": "Unique identity of the currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDateTime": { + "description": "Timestamp when the order was placed.", + "type": "string", + "format": "date-time" + }, + "orderDate": { + "description": "Date when the order was placed.", + "type": "string", + "readOnly": true + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float", + "description": "Net price of the product." }, - "navigationCategoryDepth": { - "description": "It determines the number of levels of subcategories in the storefront category menu." + "totalPrice": { + "type": "number", + "format": "float", + "description": "Gross price of the product." }, - "footerCategoryId": { - "description": "Unique identity of footer category." + "calculatedTaxes": { + "type": "object" }, - "serviceCategoryId": { - "description": "Unique identity of service category." + "taxRules": { + "type": "object" }, - "name": { - "description": "Name of the sales channel." + "positionPrice": { + "type": "number", + "format": "float", + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc." }, - "shortName": { - "description": "A short name for sales channel." + "rawTotal": { + "type": "number", + "format": "float", + "description": "The total value before rounding off." }, - "accessKey": { - "description": "Access key to store api." + "taxStatus": { + "type": "string", + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values." + } + }, + "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", + "description": "Shipping cost of product per item (where, quantity=1)." }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." + "totalPrice": { + "type": "number", + "format": "float", + "description": "Shipping cost of product based on quantity." }, - "maintenance": { - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." }, - "maintenanceIpWhitelist": { - "description": "Array of IP address allowed to access the sales channel." + "calculatedTaxes": { + "type": "object", + "description": "Contains calculated taxes based on shipping costs/methods." }, - "mailHeaderFooterId": { - "description": "Unique identity of mail header and footer." + "taxRules": { + "type": "object", + "description": "Pricing based on multiple taxes." }, - "customerGroupId": { - "description": "Unique identity of customer group." + "referencePrice": { + "type": "object", + "description": "Original cost price of the product." }, - "hreflangActive": { - "description": "When boolean value is `true``, the sales channel pages are available in different languages." + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float", + "description": "Price of each line item." + }, + "discount": { + "type": "number", + "format": "float", + "description": "Absolute discount on each line item." + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Discount in percentage." + } + }, + "type": "object" }, - "hreflangDefaultDomainId": { - "description": "Unique identity of hreflangDefaultDomain." + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float", + "description": "Contains cheapest price from last 30 days as per EU law." + } + }, + "type": "object" } - } + }, + "type": "object" }, - "availabilityRule": { - "properties": { - "name": { - "description": "Unique name for the rule." - }, - "description": { - "description": "A short description about the rule." - }, - "priority": { - "description": "A numerical value to prioritize one of the rules from the list." - }, - "invalid": { - "description": "When the boolean value is `true`, the rule is no more available for usage." - } + "shippingTotal": { + "description": "Total shipping cost of the ordered product.", + "type": "number", + "format": "float", + "readOnly": true + }, + "currencyFactor": { + "description": "Rate at which currency is exchanged.", + "type": "number", + "format": "float" + }, + "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { + "type": "string" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "createdById": { + "description": "Unique identity of createdBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "description": "Unique identity of updatedBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "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" } }, - "availabilityRuleId": { - "description": "Unique identity of availability rule." + "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" + } }, - "prices": { - "properties": { - "shippingMethodId": { - "description": "Unique identity of shipping method." - }, - "currencyId": { - "description": "Unique identity of currency." - }, - "ruleId": { - "description": "Unique identity of rule." - }, - "calculation": { - "description": "Shipping price calculated based on quantity, price, weight or volume of items." - }, - "quantityStart": { - "description": "Starting range of quantity of an item." - }, - "quantityEnd": { - "description": "Ending range of quantity of an item." - }, - "price": { - "description": "Shipping method price after applied rules." - }, - "calculationRuleId": { - "description": "Unique identity of calculation rule." - } + "lineItems": { + "description": "Order line items (products, discounts, fees)", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" } }, - "mediaId": { - "description": "Unique identity of media." + "transactions": { + "description": "Payment transactions for the order", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } }, - "media": { - "properties": { - "userId": { - "description": "Unique identity of user." - }, - "mimeType": { - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg." - }, - "fileExtension": { - "description": "Type of file indication. For example: jpeg, png." - }, - "fileSize": { - "description": "Size of the file media file uploaded." - }, - "title": { - "description": "Title name give to the media." - }, - "metaDataRaw": { - "description": "Details of the media file uploaded." - }, - "alt": { - "description": "Alternate text for media." - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria." - }, - "fileName": { - "description": "Name of the media file uploaded." - }, - "mediaFolderId": { - "description": "Unique identity of media folder." - }, - "private": { - "description": "Boolean value is `true` to keep the media display private." - } + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" } }, "tags": { - "properties": { - "name": { - "description": "Name of the tag." - } + "description": "Tags assigned to the order for organization and filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" } + }, + "extensions": { + "description": "To store additional data to an order from extensions." } - } + }, + "type": "object" }, - "CartPriceReference": { - "type": "object", + "CustomerAddress": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" + ], "properties": { - "purchaseUnit": { - "type": "number" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of customer's address." }, - "referenceUnit": { - "type": "number" + "customerId": { + "description": "Unique identity of customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unitName": { - "type": "string" + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number" + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "apiAlias": { + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "enum": [ - "cart_price_reference" - ] + "pattern": "^[0-9a-f]{32}$" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - } - }, - { - "type": "null" - } - ] + "lastName": { + "description": "Last name of the customer.", + "type": "string" }, - "hasRange": { - "type": "boolean" + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] - }, - "AggregationEntity": { - "title": "AggregationEntity", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", + "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" }, - "type": { - "description": "The type of aggregation", + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "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", - "enum": [ - "entity" - ] + "format": "date-time", + "readOnly": true }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "definition": { - "description": "The entity definition e.g \"product_manufacturer\".", - "type": "string" + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, - "required": [ - "name", - "type", - "field", - "definition" - ] + "type": "object" }, - "AggregationFilter": { - "title": "AggregationFilter", + "ListPrice": { "type": "object", + "description": "", "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "discount": { + "type": "number" }, - "type": { - "description": "The type of aggregation", + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { "type": "string", "enum": [ - "filter" + "cart_list_price" ] - }, - "filter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Filters" - } } }, "required": [ - "name", - "type", - "filter" + "apiAlias" ] }, - "AggregationTerms": { - "title": "AggregationTerms", - "type": "object", + "OrderLineItemDownload": { + "description": "Added since version: 6.4.19.0", + "required": [ + "media", + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted" + ], "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", + "id": { "type": "string", - "enum": [ - "terms" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Order line item downloaded digital products." }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Order line item downloaded version." }, - "limit": { - "description": "The number of terms to return", - "type": "number" + "orderLineItemId": { + "description": "Unique identity of Order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sort": { - "type": "array", - "description": "Sorting the aggregation result.", - "items": { - "$ref": "#/components/schemas/Sort" - } - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationHistogram": { - "title": "AggregationHistogram", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Order line item's version." }, - "type": { - "description": "The type of aggregation", + "mediaId": { + "description": "Unique identity of media.", "type": "string", - "enum": [ - "histogram" - ] + "pattern": "^[0-9a-f]{32}$" }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "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" }, - "interval": { - "description": "The interval of the histogram", - "type": "number" + "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", + "type": "boolean" }, - "format": { - "description": "The format of the histogram", - "type": "string" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "timeZone": { - "description": "The timezone of the histogram", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationRange": { - "title": "AggregationRange", - "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "type": { - "description": "The type of aggregation", + "updatedAt": { "type": "string", - "enum": [ - "range" - ] + "format": "date-time", + "readOnly": true }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" }, - "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" - ] - } - ] - } + "media": { + "$ref": "#/components/schemas/Media" } }, - "required": [ - "name", - "type", - "field", - "ranges" - ] + "type": "object" }, - "Cart": { + "CalculatedPrice": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" + "unitPrice": { + "type": "number" }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" + "quantity": { + "type": "number" }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "rawTotal": { + "type": "number" }, - "lineItems": { - "description": "All items within the cart", + "totalPrice": { + "type": "number" + }, + "taxStatus": { + "type": "string", + "enum": [ + "net", + "tax-free" + ] + }, + "calculatedTaxes": { "type": "array", "items": { - "$ref": "#/components/schemas/LineItem" + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] } }, - "errors": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "anyOf": [ + "referencePrice": { + "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartError" - } + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" }, + { + "type": "null" + } + ] + }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "oneOf": [ { "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "code": { - "type": "number" - }, - "key": { - "type": "string" - }, - "level": { - "type": "number" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } + "properties": { + "price": { + "type": "number" }, - "required": [ - "code", - "key", - "level", - "message", - "messageKey" - ] + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } } - } - ], - "properties": { - "key": { - "description": "Unique key for every message." }, - "level": { - "description": "Types of level - Notice, warning and error. " + { + "type": "null" + } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" }, - "message": { - "description": "A persistent error passed from the shopping cart calculation processes to the user end." + { + "type": "null" } - } + ] }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", + "taxRules": { "type": "array", + "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { - "paymentMethodId": { - "type": "string" + "taxRate": { + "type": "number", + "format": "float" }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" + "name": { + "type": "string" } } - }, - "properties": { - "paymentMethodId": { - "description": "Unique identity of payment method." - } } + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules", + "rawTotal", + "taxStatus" + ] + }, + "Category": { + "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}$" }, - "modified": { - "type": "boolean", - "description": "It signifies any changes to cart." + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of category's version." + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent category." + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent category's version." + }, + "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}$", + "description": "Unique identity of the category's version under which the new category is to be created." + }, + "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, + "description": "Breadcrumbs offer the users on the website the option to quickly find their way back to the homepage or another level of the website using internal links." }, - "customerComment": { - "description": "A comment that can be added to the cart.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "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 }, - "affiliateCode": { - "description": "An affiliate tracking code", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true }, - "campaignCode": { - "description": "A campaign tracking code", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "childCount": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "Number of categories below the main category." }, - "apiAlias": { + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string", "enum": [ - "cart" + "page", + "link", + "folder" ] }, - "id": { - "description": "Unique identity of cart." - } - }, - "required": [ - "price", - "apiAlias" - ] - }, - "CartItemsUpdate": { - "type": "object", - "required": [ - "items" - ], - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartLineItemUpdate" - } - } - } - }, - "CartLineItemUpdate": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, - "type": { - "$ref": "#/components/schemas/OrderLineItem/properties/type" + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" }, - "quantity": { - "type": "integer" + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" }, - "referencedId": { - "type": "string" + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" }, - "label": { - "type": "string" + "name": { + "type": "string", + "description": "Name of the category." }, - "payload": { - "type": "object" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "stackable": { - "type": "boolean" + "linkType": { + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ], + "description": "linkType : `external`, `category`, `product`, `landing_page`." }, - "removable": { - "type": "boolean" + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "When a particular category is clicked, it gets redirected to internal link." }, - "coverId": { + "externalLink": { + "type": "string", + "description": "When a particular category is clicked, it gets redirected to external link." + }, + "linkNewTab": { + "type": "boolean", + "description": "Category opens in a new tab of the browser." + }, + "description": { + "type": "string", + "description": "Information about the category." + }, + "metaTitle": { + "type": "string", + "description": "A page title indexed by search engines and appears in search results listings." + }, + "metaDescription": { + "type": "string", + "description": "A short description of the page for search results listings." + }, + "keywords": { + "type": "string", + "description": "Keywords that help to search the category." + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS page's version." + }, + "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" }, - "priceDefinition": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object", + "additionalProperties": true, "properties": { - "type": { - "type": "string" - }, - "price": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "quantity": { - "type": "integer" - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "type": "number" - }, - "taxRules": { + "breadcrumb": { "type": "array", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number" - }, - "percentage": { - "type": "number" - } - } + "type": "string" } } + }, + "required": [ + "breadcrumb" + ], + "description": "Contains the translations of all translated fields." + }, + "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": [ + "category" + ] } - } + }, + "type": "object" }, - "ContextMeasurementSystemInfo": { + "CookieEntry": { "type": "object", - "description": "Configuration of the measurement system used in the store, by default including units for length and weight.", "properties": { - "system": { + "cookie": { + "type": "string" + }, + "value": { + "type": "string" + }, + "expiration": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "apiAlias": { "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." - } - } + "cookie_entry" + ] } - } + }, + "required": [ + "cookie", + "hidden", + "apiAlias" + ] }, - "AccountNewsletterRecipient": { + "CartListPrice": { "type": "object", + "description": "", "properties": { - "status": { - "$ref": "#/components/schemas/NewsletterStatus" + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" }, "apiAlias": { "type": "string", "enum": [ - "account_newsletter_recipient" + "cart_list_price" ] } }, "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" - }, - { - "type": "null" - } - ] - } - } - } + "CustomerAddressBody": { + "description": "Added since version: 6.0.0.0", + "required": [ + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { - "filter": { - "properties": { - "type": { - "description": "To filter the results and aggregations with filter types like ==, >=, etc." - }, - "field": { - "description": "To filter the results and aggregations by field like an property identifier." - }, - "value": { - "description": "To filter the results and aggregations by value." - } - } + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sort": { - "properties": { - "field": { - "description": "Sort the search results by field like an property identifier." - }, - "order": { - "description": "Sort the search results of orders by ascending or descending." - }, - "naturalSorting": { - "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." - } - } + "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" }, - "post-filter": { + "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": { - "type": { - "description": "To filter only the results but not the aggregations with filter types like ==, >=, etc." - }, - "field": { - "description": "To filter only the results but not the aggregations by field like an property identifier." + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." }, - "value": { - "description": "To filter only the results but not the aggregations by value." + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } } } } }, - "CartPriceQuantity": { + "CustomerAddressRead": { "type": "object", "properties": { - "apiAlias": { + "id": { "type": "string", - "enum": [ - "cart_price_quantity" - ] - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "price": { - "type": "number" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true }, - "quantity": { - "type": "number" + "createdAt": { + "type": "string", + "format": "date-time" }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" + "updatedAt": { + "oneOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - }, - "type": "object" + ] }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "oneOf": [ + { + "$ref": "#/components/schemas/CountryState" + }, + { + "type": "null" } - } + ] }, - "type": { - "type": "string" + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "required": [ - "apiAlias" + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" ] }, - "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" + "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" + ] + } + } + } + } + } + }, + { + "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}$" }, - { - "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.", - "oneOf": [ - { - "type": "string" + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ] - } - } - }, - "CartDelivery": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { + "cmsPageVersionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "latest": { + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", "type": "string", - "format": "date-time" - } - } - }, - "location": { - "type": "object", - "properties": { - "apiAlias": { + "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", - "enum": [ - "cart_delivery_shipping_location" - ] + "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", + "type": "string" }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" + "ean": { + "description": "Indicates EAN of the product.", + "type": "string" }, - "state": { - "$ref": "#/components/schemas/CountryState" - } - } - }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } - }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - }, - "Association": { - "additionalProperties": { - "$ref": "#/components/schemas/Association" - } - }, - "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" - } - }, - "id": { - "description": "Unique identity of product detail response." - }, - "available": { - "description": "When boolean value is true, the product is available for purchase." - }, - "isCloseout": { - "description": "Boolean value to check if the product is still buyable when stock value is 0." - }, - "displayGroup": { - "description": "Internal field." - }, - "manufacturerNumber": { - "description": "Unique number of the product manufacturer." - }, - "stock": { - "description": "Quantity of product available." - }, - "sortedProperties": { - "description": "Properties of the product that are sorted" - } - }, - "required": [ - "product" - ] - }, - "Criteria": { - "type": "object", - "description": "Criteria to query entities.", - "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" - } - ] - }, - "properties": { - "type": { - "description": "To filter the results and aggregations with filter types like ==, >=, etc." + "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" }, - "field": { - "description": "To filter the results and aggregations by field like an property identifier." + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" }, - "value": { - "description": "To filter the results and aggregations by value." - } - } - }, - "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" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - }, - "properties": { - "type": { - "description": "To filter only the results but not the aggregations with filter types like ==, >=, etc." + "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" }, - "field": { - "description": "To filter only the results but not the aggregations by field like an property identifier." + "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" }, - "value": { - "description": "To filter only the results but not the aggregations by value." - } - } - }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" - }, - "properties": { - "field": { - "description": "Sort the search results by field like an property identifier." + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" }, - "order": { - "description": "Sort the search results of orders by ascending or descending." + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" }, - "naturalSorting": { - "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." - } - } - }, - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" - } - }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" - } - }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" - }, - "includes": { - "$ref": "#/components/schemas/Includes" - }, - "excludes": { - "$ref": "#/components/schemas/Excludes" - } - } - }, - "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": { - "page": { - "description": "Search result page", - "type": "integer" - }, - "term": { - "description": "Search term", - "type": "string" - }, - "limit": { - "description": "Number of items per result page", - "type": "integer" - }, - "filter": { - "type": "array", - "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - }, - "ids": { - "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" + "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}$" }, - { - "$ref": "#/components/schemas/EqualsFilter" + "readOnly": true + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "readOnly": true + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - }, - "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": [ - { - "$ref": "#/components/schemas/AggregationEntity" + "readOnly": true + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationFilter", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationFilter" + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationTerms", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationTerms" + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationHistogram", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationHistogram" + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationRange", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationRange" + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - } - ] - }, - "SubAggregations": { - "type": "object", - "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" + "metaDescription": { + "type": "string" }, - { - "$ref": "#/components/schemas/AggregationEntity" + "name": { + "type": "string" }, - { - "$ref": "#/components/schemas/AggregationFilter" + "keywords": { + "type": "string" }, - { - "$ref": "#/components/schemas/AggregationTerms" + "description": { + "type": "string" }, - { - "$ref": "#/components/schemas/AggregationHistogram" + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true }, - { - "$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" - }, - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" + "metaTitle": { + "type": "string" }, - { - "$ref": "#/components/schemas/EqualsFilter" + "packUnit": { + "type": "string" }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "packUnitPlural": { + "type": "string" }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - }, - "additionalProperties": true - }, - "Sort": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - }, - "naturalSorting": { - "type": "boolean" - }, - "type": { - "type": "string" - } - }, - "required": [ - "field", - "order" - ] - }, - "Filters": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - }, - "SimpleFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" - ] - }, - "field": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "type", - "field", - "value" - ] - }, - "EqualsFilter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "equals" - ] - }, - "field": { - "type": "string" - }, - "value": { - "oneOf": [ - { + "customFields": { + "type": "object" + }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { "type": "string" }, - { - "type": "number" + "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" + }, + "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" }, - { - "type": "null" + "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" + }, + "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" } - }, - "required": [ - "type", - "field", - "value" ] }, - "MultiNotFilter": { + "CrossSellingElement": { "type": "object", "properties": { - "type": { + "crossSelling": { + "$ref": "#/components/schemas/ProductCrossSelling" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "total": { + "type": "integer", + "format": "int32" + }, + "streamId": { "type": "string", - "enum": [ - "multi", - "not" - ] + "format": "uuid" }, - "operator": { + "apiAlias": { "type": "string", "enum": [ - "and", - "or", - "nor", - "nand" + "cross_selling_element" ] - }, - "queries": { - "$ref": "#/components/schemas/Filters" } }, "required": [ - "type", - "operator", - "queries" + "crossSelling", + "products", + "total", + "apiAlias" ] }, - "RangeFilter": { - "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": { - "type": { + "id": { "type": "string", - "enum": [ - "range" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product." }, - "field": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the parent product." + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the parent product's version." + }, + "manufacturerId": { + "description": "Unique identity of the manufacturer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's manufacturer version." + }, + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "description": "Unique identifier of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identifier of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identifier of product's media version." + }, + "deliveryTimeId": { + "description": "Unique identifier of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "description": "Unique identifier of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "description": "Unique identifier of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identifier of CMS page's version." + }, + "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" }, - "parameters": { - "type": "object", - "properties": { - "gte": { - "type": "number" - }, - "gt": { - "type": "number" - }, - "lte": { - "type": "number" - }, - "lt": { - "type": "number" - } - } - } - }, - "required": [ - "type", - "field", - "parameters" - ] - }, - "CookieGroup": { - "type": "object", - "properties": { - "isRequired": { + "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" }, - "name": { - "type": "string" + "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": "Indicate the number of product/s currently in stock. As soon as the order status of an order is set to completed, the stock is reduced.", + "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" }, - "description": { - "type": "string" + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" }, - "cookie": { - "type": "string" + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" }, - "value": { - "type": "string" + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" }, - "expiration": { - "type": "integer" + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" }, - "entries": { - "$ref": "#/components/schemas/CookieEntryCollection" + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" }, - "apiAlias": { + "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", - "enum": [ - "cookie_group" - ] - } - }, - "not": { - "allOf": [ - { - "required": [ - "cookie" - ] - }, - { - "required": [ - "entries" - ] - } - ] - }, - "required": [ - "name", - "isRequired", - "apiAlias" - ] - }, - "CartDeliveryPosition": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } + "format": "date-time" }, - "identifier": { - "type": "string" + "ratingAverage": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "number", + "format": "float", + "readOnly": true }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - }, - "ReferencePrice": { - "type": "object", - "properties": { - "purchaseUnit": { - "type": "number" + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." }, - "referenceUnit": { - "type": "number" + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." }, - "unitName": { - "type": "string" + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." }, - "price": { - "type": "number" + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/ListPrice" - }, - { - "type": "null" - } - ] + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - } - }, - { - "type": "null" - } - ] + "sales": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "hasRange": { - "type": "boolean" + "metaDescription": { + "type": "string", + "description": "A short description of the product for search results listings." }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" - }, - { - "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" - } - } - } - }, - { - "$ref": "#/components/schemas/EntitySearchResult" - } - ] + "name": { + "type": "string", + "description": "Name of the product." }, - "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", - "description": "Unique identity of the customer." - }, - "salesChannelId": { - "type": "string", - "description": "Unique identity of the sales channel." - } - } + "keywords": { + "type": "string", + "description": "Keywords that give additional information about the Product." }, - "products": { - "$ref": "#/components/schemas/ProductListingResult" - } - } - }, - "Sitemap": { - "type": "object", - "properties": { - "filename": { + "description": { "type": "string", - "description": "Name of the file which holds a list of all URL's." + "description": "Description of the product." }, - "created": { + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", "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" + "readOnly": true }, - "percentage": { - "type": "number" + "metaTitle": { + "type": "string", + "description": "A page title indexed by search engines and appears in search results listings." }, - "price": { - "type": "number" + "packUnit": { + "type": "string", + "description": "Type of packing. For example, bottle, tin, crate, etc." }, - "apiAlias": { + "packUnitPlural": { "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" + "description": "Type of packing in plural. For example, bottles, tins, crates, etc." }, - "quantity": { - "type": "number" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "rawTotal": { - "type": "number" + "ogTitle": { + "type": "string" }, - "totalPrice": { - "type": "number" + "ogDescription": { + "type": "string" }, - "taxStatus": { + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", "enum": [ - "net", - "tax-free" + "physical", + "digital" ] }, - "calculatedTaxes": { + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true, + "description": "Internal field." + }, + "calculatedPrice": { + "type": "object", + "$ref": "#/components/schemas/CalculatedPrice", + "description": "Runtime field, cannot be used as part of the criteria." + }, + "calculatedPrices": { "type": "array", "items": { "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" + "additionalProperties": false, + "allOf": [ + { + "$ref": "#/components/schemas/CalculatedPrice" } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" ] - } + }, + "description": "Runtime field, cannot be used as part of the criteria." }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + "calculatedMaxPurchase": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" + "calculatedCheapestPrice": { + "type": "object", + "properties": { + "unitPrice": { + "type": "number" }, - { - "type": "null" - } - ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" - }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" + "quantity": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ReferencePrice" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" + { + "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" } - } + ] }, - { - "type": "null" + "apiAlias": { + "type": "string", + "enum": [ + "calculated_cheapest_price" + ] } - ] + }, + "description": "Runtime field, cannot be used as part of the criteria." }, - "hasRange": { + "isNew": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "sortedProperties": { + "type": "object" }, - "apiAlias": { + "measurements": { + "type": "object", + "$ref": "#/components/schemas/ProductMeasurements" + }, + "createdAt": { "type": "string", - "enum": [ - "calculated_price" - ] + "format": "date-time", + "readOnly": true }, - "taxRules": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + }, + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", - "description": "Currently active tax rules and/or rates", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "$ref": "#/components/schemas/ProductDownload" } - } - }, - "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" + "parent": { + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, - "percentage": { - "type": "number" + "children": { + "description": "Product variants that inherit from this parent product", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "price": { - "type": "number" + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Time taken for the product to reach the customer. If a delivery time is defined in the product, it overwrites the delivery time of a shipping method." }, - "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}$" + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unit": { + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, - "firstName": { - "type": "string" + "cover": { + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, - "lastName": { - "type": "string" + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" }, - "zipcode": { - "type": "string" + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" }, - "city": { - "type": "string" + "canonicalProduct": { + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" }, - "company": { - "type": "string" + "media": { + "description": "Product images and media gallery", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } }, - "street": { - "type": "string" + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } }, - "department": { - "type": "string" + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } }, - "title": { - "type": "string" + "productReviews": { + "description": "Customer reviews and ratings for the product", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } }, - "phoneNumber": { - "type": "string" + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } }, - "additionalAddressLine1": { - "type": "string" + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } }, - "additionalAddressLine2": { - "type": "string" + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } }, - "customFields": { - "type": "object" + "properties": { + "description": "Product properties and characteristics for filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } }, - "country": { - "$ref": "#/components/schemas/Country" + "categories": { + "description": "Categories this product is assigned to", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - "countryState": { - "$ref": "#/components/schemas/CountryState" + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } }, - "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." + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - "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." - } + "tags": { + "description": "Tags for organizing and filtering products", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" } - } - } - }, - "CustomerAddressRead": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "seoCategory": { + "$ref": "#/components/schemas/Category", + "description": "Main category used for SEO URL generation in the current sales channel" }, - "createdAt": { + "apiAlias": { "type": "string", - "format": "date-time" - }, - "updatedAt": { - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } + "enum": [ + "product" ] }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { + "variantListingConfig": { "oneOf": [ { - "$ref": "#/components/schemas/CountryState" + "type": "object", + "properties": { + "displayParent": { + "type": "boolean" + } + } }, { "type": "null" } ] }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" - ] - }, - "CrossSellingElement": { - "type": "object", - "properties": { - "crossSelling": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "total": { - "type": "integer", - "format": "int32" - }, - "streamId": { - "type": "string", - "format": "uuid" + "mainVariantId": { + "description": "Unique identity of main variant." }, - "apiAlias": { - "type": "string", - "enum": [ - "cross_selling_element" - ] + "externalReference": { + "description": "External payment provider token." } }, - "required": [ - "crossSelling", - "products", - "total", - "apiAlias" - ] + "type": "object" }, "SalesChannelContext": { "type": "object", @@ -16099,6 +16028,82 @@ } } }, + "CustomerGroup": { + "description": "Added since version: 6.0.0.0", + "required": [ + "translated", + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the customer's group." + }, + "name": { + "type": "string", + "description": "Name of the customer group." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "type": "boolean" + }, + "registrationTitle": { + "type": "string", + "description": "Title defined for the customer group during registration." + }, + "registrationIntroduction": { + "type": "string", + "description": "A brief description about the registration." + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean", + "description": "Register as a company rather than as a private customer group." + }, + "registrationSeoMetaDescription": { + "type": "string", + "description": "A short description of the registration page for search results listings." + }, + "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" + } + }, + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, "NavigationRouteResponse": { "type": "array", "items": { @@ -20780,6 +20785,16 @@ } } } + }, + "400": { + "description": "The customer is not a guest customer.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } } }, "security": [