diff --git a/storeapi.json b/storeapi.json index 8c62fac..65b3c60 100644 --- a/storeapi.json +++ b/storeapi.json @@ -366,1182 +366,990 @@ "type": "object", "additionalProperties": false }, - "AclRole": { - "description": "Added since version: 6.0.0.0", + "BreadcrumbCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Breadcrumb" + } + }, + "CartPriceReference": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of ACL role." + "purchaseUnit": { + "type": "number" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "referenceUnit": { + "type": "number" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "App": { - "description": "Added since version: 6.3.1.0", - "required": [ - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of App." + "unitName": { + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "price": { + "type": "number" }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "const": "cart_price_reference" }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - } - }, - "type": "object" - }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", - "required": [ - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app's action button." + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "cart_regulation_price" + } + } + }, + { + "type": "null" + } + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "hasRange": { + "type": "boolean" }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] } }, - "type": "object" - }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", "required": [ - "value", - "appId", - "localeId" - ], + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CrossSellingElement": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app snippet." - }, - "value": { - "type": "string", - "description": "Value of App Administration Snippet." + "crossSelling": { + "$ref": "#/components/schemas/ProductCrossSelling" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app in app snippet." + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity that specifies the language and country." + "total": { + "type": "integer", + "format": "int32" }, - "createdAt": { + "streamId": { "type": "string", - "format": "date-time", - "readOnly": true + "format": "uuid" }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "const": "cross_selling_element" } }, - "type": "object" - }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", "required": [ - "label" - ], + "crossSelling", + "products", + "total", + "apiAlias" + ] + }, + "Breadcrumb": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app's CMS block." + "name": { + "type": "string" }, - "createdAt": { + "categoryId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "type": { + "$ref": "#/components/schemas/Category/properties/type" }, "translated": { "type": "object", - "description": "Contains the translations of all translated fields." + "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" + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "apiAlias": { + "type": "string", + "const": "breadcrumb" } }, - "type": "object" - }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", "required": [ - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app's flow action." - }, - "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" + "name", + "categoryId", + "type", + "translated", + "path", + "apiAlias" + ] }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", + "ProductListingFlags": { + "type": "object", + "description": "Additional flags for product listings", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of App flow event." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + ] } - }, - "type": "object" + } }, - "AppMcpPrompt": { - "description": "Added since version: 6.7.11.0", - "required": [ - "label" - ], + "Criteria": { + "type": "object", + "description": "Criteria to query entities.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "page": { + "description": "Search result page", + "type": "integer" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "term": { + "description": "Search term", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "AppMcpResource": { - "description": "Added since version: 6.7.11.0", - "required": [ - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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." + }, + "field": { + "description": "To filter the results and aggregations by field like an property identifier." + }, + "value": { + "description": "To filter the results and aggregations by value." + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } }, - "updatedAt": { + "query": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "The query string to search for" }, - "translated": { - "type": "object" - } - }, - "type": "object" - }, - "AppMcpTool": { - "description": "Added since version: 6.7.11.0", - "required": [ - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "associations": { + "$ref": "#/components/schemas/Associations" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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." + }, + "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." + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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." + }, + "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" - } - }, - "type": "object" - }, - "AppPaymentMethod": { - "description": "Added since version: 6.4.1.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app's payment method." + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "AppScriptCondition": { - "description": "Added since version: 6.4.10.3", - "required": [ - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app's script condition." + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "total-count-mode": { + "$ref": "#/components/schemas/TotalCountMode" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "includes": { + "$ref": "#/components/schemas/Includes" }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "excludes": { + "$ref": "#/components/schemas/Excludes" } - }, - "type": "object" + } }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", + "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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "page": { + "description": "Search result page", + "type": "integer" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "term": { + "description": "Search term", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of App template." + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + ] + } }, - "updatedAt": { + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "query": { "type": "string", - "format": "date-time", - "readOnly": true + "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", + "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" } - }, - "type": "object" + } }, - "CategoryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ + "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/resource" + "$ref": "#/components/schemas/AggregationMetrics" }, { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" }, - "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 + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true + { + "$ref": "#/components/schemas/AggregationEntity" }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true + { + "$ref": "#/components/schemas/AggregationFilter" }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string", - "enum": [ - "page", - "link", - "folder" - ] + { + "$ref": "#/components/schemas/AggregationTerms" }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" + { + "$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" }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" + { + "$ref": "#/components/schemas/MultiNotFilter" }, - "name": { + { + "$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": [ + { "type": "string" }, - "customFields": { - "type": "object" - }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" + { + "type": "number" }, - "linkNewTab": { + { "type": "boolean" }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customEntityTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true - }, - "seoUrl": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "description": "Unique identity of category.", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } - } - }, - "type": "object" - }, - "children": { - "description": "Child categories within this category for hierarchical navigation", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } - } - } - }, - "type": "object" - }, - "media": { - "description": "Category image or banner", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/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 and filtering categories", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } - } - } - } - }, - "type": "object" - }, - "cmsPage": { - "description": "CMS page layout for the category", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/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 category across different sales channels", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + { + "type": "null" } - }, - "type": "object" + ] + } + }, + "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" ] }, - "CountryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] }, - { - "required": [ - "id", - "name", - "addressFormat" - ], + "field": { + "type": "string" + }, + "parameters": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "gte": { + "type": "number" }, - "name": { - "type": "string" + "gt": { + "type": "number" }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", - "type": "string" + "lte": { + "type": "number" }, - "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" + "lt": { + "type": "number" } - }, - "type": "object" + } } + }, + "required": [ + "type", + "field", + "parameters" ] }, - "Country": { + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of app's payment method." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ + "translated", "id", - "name", - "addressFormat" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the country." + "description": "Unique identity of the customer's group." }, "name": { "type": "string", - "description": "Name of the country." - }, - "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" + "description": "Name of the customer group." }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "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" }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", - "type": "string" + "registrationTitle": { + "type": "string", + "description": "Title defined for the customer group during registration." }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" + "registrationIntroduction": { + "type": "string", + "description": "A brief description about the registration." }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" + "registrationOnlyCompanyRegistration": { + "type": "boolean", + "description": "Register as a company rather than as a private customer group." }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" + "registrationSeoMetaDescription": { + "type": "string", + "description": "A short description of the registration page for search results listings." }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "customFields": { + "translated": { "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], "properties": { - "enabled": { - "type": "boolean", - "description": "The boolean value is `true` if the tax for the customer apply." + "name": { + "type": "string" }, - "currencyId": { - "type": "string", - "description": "Unique identity of currency." + "registrationIntroduction": { + "type": "string" }, - "amount": { - "type": "number", - "format": "float", - "description": "Sum of money to be paid by the customer." + "registrationSeoMetaDescription": { + "type": "string" + }, + "registrationTitle": { + "type": "string" } }, - "type": "object" - }, - "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" - }, - "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", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object", "description": "Contains the translations of all translated fields." - }, - "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`." - }, - "companyTaxFree": { - "description": "When a registered company is free from paying taxes, then the boolean value is `true`." } }, "type": "object" }, - "CountryStateJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "countryId", - "shortCode", - "name" - ], + "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": { - "id": { + "unit": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" }, - "countryId": { - "description": "Unique identity of the country.", + "value": { + "type": "number" + } + } + }, + "height": { + "type": "object", + "properties": { + "unit": { "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" + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" }, - "createdAt": { + "value": { + "type": "number" + } + } + }, + "length": { + "type": "object", + "properties": { + "unit": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm" }, - "updatedAt": { + "value": { + "type": "number" + } + } + }, + "weight": { + "type": "object", + "properties": { + "unit": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg" }, - "translated": { - "type": "object" + "value": { + "type": "number" } - }, - "type": "object" + } } - ] + } }, - "CountryState": { + "ProductStream": { "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." - }, - "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" + "description": "Unique identity of product stream." }, "name": { "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" + "description": "Name of the Dynamic Group to be created." }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" + "description": { + "type": "string", + "description": "Description of the Dynamic group to be created." }, "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", "format": "date-time", @@ -1559,253 +1367,114 @@ }, "type": "object" }, - "CurrencyJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "CartError": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "key": { + "type": "string" }, - { - "required": [ - "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" - }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", - "type": "string" - }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" - }, - "shortName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" - }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" - }, - "customFields": { - "type": "object" - }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - } - }, - "type": "object" + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" } + }, + "required": [ + "key", + "level", + "message", + "messageKey" ] }, - "Currency": { + "Document": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "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" + "description": "Unique identity of document." }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of document type." }, - "shortName": { + "referencedDocumentId": { "type": "string", - "description": "Acronym for international currencies. For example, USD." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of reference document." }, - "name": { + "orderId": { "type": "string", - "description": "Full name of the currency. For example, US-Dollar." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the order." }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of document media file." }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the order's version." }, - "customFields": { + "config": { "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." + "name": { + "type": "string" }, - "roundForNet": { - "type": "boolean", - "description": "The cash rounding applied on net prices. " + "title": { + "type": "string" } }, - "type": "object" - }, - "totalRounding": { "required": [ - "decimals", - "interval", - "roundForNet" + "name", + "title" ], - "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": "Specifies detailed information about how the component is to be rendered." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "sent": { + "type": "boolean", + "description": "When `true`, the document is already sent to the customer." }, - "updatedAt": { + "static": { + "type": "boolean", + "description": "When `true`, the document is uploaded else it is generated by the system." + }, + "deepLinkCode": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "It is a generated special code linked to email. It is used to access details of guest customer actions." }, - "translated": { + "documentNumber": { + "type": "string" + }, + "customFields": { "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." + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -1816,59 +1485,275 @@ "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "CustomEntity": { - "description": "Added since version: 6.4.9.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a custom entity." }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "updatedAt": { + "order": { + "$ref": "#/components/schemas/Order" + }, + "referencedDocument": { + "$ref": "#/components/schemas/Document" + }, + "dependentDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "fileType": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Type of file like PDF." } }, "type": "object" }, - "CustomField": { - "description": "Added since version: 6.0.0.0", + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a custom field." + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } }, - "createdAt": { + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "const": "cart_delivery_shipping_location" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "ProductListingResult": { + "allOf": [ + { + "$ref": "#/components/schemas/EntitySearchResult" + }, + { + "type": "object", + "properties": { + "currentFilters": { + "type": "object", + "description": "Contains the state of the filters. These can be used to create listing filters.", + "properties": { + "navigationId": { + "type": "string" + }, + "manufacturer": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "price": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "default": 0 + }, + "max": { + "type": "integer", + "default": 0 + } + }, + "required": [ + "min", + "max" + ] + }, + "rating": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ] + }, + "shipping-free": { + "type": "boolean", + "default": false + }, + "properties": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "search": { + "type": "string" + } + }, + "required": [ + "manufacturer", + "navigationId", + "price", + "properties", + "rating", + "shipping-free" + ] + }, + "availableSortings": { + "type": "array", + "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "translated": { + "type": "object", + "properties": { + "label": { + "type": "string" + } + }, + "required": [ + "label" + ] + }, + "key": { + "type": "string" + }, + "priority": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "product_sorting" + } + }, + "required": [ + "label", + "translated", + "key", + "priority", + "apiAlias" + ] + } + }, + "sorting": { + "type": "string" + }, + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "entity": { + "type": "string", + "enum": [ + "product" + ] + }, + "apiAlias": { + "type": "string", + "const": "product_listing" + } + }, + "required": [ + "elements", + "availableSortings", + "currentFilters", + "apiAlias" + ] + } + ] + }, + "ProductPurchaseLimit": { + "type": "object", + "description": "Current quantity purchase limits for a product.", + "required": [ + "productId", + "minPurchase", + "purchaseSteps", + "maxPurchase", + "stock", + "apiAlias" + ], + "properties": { + "productId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "The product ID." }, - "updatedAt": { + "minPurchase": { + "type": "integer", + "description": "Minimum quantity a customer can purchase." + }, + "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 + "const": "product_purchase_limit" } - }, - "type": "object" + } }, - "CustomFieldSet": { + "ProductPrice": { "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." + "description": "Unique identity of the product's price." }, "createdAt": { "type": "string", @@ -1883,13 +1768,13 @@ }, "type": "object" }, - "CustomFieldSetRelation": { + "NumberRangeSalesChannel": { "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." + "description": "Unique identity of Sales channels's number rage." }, "createdAt": { "type": "string", @@ -1904,278 +1789,54 @@ }, "type": "object" }, - "CustomerAddressJsonApi": { + "ShippingMethodPrice": { "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "required": [ + "id", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of shipping method price." }, - { - "required": [ - "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "description": "Unique identity of customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of country's state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "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.", - "type": "string" - }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "customFields": { - "type": "object" - }, - "isDefaultBillingAddress": { - "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "isDefaultShippingAddress": { - "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "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" - } - }, - "type": "object" - } - ] - }, - "CustomerRecovery": { - "description": "Added since version: 6.1.0.0", - "properties": { - "id": { + "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer recovery account." + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "ruleId": { + "description": "Unique identity of rule.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "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 customer tag." + "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", + "type": "integer", + "format": "int64" }, - "customerId": { + "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer." + "pattern": "^[0-9a-f]{32}$" }, - "tagId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the tag." + "quantityStart": { + "description": "Starting range of quantity of an item.", + "type": "number", + "format": "float" }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "CustomerWishlist": { - "description": "Added since version: 6.3.4.0", - "required": [ - "id", - "customerId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer's wishlist." + "quantityEnd": { + "description": "Ending range of quantity of an item.", + "type": "number", + "format": "float" }, - "customerId": { - "description": "Unique identity of the customer.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "currencyPrice": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + }, + "description": "Contains currency-based price." }, "customFields": { "type": "object", @@ -2190,767 +1851,488 @@ "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" - ], + "ContextMeasurementSystemInfo": { + "type": "object", + "description": "Configuration of the measurement system used in the store, by default including units for length and weight.", "properties": { - "id": { + "system": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "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", - "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": { - "type": "string", - "format": "date-time", - "readOnly": true + "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." + } + } } - }, - "type": "object" + } }, - "DeliveryTime": { - "description": "Added since version: 6.0.0.0", + "Product": { + "description": "Represents a product along with detailed information required to display a variant selection.", "required": [ + "apiAlias", + "calculatedPrice", + "calculatedPrices", + "seoCategory", + "type", + "translated", "id", - "name", - "min", - "max", - "unit" + "taxId", + "productNumber", + "stock", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of delivery time." + "description": "Unique identity of the product." }, - "name": { + "versionId": { "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" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the parent product." }, - "createdAt": { + "parentVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the parent product's version." }, - "updatedAt": { + "manufacturerId": { + "description": "Unique identity of the manufacturer.", "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" - }, - "DocumentBaseConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "name" - ], - "properties": { - "id": { + "productManufacturerVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the document base config." + "description": "Unique identity of the product's manufacturer version." }, - "documentTypeId": { - "description": "Unique identity of the document type.", + "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "logoId": { - "description": "Unique identity of the company logo.", + "taxId": { + "description": "Unique identifier of tax.", "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": { + "coverId": { + "description": "Unique identifier of a ProductMedia item used as product cover.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "logo": { - "$ref": "#/components/schemas/Media", - "description": "Logo in the document at the top-right corner." - } - }, - "type": "object" - }, - "DocumentBaseConfigSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentBaseConfigId" - ], - "properties": { - "id": { + "productMediaVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document's base config sales channel." + "description": "Unique identifier of product's media version." }, - "documentBaseConfigId": { - "description": "Unique identity of document's base config.", + "deliveryTimeId": { + "description": "Unique identifier of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "canonicalProductId": { + "description": "Unique identifier of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "description": "Unique identity of document type.", + "canonicalProductVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "cmsPageId": { + "description": "Unique identifier of CMS page.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "DocumentType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "technicalName", - "name" - ], - "properties": { - "id": { + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the document type." + "description": "Unique identifier of CMS page's version." }, - "name": { + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", "type": "string", - "description": "Name of the document type." + "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "description": "Technical name of document type.", + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "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 + "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" }, - "updatedAt": { - "type": "string", - "format": "date-time", + "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 }, - "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", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of flow." + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" }, - "createdAt": { - "type": "string", - "format": "date-time", + "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 }, - "updatedAt": { + "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", - "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": { + "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", + "format": "date-time" + }, + "ratingAverage": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "number", + "format": "float", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "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." }, - "createdAt": { - "type": "string", - "format": "date-time", + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "sales": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64", "readOnly": true }, - "updatedAt": { + "metaDescription": { "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "ImportExportFile": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "description": "A short description of the product for search results listings." + }, + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of import-export file." + "description": "Name of the product." }, - "createdAt": { + "keywords": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Keywords that give additional information about the Product." }, - "updatedAt": { + "description": { + "type": "string", + "description": "Description of the product." + }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", "type": "string", - "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "ImportExportLog": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + }, + "metaTitle": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of import-export log." + "description": "A page title indexed by search engines and appears in search results listings." }, - "createdAt": { + "packUnit": { "type": "string", - "format": "date-time", - "readOnly": true + "description": "Type of packing. For example, bottle, tin, crate, etc." }, - "updatedAt": { + "packUnitPlural": { "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." + "description": "Type of packing in plural. For example, bottles, tins, crates, etc." }, - "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 + "ogTitle": { + "type": "string" }, - "translated": { - "type": "object" + "ogDescription": { + "type": "string" }, - "Integration": { - "description": "Unique identity of integration." - } - }, - "type": "object" - }, - "Integration": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { + "type": { + "description": "The type of the product, e.g., physical or digital.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "physical", + "digital" + ] }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true, + "description": "Internal field." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "LandingPageJsonApi": { - "description": "Added since version: 6.4.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "calculatedPrice": { + "type": "object", + "$ref": "#/components/schemas/CalculatedPrice", + "description": "Runtime field, cannot be used as part of the criteria." }, - { - "required": [ - "id", - "name", - "url" - ], + "calculatedPrices": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "allOf": [ + { + "$ref": "#/components/schemas/CalculatedPrice" + } + ] + }, + "description": "Runtime field, cannot be used as part of the criteria." + }, + "calculatedMaxPurchase": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "calculatedCheapestPrice": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "url": { - "type": "string" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "type": "number" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "number" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "totalPrice": { + "type": "number" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ReferencePrice" + }, + { + "type": "null" + } + ] }, - "translated": { - "type": "object" + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ListPrice" + }, + { + "type": "null" + } + ] }, - "relationships": { - "properties": { - "cmsPage": { - "description": "CMS page layout for the landing page", + "regulationPrice": { + "oneOf": [ + { + "type": "object", "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" - } - } + "price": { + "type": "number" } }, - "type": "object" + "required": [ + "price" + ] }, - "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": "null" } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "LanguageJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "localeId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "localeId": { - "description": "Unique identity of locale.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationCodeId": { - "description": "Unique identity of translation code.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the language.", - "type": "string" + ] }, - "active": { + "hasRange": { "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" + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "" }, - "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": "null" } - }, - "type": "object" + ] + }, + "apiAlias": { + "type": "string", + "const": "calculated_cheapest_price" } }, - "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 language." - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent language." - }, - "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" + "description": "Runtime field, cannot be used as part of the criteria." }, - "active": { + "isNew": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "customFields": { + "sortedProperties": { + "type": "object" + }, + "measurements": { "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "$ref": "#/components/schemas/ProductMeasurements" }, "createdAt": { "type": "string", @@ -2962,57 +2344,183 @@ "format": "date-time", "readOnly": true }, - "parent": { - "$ref": "#/components/schemas/Language", - "description": "Unique identity of language." + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." }, - "locale": { - "$ref": "#/components/schemas/Locale", - "description": "Locale defining regional settings (date, time, number formats)" + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } }, - "translationCode": { - "$ref": "#/components/schemas/Locale", - "description": "Locale used for translating content" + "parent": { + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, "children": { - "description": "Child languages inheriting from this parent language", + "description": "Product variants that inherit from this parent product", "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Product" } - } - }, - "type": "object" - }, - "Locale": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "code", - "name", - "territory" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "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 locale. For example: English." + "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." }, - "territory": { - "type": "string", - "description": "Name of the location. For example: Canada." + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" + }, + "unit": { + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" + }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" + }, + "canonicalProduct": { + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" + }, + "media": { + "description": "Product images and media gallery", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + }, + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + }, + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "productReviews": { + "description": "Customer reviews and ratings for the product", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "properties": { + "description": "Product properties and characteristics for filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "categories": { + "description": "Categories this product is assigned to", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + }, + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "tags": { + "description": "Tags for organizing and filtering products", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "seoCategory": { + "$ref": "#/components/schemas/Category", + "description": "Main category used for SEO URL generation in the current sales channel" + }, + "apiAlias": { + "type": "string", + "const": "product" + }, + "variantListingConfig": { + "oneOf": [ + { + "type": "object", + "properties": { + "displayParent": { + "type": "boolean" + } + } + }, + { + "type": "null" + } + ] + }, + "mainVariantId": { + "description": "Unique identity of main variant." + }, + "externalReference": { + "description": "External payment provider token." + } + }, + "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", @@ -3023,21 +2531,17 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "LogEntry": { - "description": "Added since version: 6.0.0.0", + "SalesChannelAnalytics": { + "description": "Added since version: 6.2.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of log entry." + "description": "Unique identity of sales channel analytics." }, "createdAt": { "type": "string", @@ -3052,44 +2556,19 @@ }, "type": "object" }, - "MailHeaderFooter": { + "CookieGroupCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CookieGroup" + } + }, + "AclRole": { "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], "properties": { "id": { "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." - }, - "name": { - "type": "string", - "description": "Name of the MailHeaderFooter." - }, - "description": { - "type": "string", - "description": "Description of the MailHeaderFooter." - }, - "headerHtml": { - "type": "string", - "description": "HTML header content." - }, - "headerPlain": { - "type": "string", - "description": "Textual header content." - }, - "footerHtml": { - "type": "string", - "description": "HTML footer content." - }, - "footerPlain": { - "type": "string", - "description": "Textual footer content." + "description": "Unique identity of ACL role." }, "createdAt": { "type": "string", @@ -3100,46 +2579,20 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "MailTemplate": { - "description": "Added since version: 6.0.0.0", + "ProductFeatureSet": { + "description": "Added since version: 6.3.0.0", "required": [ - "subject", - "contentHtml", - "contentPlain" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail template." - }, - "systemDefault": { - "type": "boolean", - "description": "Unused field. To be removed in future." - }, - "senderName": { - "type": "string", - "description": "Name of the sender in the mail." - }, - "contentHtml": { - "type": "string", - "description": "HTML content in the mail." - }, - "contentPlain": { - "type": "string", - "description": "Textual content in the mail." - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "description": "Unique identity of product feature set." }, "createdAt": { "type": "string", @@ -3154,78 +2607,51 @@ "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": { + "MediaThumbnail": { "description": "Added since version: 6.0.0.0", "required": [ + "url", "id", - "mailTemplateId", - "languageId", - "mediaId" + "mediaId", + "width", + "height" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail template's media." + "description": "Unique identity of media thumbnail." }, - "mailTemplateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the mail template." - }, - "languageId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the language." + "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "mediaThumbnailSizeId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media." + "pattern": "^[0-9a-f]{32}$" }, - "position": { + "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", - "description": "The order of multiple media templates defined is specified using numerical values like 1,2,3, etc." + "readOnly": true }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "MailTemplateType": { - "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 mail template type." + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "name": { - "type": "string", - "description": "Name of the mail template." + "url": { + "description": "Public url of media thumbnail.", + "type": "string" }, - "technicalName": { - "description": "Technical name of mail template.", + "path": { "type": "string" }, "customFields": { @@ -3241,106 +2667,17 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "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" - }, - { - "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", + "AppMcpTool": { + "description": "Added since version: 6.7.11.0", "required": [ - "id", - "productId", - "categoryId", - "salesChannelId" + "label" ], "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." - }, - "categoryId": { - "description": "Unique identity of the category.", - "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}$" }, @@ -3353,47 +2690,44 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "MeasurementDisplayUnit": { - "description": "Added since version: 6.7.1.0", + "Tax": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "measurementSystemId", - "default", - "type", - "shortName", - "factor", - "precision" + "taxRate", + "name" ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "measurementSystemId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "default": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "shortName": { - "type": "string" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of tax." }, - "factor": { + "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, - "precision": { + "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", @@ -3403,59 +2737,47 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" - }, - "measurementSystem": { - "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, - "MeasurementSystem": { - "description": "Added since version: 6.7.1.0", - "required": [ - "id", - "technicalName" - ], + "AggregationMetrics": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { + "name": { "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { + "type": { "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] }, - "units": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MeasurementDisplayUnit" - } + "field": { + "type": "string" } }, - "type": "object" + "required": [ + "name", + "type", + "field" + ] }, - "MediaDefaultFolder": { - "description": "Added since version: 6.0.0.0", + "TaxRuleType": { + "description": "Added since version: 6.1.0.0", + "required": [ + "typeName" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media default folder." + "description": "Unique identity of tax rule type." }, "createdAt": { "type": "string", @@ -3466,103 +2788,131 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "MediaFolder": { + "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderDeliveryId", + "orderLineItemId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media folder." + "description": "Unique identity of order delivery position." }, - "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": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media folder configuration." + "description": "Unique identity of OrderDeliveryPosition's version." }, - "createdAt": { + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "MediaTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "mediaId", - "tagId" - ], - "properties": { - "id": { + "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media tag." + "description": "Unique identity of order delivery's version." }, - "mediaId": { + "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media." + "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the tag." + "description": "Unique identity of line item's version in an order." }, - "media": { - "$ref": "#/components/schemas/Media" + "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" }, - "tag": { - "$ref": "#/components/schemas/Tag" - } - }, - "type": "object" - }, - "MediaThumbnailSize": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "width", - "height" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media thumbnail size defined." + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" }, - "width": { - "description": "Width of the thumbnail.", - "type": "integer", - "format": "int64" + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" }, - "height": { - "description": "Height of the thumbnail.", + "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -3583,270 +2933,74 @@ }, "type": "object" }, - "NewsletterRecipientJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - } - ] - }, - "NewsletterRecipient": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of newsletter recipient." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } + "CrossSellingElementCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CrossSellingElement" }, - "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." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "total": { + "description": "Number of cross selling elements found." } - }, - "type": "object" + } }, - "NumberRange": { + "CustomerAddressBody": { "description": "Added since version: 6.0.0.0", "required": [ - "name" + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { - "id": { + "countryId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number range." + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "countryStateId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "salutationId": { "type": "string", - "format": "date-time", - "readOnly": true - }, - "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", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Sales channels's number rage." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "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 number range's state." - }, - "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 number range's type." - }, - "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" - }, - "OrderAddress": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "countryId", - "firstName", - "lastName", - "street", - "city" - ], - "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." - }, - "countryId": { - "description": "Unique identity of country.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$" }, "firstName": { - "description": "First name of the customer.", "type": "string" }, "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "street": { - "description": "Street address", "type": "string" }, "zipcode": { - "description": "Zip code of the country.", "type": "string" }, "city": { - "description": "Name of the city.", "type": "string" }, "company": { - "description": "Name of the company.", + "type": "string" + }, + "street": { "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", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "type": "object" }, "country": { "$ref": "#/components/schemas/Country" @@ -3860,532 +3014,611 @@ }, "type": "object" }, - "OrderCustomer": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "email", - "firstName", - "lastName" - ], + "SalesChannelContext": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order customer." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderCustomer's version." - }, - "email": { - "description": "Email address of the customer.", - "type": "string" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "company": { - "description": "Name of the company.", - "type": "string" - }, - "title": { - "description": "Title name given to the customer like Dr, prof. etc.", + "token": { + "description": "Context the user session", "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Unique identity of VAT." - }, - "customerNumber": { - "description": "Unique number assigned to the customer.", - "type": "string" + "currentCustomerGroup": { + "type": "object", + "description": "Customer group of the current user", + "properties": { + "name": { + "type": "string", + "description": "Name of customer group to which the customer belongs within the specific sales channel they are currently interacting with." + }, + "displayGross": { + "type": "boolean", + "description": "When `true`, product's gross price is displayed for that customer group who belongs to the specific sales channel they are currently interacting with." + } + } }, - "customFields": { + "fallbackCustomerGroup": { + "description": "Fallback group if the default customer group is not applicable", "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "properties": { + "name": { + "type": "string" + }, + "displayGross": { + "type": "boolean" + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "currency": { + "$ref": "#/components/schemas/Currency", + "properties": { + "isoCode": { + "description": "Standard international three digit code to represent currency in a given sales channel. For example, USD." + }, + "factor": { + "description": "Currency exchange rate in a specific sales channel the customer is currently interacting with." + }, + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $ in a given sales channel." + }, + "shortName": { + "description": "Acronym for international currencies, for example, USD in a given sales channel." + }, + "name": { + "description": "Full name of the currency in a given sales channel. For example, US-Dollar." + }, + "position": { + "description": "The order of the tabs for multiple currencies defined in a given sales channel." + }, + "decimalPrecision": { + "description": "It defines the round off value for currency to the nearest decimal point in a given sales channel. If set to 2, it rounds off to two significant decimal points." + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria." + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "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 Order's delivery." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderDelivery's version." - }, - "orderId": { - "description": "Unique identity of order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's version." - }, - "shippingOrderAddressId": { - "description": "Unique identity of order's shipping address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingOrderAddressVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's shipping address version." - }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel", + "properties": { + "typeId": { + "description": "Unique identity of a sales channel's type within a specific sales channel." + }, + "languageId": { + "description": "Unique identity of a sales channel's language within a specific sales channel." + }, + "currencyId": { + "description": "Unique identity of a sales channel's currency within a specific sales channel." + }, + "paymentMethodId": { + "description": "Unique identity of a sales channel's payment method within a specific sales channel." + }, + "shippingMethodId": { + "description": "Unique identity of a sales channel's shipping method within a specific sales channel." + }, + "countryId": { + "description": "Unique identity of a sales channel's country within a specific sales channel." + }, + "navigationCategoryId": { + "description": "Unique identity of a sales channel's navigation category within a specific sales channel." + }, + "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu within a specific sales channel." + }, + "footerCategoryId": { + "description": "Unique identity of a sales channel's footer category within a specific sales channel." + }, + "serviceCategoryId": { + "description": "Unique identity of a sales channel's service category within a specific sales channel." + }, + "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 `true`, the sales channel is enabled." + }, + "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 a sales channel's mail header and footer within a specific sales channel." + }, + "customerGroupId": { + "description": "Unique identity of a sales channel's customer group within a specific sales channel." + }, + "hreflangActive": { + "description": "When `true`, the sales channel pages are available in different languages within a specific sales channel." + }, + "hreflangDefaultDomainId": { + "description": "Unique identity of a sales channel's hreflangDefaultDomain within a specific sales channel." + }, + "analyticsId": { + "description": "Unique identity of a sales channel's analytics within a specific sales channel." + } + } }, - "stateId": { - "description": "Unique identity of state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "measurementSystem": { + "$ref": "#/components/schemas/ContextMeasurementSystemInfo" }, - "trackingCodes": { + "taxRules": { "type": "array", + "description": "Currently active tax rules and/or rates", "items": { - "type": "string" + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "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", - "format": "date-time" - }, - "shippingDateLatest": { - "description": "Date and time of latest delivery of products.", - "type": "string", - "format": "date-time" + "properties": { + "taxRate": { + "description": "Rate of tax within a specific sales channel." + }, + "name": { + "description": "Name defined for a Tax within a specific sales channel." + } + } }, - "shippingCosts": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" + "customer": { + "oneOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/Customer" + } ], "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Shipping cost of product per item (where, quantity=1)." + "groupId": { + "description": "Unique identity of a customer's group within a specific sales channel." }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Shipping cost of product based on quantity." + "defaultPaymentMethodId": { + "description": "Unique identity of a customer's default payment method within a specific sales channel." }, - "quantity": { - "type": "integer", - "format": "int64", - "description": "Number of items of each product." + "salesChannelId": { + "description": "Unique identity of sales channel the customer is currently interacting with." }, - "calculatedTaxes": { - "type": "object", - "description": "Contains calculated taxes based on shipping costs/methods." + "languageId": { + "description": "Unique identity of language within a specific sales channel the customer is interacting." }, - "taxRules": { - "type": "object", - "description": "Pricing based on multiple taxes." + "lastPaymentMethodId": { + "description": "Unique identity of customer's last payment method within a specific sales channel." }, - "referencePrice": { - "type": "object", - "description": "Original cost price of the product." + "defaultBillingAddressId": { + "description": "Unique identity of customer's default billing address within a specific sales channel." }, - "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" + "defaultShippingAddressId": { + "description": "Unique identity of customer's default shipping address within a specific sales channel." }, - "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", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState", - "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" + "customerNumber": { + "description": "Name of the customer within a specific sales channel the customer is interacting." + }, + "salutationId": { + "description": "Unique identity of customer's default shipping address within a specific sales channel." + }, + "firstName": { + "description": "First name of the customer within a specific sales channel." + }, + "lastName": { + "description": "Last name of the customer within a specific sales channel." + }, + "company": { + "description": "Company name of the customer within a specific sales channel." + }, + "password": { + "description": "Password of the customer within a specific sales channel." + }, + "email": { + "description": "Email of the customer within a specific sales channel." + }, + "title": { + "description": "Customer's title or honorifics like Mr, Mrs, etc within a specific sales channel." + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links within a specific sales channel." + }, + "campaignCode": { + "description": "A unique identifier for a campaign within a specific sales channel." + }, + "active": { + "description": "When `true`, the status of the customer is set active within a specific sales channel." + }, + "doubleOptInRegistration": { + "description": "When `true`, user subscriptions to an email marketing list is allowed within a specific sales channel." + }, + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent within a specific sales channel." + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed within a specific sales channel." + }, + "hash": { + "description": "Password hash for account recovery within a specific sales channel." + }, + "guest": { + "description": "Boolean value is `true` for a guest account within a specific sales channel." + }, + "firstLogin": { + "description": "Captures date and time of customer's first login within a specific sales channel." + }, + "lastLogin": { + "description": "Captures date and time of customer's last login within a specific sales channel." + }, + "newsletter": { + "description": "When `true`, then the customer gets subscribe to the newsletter" + }, + "birthday": { + "description": "Captures customer's birthday details within a specific sales channel." + }, + "lastOrderDate": { + "description": "Captures customer's last order date within a specific sales channel." + }, + "orderCount": { + "description": "Captures the number of orders placed by a customer within a specific sales channel." + }, + "legacyEncoder": { + "description": "encapsulates shop credentials when needed to migrate shop system from old instance to new instance" + }, + "legacyPassword": { + "description": "Hashed password of the old shop system" + }, + "autoIncrement": { + "description": "Internal field. " + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session." + } + } }, - "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Shipping address for this delivery" + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "properties": { + "pluginId": { + "description": "Unique identity of payment plugin within a specific sales channel." + }, + "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal." + }, + "name": { + "description": "Name of the payment method within a specific sales channel." + }, + "description": { + "description": "A short description about the payment method within a specific sales channel." + }, + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc within a specific sales channel." + }, + "active": { + "description": "When `true`, the payment method is available for usage within a specific sales channel." + }, + "availabilityRuleId": { + "description": "Unique identity of the rule for the payment method." + }, + "mediaId": { + "description": "Unique identity of media used in payment method within a specific sales channel." + }, + "formattedHandlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal." + } + } + }, + "shippingLocation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "const": "cart_delivery_shipping_location" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + } + } }, "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" + "properties": { + "name": { + "description": "Name of the shipping method within a specific sales channel." + }, + "active": { + "description": "When `true`, the shipping method is available for usage within a specific sales channel." + }, + "description": { + "description": "A short description about the shipping method within a specific sales channel." + }, + "trackingUrl": { + "description": "URL that allows to track packages for a specific sales channel." + }, + "deliveryTimeId": { + "description": "Unique identity of deliveryTime within a specific sales channel." + }, + "availabilityRuleId": { + "description": "Unique identity of the rule for the payment method." + }, + "mediaId": { + "description": "Unique identity of media used in shipping method within a specific sales channel." + } } - } - }, - "type": "object" - }, - "OrderDeliveryPosition": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "orderDeliveryId", - "orderLineItemId" - ], - "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" - ], + "context": { + "description": "Core context with general configuration values and state", + "type": "object", "properties": { - "unitPrice": { - "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." + "versionId": { + "type": "string", + "description": "Unique identity of context's version in a specific sales channel." }, - "totalPrice": { - "type": "number", - "format": "float", - "description": "Cost of product based on quantity." + "currencyId": { + "type": "string", + "description": "Unique identity of currency context in a specific sales channel." }, - "quantity": { + "currencyFactor": { "type": "integer", - "format": "int64", - "description": "Number of items of each product." + "description": "Unique identity of currency factor context in a specific sales channel." }, - "calculatedTaxes": { - "type": "object", - "description": "Contains calculated taxes based on order delivery price." + "currencyPrecision": { + "type": "integer", + "format": "int32", + "description": "It defines the round off value of currency to the nearest decimal point. If set to 2, it rounds off to two significant decimal points." }, - "taxRules": { - "type": "object", - "description": "Pricing based on multiple taxes." + "languageIdChain": { + "type": "array", + "items": { + "type": "string" + } }, - "referencePrice": { - "type": "object", - "description": "Original cost price of the product." + "scope": { + "type": "string", + "description": "Scope defines if its related to system or user context." }, - "listPrice": { + "source": { + "type": "object", + "required": [ + "salesChannelId", + "type" + ], "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Price of each line item." - }, - "discount": { - "type": "number", - "format": "float", - "description": "Absolute discount on each line item." + "type": { + "type": "string", + "enum": [ + "sales-channel", + "shop-api" + ] }, - "percentage": { - "type": "number", - "format": "float", - "description": "Discount in percentage." + "salesChannelId": { + "type": "string" } }, - "type": "object" + "description": "When context is related to user in the source, then there is userId." }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float", - "description": "Contains cheapest price from last 30 days as per EU law." - } - }, - "type": "object" + "taxState": { + "type": "string", + "description": "Tax state can either be `gross` or `net`." + }, + "useCache": { + "type": "boolean", + "description": "When boolean value is `true`, caching is used." } - }, - "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" + "itemRounding": { + "type": "object", + "required": [ + "decimals", + "interval", + "roundForNet", + "apiAlias" + ], + "properties": { + "apiAlias": { + "type": "string", + "const": "shopware_core_framework_data_abstraction_layer_pricing_cash_rounding_config" + }, + "decimals": { + "type": "integer", + "format": "int32" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + } }, - "customFields": { + "totalRounding": { "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "required": [ + "decimals", + "interval", + "roundForNet", + "apiAlias" + ], + "properties": { + "apiAlias": { + "type": "string", + "const": "shopware_core_framework_data_abstraction_layer_pricing_cash_rounding_config" + }, + "decimals": { + "type": "integer", + "format": "int32" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "languageInfo": { + "type": "object", + "required": [ + "localeCode", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "localeCode": { + "type": "string" + } + } }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "const": "sales_channel_context" } }, - "type": "object" - }, - "OrderTag": { - "description": "Added since version: 6.0.0.0", "required": [ - "orderId", - "tagId" - ], + "salesChannel", + "apiAlias", + "itemRounding", + "totalRounding", + "languageInfo" + ] + }, + "CookieRouteResponse": { + "type": "object", + "description": "Response containing cookie groups and their configuration hash.", "properties": { - "id": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order tag." + "const": "cookie_groups_hash" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "elements": { + "type": "array", + "description": "Collection of cookie groups", + "items": { + "$ref": "#/components/schemas/CookieGroup" + } }, - "orderVersionId": { + "hash": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's version." + "description": "Hash of the current cookie configuration. Can be used to detect changes in cookie configuration.", + "example": "f86b6a872cb83dbd22d838ceda1aa3d4" }, - "tagId": { + "languageId": { "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": "uuid", + "description": "The language ID for which the cookie configuration was generated. Used to store hashes per language.", + "example": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" } }, - "type": "object" - }, - "OrderTransaction": { - "description": "Added since version: 6.0.0.0", "required": [ - "id", - "orderId", - "paymentMethodId", - "amount", - "stateId" + "elements", + "hash", + "languageId", + "apiAlias" ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderTransaction's version." - }, - "orderId": { - "description": "Unique identity of an order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of an order's version." - }, - "paymentMethodId": { - "description": "Unique identity of payment method.", - "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" - } + "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" }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } + { + "name": "Timezone", + "hidden": false, + "cookie": "timezone", + "apiAlias": "cookie_entry" }, - "type": "object" - } + { + "value": "1", + "expiration": 30, + "name": "Cookie preferences", + "hidden": true, + "cookie": "cookie-preference", + "apiAlias": "cookie_entry" + } + ], + "apiAlias": "cookie_group" }, - "type": "object" - }, - "validationData": { - "type": "object" - }, - "stateId": { - "description": "Unique identity of state.", + { + "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" + } + }, + "ProductCrossSellingAssignedProducts": { + "description": "Added since version: 6.2.0.0", + "properties": { + "id": { "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." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product CrossSelling Assigned Products." }, "createdAt": { "type": "string", @@ -4396,323 +3629,255 @@ "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" }, - "OrderTransactionCapture": { - "description": "Added since version: 6.4.12.0", - "required": [ - "id", - "orderTransactionId", - "stateId", - "amount" - ], + "NavigationRouteResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + }, + "properties": { + "id": { + "description": "Unique identity of navigation route response." + } + } + }, + "PromotionDiscount": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture." + "description": "Unique identity of promotion discount." }, - "versionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture's version." + "format": "date-time", + "readOnly": true }, - "orderTransactionId": { - "description": "Unique identity of order transaction.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Cart": { + "type": "object", + "properties": { + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" }, - "orderTransactionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction version." + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" }, - "stateId": { - "description": "Unique identity of order state.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "price": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "externalReference": { - "description": "External payment provider token.", - "type": "string" + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "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." + "errors": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartError" + } }, - "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" + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "key": { + "type": "string" + }, + "level": { + "type": "number" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "required": [ + "code", + "key", + "level", + "message", + "messageKey" + ] + } + } + ], + "properties": { + "key": { + "description": "Unique key for every message." }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "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." } - }, - "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 - }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "transaction": { - "$ref": "#/components/schemas/OrderTransaction" + } }, - "refunds": { + "deliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/CartDelivery" } }, - "shippingCosts": { + "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": { - "calculatedTaxes": { - "description": "Contains calculated taxes based on shipping costs/methods." - }, - "taxRules": { - "description": "Pricing based on multiple taxes." + "paymentMethodId": { + "description": "Unique identity of payment method." + } + } + }, + "modified": { + "type": "boolean", + "description": "It signifies any changes to cart." + }, + "customerComment": { + "description": "A comment that can be added to the cart.", + "oneOf": [ + { + "type": "string" }, - "referencePrice": { - "description": "Original cost price of the product." + { + "type": "null" + } + ] + }, + "affiliateCode": { + "description": "An affiliate tracking code", + "oneOf": [ + { + "type": "string" }, - "listPrice": { - "properties": { - "price": { - "description": "Price of each line item." - }, - "discount": { - "description": "Absolute discount on each line item." - }, - "percentage": { - "description": "Discount in percentage." - } - } + { + "type": "null" + } + ] + }, + "campaignCode": { + "description": "A campaign tracking code", + "oneOf": [ + { + "type": "string" }, - "regulationPrice": { - "properties": { - "price": { - "description": "Contains cheapest price from last 30 days as per EU law." - } - } + { + "type": "null" } - } + ] + }, + "apiAlias": { + "type": "string", + "const": "cart" + }, + "id": { + "description": "Unique identity of cart." } }, - "type": "object" + "required": [ + "price", + "apiAlias" + ] }, - "OrderTransactionCaptureRefund": { - "description": "Added since version: 6.4.12.0", + "OrderTag": { + "description": "Added since version: 6.0.0.0", "required": [ - "id", - "captureId", - "stateId", - "amount" + "orderId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund." + "description": "Unique identity of order tag." }, - "versionId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund's version." + "description": "Unique identity of order." }, - "captureId": { - "description": "Unique identity of order transaction capture.", + "orderVersionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order's version." }, - "captureVersionId": { + "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture's version." + "description": "Unique identity of tag given for an order." }, - "stateId": { - "description": "Unique identity of order state.", + "order": { + "$ref": "#/components/schemas/Order" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "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" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "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." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ImportExportLog": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of import-export log." }, "createdAt": { "type": "string", @@ -4723,171 +3888,47 @@ "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", + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "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.", + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order line item version." + "default": { + "type": "boolean" }, - "externalReference": { - "description": "External payment provider token.", + "type": { "type": "string" }, - "reason": { - "description": "Reason for refunding the amount for an order.", + "shortName": { "type": "string" }, - "quantity": { - "description": "Quantity of line item to be refunded.", + "factor": { + "type": "number", + "format": "float" + }, + "precision": { "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." - }, "createdAt": { "type": "string", "format": "date-time", @@ -4898,211 +3939,142 @@ "format": "date-time", "readOnly": true }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" + "translated": { + "type": "object" }, - "orderTransactionCaptureRefund": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" + } + }, + "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." }, - "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." - } - } - } - } + "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." + }, + "categoryId": { + "description": "Unique identity of the category.", + "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}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "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": { + "OrderRouteResponse": { + "type": "object", + "properties": { + "orders": { + "type": "object", + "allOf": [ + { + "type": "object", + "required": [ + "elements" + ], "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" + "elements": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } } - }, - "type": "object" + } + }, + { + "$ref": "#/components/schemas/EntitySearchResult" } - }, - "type": "object" + ] + }, + "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" ] }, - "PaymentMethod": { + "ProductManufacturer": { "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 payment method." + "description": "Unique identity of the Product Manufacturer." }, - "name": { + "versionId": { "type": "string", - "description": "Name of the payment method." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the ProductManufacturer's version." }, - "distinguishableName": { + "mediaId": { + "description": "Unique identity of the media.", "type": "string", - "readOnly": true, - "description": "System identifier name for payment method." + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "link": { "type": "string", - "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" + "description": "URL of the manufacturer's portal." }, - "active": { - "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", - "type": "boolean" + "name": { + "type": "string", + "description": "Name of the product manufacturer." }, - "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" + "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." }, - "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", @@ -5118,22 +4090,18 @@ "description": "Contains the translations of all translated fields." }, "media": { - "$ref": "#/components/schemas/Media", - "description": "Payment method logo or icon image" + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "Plugin": { - "description": "Added since version: 6.0.0.0", - "required": [ - "label" - ], + "UserConfig": { + "description": "Added since version: 6.3.5.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a plugin." + "description": "Unique identity of user configuration." }, "createdAt": { "type": "string", @@ -5144,60 +4112,48 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "ProductConfiguratorSetting": { + "MediaTag": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "productId", - "optionId" + "mediaId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product configurator setting." + "description": "Unique identity of the media tag." }, - "versionId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product configurator setting version." - }, - "productId": { - "description": "Unique identity of product.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Unique identity of the media." }, - "productVersionId": { + "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product version." + "description": "Unique identity of the tag." }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "media": { + "$ref": "#/components/schemas/Media" }, - "optionId": { - "description": "Unique identity of option.", + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "FlowSequence": { + "description": "Added since version: 6.4.6.0", + "properties": { + "id": { "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." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of flow." }, "createdAt": { "type": "string", @@ -5208,57 +4164,17 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "ProductCrossSelling": { - "description": "Added since version: 6.1.0.0", - "required": [ - "id", - "name" - ], + "ProductSearchKeyword": { + "description": "Added since version: 6.0.0.0", "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" - }, - "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" + "description": "Unique identity of Product Search Keyword." }, "createdAt": { "type": "string", @@ -5269,21 +4185,17 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "ProductCrossSellingAssignedProducts": { - "description": "Added since version: 6.2.0.0", + "ProductVisibility": { + "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 product visibility." }, "createdAt": { "type": "string", @@ -5298,48 +4210,41 @@ }, "type": "object" }, - "ProductDownload": { - "description": "Added since version: 6.4.19.0", + "Salutation": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "mediaId" + "salutationKey", + "displayName", + "letterName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity downloaded product." + "description": "Unique identity of salutation." }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of downloaded product's version." + "salutationKey": { + "description": "Technical name given to salutation. For example: mr", + "type": "string" }, - "productId": { - "description": "Unique identity of Product.", + "displayName": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Name given for salutation and displayed in storefront. For example: Mr" }, - "productVersionId": { + "letterName": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product version." + "description": "Name given for salutation and used in the mail templates. For example, Dear Mr" }, - "mediaId": { - "description": "Unique identity of media.", - "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." }, "position": { - "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", "type": "integer", "format": "int64" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, "createdAt": { "type": "string", "format": "date-time", @@ -5350,22 +4255,77 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "media": { - "$ref": "#/components/schemas/Media" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "ProductExport": { - "description": "Added since version: 6.1.0.0", + "ProductReview": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "salesChannelId", + "languageId", + "title", + "content" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Exported Product." + "description": "Unique identity of the product's review." + }, + "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." + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalUser": { + "description": "External user name.", + "type": "string" + }, + "title": { + "description": "Title of product review.", + "type": "string" + }, + "content": { + "description": "Short description or subject of the project review.", + "type": "string" + }, + "points": { + "description": "A floating point number given to rate a product.", + "type": "number", + "format": "float" + }, + "status": { + "description": "When status is set, the rating is made visible.", + "type": "boolean" + }, + "comment": { + "description": "Detailed review about the product.", + "type": "string" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -5380,16 +4340,13 @@ }, "type": "object" }, - "ProductFeatureSet": { - "description": "Added since version: 6.3.0.0", - "required": [ - "name" - ], + "Notification": { + "description": "Added since version: 6.4.7.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product feature set." + "description": "Unique identity of notification." }, "createdAt": { "type": "string", @@ -5400,203 +4357,70 @@ "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" - ], + "CookieEntryCollection": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CookieEntry" + } + }, + "EntitySearchResult": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product keyword." + "entity": { + "type": "string" }, - "languageId": { - "description": "Unique identity of the language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "total": { + "type": "integer", + "description": "The total number of found entities" }, - "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." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the ProductManufacturer's version." - }, - "mediaId": { - "description": "Unique identity of the media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "link": { - "type": "string", - "description": "URL of the manufacturer's portal." - }, - "name": { - "type": "string", - "description": "Name of the product manufacturer." - }, - "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." - }, - "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." - }, - "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." + "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" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "page": { + "type": "integer", + "description": "The actual page. This can be used for pagination." }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "limit": { + "type": "integer", + "description": "The actual limit. This is used for pagination and goes together with the page." } - }, - "type": "object" + } }, - "ProductReview": { + "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "salesChannelId", - "languageId", - "title", - "content" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product's review." + "description": "Unique identity of document's base config sales channel." }, - "productId": { - "description": "Unique identity of the product.", + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "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.", + "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalUser": { - "description": "External user name.", - "type": "string" - }, - "title": { - "description": "Title of product review.", - "type": "string" - }, - "content": { - "description": "Short description or subject of the project review.", - "type": "string" - }, - "points": { - "description": "A floating point number given to rate a product.", - "type": "number", - "format": "float" - }, - "status": { - "description": "When status is set, the rating is made visible.", - "type": "boolean" - }, - "comment": { - "description": "Detailed review about the product.", - "type": "string" - }, - "customFields": { - "type": "object", - "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" - }, - "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", "format": "date-time", @@ -5610,34 +4434,29 @@ }, "type": "object" }, - "ProductSearchConfigField": { - "description": "Added since version: 6.3.5.0", + "AccountNewsletterRecipient": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product Search Configuration field." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "status": { + "$ref": "#/components/schemas/NewsletterStatus" }, - "updatedAt": { + "apiAlias": { "type": "string", - "format": "date-time", - "readOnly": true + "const": "account_newsletter_recipient" } }, - "type": "object" + "required": [ + "status", + "apiAlias" + ] }, - "ProductSearchKeyword": { + "UserAccessKey": { "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product Search Keyword." + "description": "Unique identity of user access key." }, "createdAt": { "type": "string", @@ -5652,31 +4471,13 @@ }, "type": "object" }, - "ProductSorting": { - "description": "Added since version: 6.3.2.0", - "required": [ - "key", - "priority", - "label" - ], + "RuleCondition": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product sorting." - }, - "key": { - "type": "string", - "description": "A keyword associated to identify product sorting." - }, - "priority": { - "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize the product sorting." - }, - "label": { - "type": "string", - "description": "Label given to a product sorting." + "description": "Unique identity of rule condition." }, "createdAt": { "type": "string", @@ -5687,120 +4488,202 @@ "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." - }, - "name": { - "type": "string", - "description": "Name of the Dynamic Group to be created." - }, - "description": { - "type": "string", - "description": "Description of the Dynamic group to be created." + "ProductListingCriteria": { + "allOf": [ + { + "$ref": "#/components/schemas/Criteria" }, - "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", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "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" - }, - "ProductStreamFilter": { - "description": "Added since version: 6.0.0.0", + ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream filter." + "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." + } + } }, - "createdAt": { - "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." + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } }, - "ProductVisibility": { + "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 product visibility." + "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" - }, - "Promotion": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name" - ], - "properties": { - "id": { + "readOnly": true, + "description": "System identifier name for payment method." + }, + "description": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion." + "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", "format": "date-time", @@ -5814,229 +4697,442 @@ "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" }, - "PromotionDiscount": { + "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 promotion discount." + "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" }, - "PromotionDiscountPrices": { - "description": "Added since version: 6.0.0.0", + "CartPriceQuantity": { + "type": "object", "properties": { - "id": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion discount price." + "const": "cart_price_quantity" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "isCalculated": { + "type": "boolean" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + }, + "type": { + "type": "string" } }, - "type": "object" + "required": [ + "apiAlias" + ] }, - "PromotionIndividualCode": { - "description": "Added since version: 6.0.0.0", + "Price": { + "type": "object", + "description": "Price object", "properties": { - "id": { + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion individual code." + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + ] }, - "PromotionSalesChannel": { - "description": "Added since version: 6.0.0.0", + "AggregationEntity": { + "title": "AggregationEntity", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion on sales channel." + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "createdAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "entity" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" } }, - "type": "object" + "required": [ + "name", + "type", + "field", + "definition" + ] }, - "PromotionSetgroup": { - "description": "Added since version: 6.0.0.0", + "AggregationFilter": { + "title": "AggregationFilter", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion set group." + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "createdAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "filter" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } } }, - "type": "object" - }, - "PropertyGroup": { - "description": "Added since version: 6.0.0.0", "required": [ - "id", - "name" - ], + "name", + "type", + "filter" + ] + }, + "AggregationTerms": { + "title": "AggregationTerms", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of property group." - }, "name": { - "type": "string", - "description": "Name of the property group." + "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 on property group." + "enum": [ + "terms" + ] }, - "displayType": { - "description": "Property groups can be displayed in the form of text, image, dropdown or color.", + "field": { + "description": "The field you want to aggregate over.", "type": "string" }, - "sortingType": { - "description": "Sorting the property group by name or position.", + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "filterable": { - "description": "When set to true, the property will be displayed in the product filter of product lists.", - "type": "boolean" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "histogram" + ] }, - "visibleOnProductDetailPage": { - "description": "When set to true, the property groups are displayed on product detail page.", - "type": "boolean" + "field": { + "description": "The field you want to aggregate over.", + "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." + "interval": { + "description": "The interval of the histogram", + "type": "number" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "format": { + "description": "The format of the histogram", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" }, - "updatedAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "range" + ] }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "options": { + "ranges": { + "description": "The ranges of the aggregation", "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "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" + ] }, - "Rule": { - "description": "Added since version: 6.0.0.0", + "WishlistLoadRouteResponse": { + "type": "object", "required": [ - "name" + "products" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule." - }, - "name": { - "description": "Name of the rule defined.", - "type": "string" - }, - "description": { - "description": "Description of the rule.", - "type": "string" - }, - "customFields": { + "wishlist": { "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 + "properties": { + "customerId": { + "type": "string", + "description": "Unique identity of the customer." + }, + "salesChannelId": { + "type": "string", + "description": "Unique identity of the sales channel." + } + } }, - "extensions": { - "description": "To store additional data to a rule from extensions." + "products": { + "$ref": "#/components/schemas/ProductListingResult" } - }, - "type": "object" + } }, - "RuleCondition": { + "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule condition." + "description": "Unique identity of promotion set group." }, "createdAt": { "type": "string", @@ -6051,139 +5147,115 @@ }, "type": "object" }, - "SalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "languageId", - "customerGroupId", - "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "name", - "homeEnabled" + "NewsletterStatus": { + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct", + "undefined" ], + "description": "The subscription status. Possible values are: notSet, optIn, optOut, direct, undefined." + }, + "ProductDetailResponse": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "product": { + "$ref": "#/components/schemas/Product" }, - "languageId": { - "description": "Unique identity of language used.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "configurator": { + "type": "array", + "description": "List of property groups with their corresponding options and information on how to display them.", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } }, - "customerGroupId": { - "description": "Unique identity of customer group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "id": { + "description": "Unique identity of product detail response." }, - "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}$" + "available": { + "description": "When boolean value is true, the product is available for purchase." }, - "navigationCategoryId": { - "description": "Unique identity of navigation category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "isCloseout": { + "description": "Boolean value to check if the product is still buyable when stock value is 0." }, - "navigationCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of navigation category's version." + "displayGroup": { + "description": "Internal field." }, - "navigationCategoryDepth": { - "description": "It determines the number of levels of subcategories in the storefront category menu.", - "type": "integer", - "format": "int64" + "manufacturerNumber": { + "description": "Unique number of the product manufacturer." }, - "footerCategoryId": { - "description": "Unique identity of footer category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "stock": { + "description": "Quantity of product available." }, - "footerCategoryVersionId": { + "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", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of footer category's version." + "description": "Unique identity of CMS slot." }, - "serviceCategoryId": { - "description": "Unique identity of service category.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "serviceCategoryVersionId": { + "cmsBlockVersionId": { "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" - }, - "businessTimeZone": { - "description": "Business timezone used for sales-channel-specific rendering. Added since version: 6.7.13.0.", - "type": "string" + "description": "Unique identity of CMS block version." }, - "name": { - "type": "string", - "description": "Name of the sales channel." + "fieldConfig": { + "type": "object", + "description": "Con info of cms slot" }, - "shortName": { - "description": "A short name for sales channel.", + "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" }, - "taxCalculationType": { - "description": "Tax calculation types are `horizontal` and `vertical`.", + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "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" + "locked": { + "type": "boolean", + "description": "When locked, then CMS slot config element cannot be configured." }, - "maintenance": { - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", - "type": "boolean" + "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", @@ -6198,58 +5270,69 @@ "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" + "block": { + "$ref": "#/components/schemas/CmsBlock" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Default payment method for the sales channel" + "apiAlias": { + "type": "string", + "const": "cms_slot" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod", - "description": "Default shipping method for the sales channel" + "VersionId": { + "description": "Unique identity of CMS slot's version." + } + }, + "type": "object" + }, + "Snippet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "setId", + "translationKey", + "value" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of snippet." }, - "country": { - "$ref": "#/components/schemas/Country", - "description": "Default country for the sales channel" + "setId": { + "description": "Unique identity od snippet set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "domains": { - "description": "Domain URLs configured for the sales channel", - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } + "translationKey": { + "description": "Reference to the snippet in the template.", + "type": "string" }, - "navigationCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for navigation menu" + "value": { + "description": "Value of the key.", + "type": "string" }, - "footerCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for footer navigation" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "serviceCategory": { - "$ref": "#/components/schemas/Category", - "description": "Root category for service pages" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "hreflangDefaultDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "NumberRangeState": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel analytics." + "description": "Unique identity of number range's state." }, "createdAt": { "type": "string", @@ -6264,25 +5347,33 @@ }, "type": "object" }, - "SalesChannelDomain": { + "Customer": { "description": "Added since version: 6.0.0.0", "required": [ + "apiAlias", + "activeBillingAddress", + "activeShippingAddress", "id", - "url", + "groupId", "salesChannelId", "languageId", - "currencyId", - "snippetSetId" + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel domain." + "description": "Unique identity of the customer." }, - "url": { - "description": "URL of the sales channel domain.", - "type": "string" + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Unique identity of sales channel.", @@ -6290,57 +5381,145 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { - "description": "Unique identity of language used.", + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "description": "Unique identity of currency.", + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "snippetSetId": { - "description": "Unique identity of snippet set.", + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementUnits": { - "$ref": "#/components/schemas/MeasurementUnits" + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "hreflangUseOnlyLocale": { - "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "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" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" }, - "createdAt": { + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "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" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "currency": { - "$ref": "#/components/schemas/Currency" + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true }, - "salesChannelDefaultHreflang": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "SalesChannelFile": { - "description": "Added since version: 6.7.12.0", - "properties": { - "id": { + "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." + }, + "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.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6353,16 +5532,126 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" + }, + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" + }, + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" + }, + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" + }, + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" + }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" + }, + "addresses": { + "description": "All addresses saved for the customer", + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "apiAlias": { + "type": "string", + "const": "customer" + }, + "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" + "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" + } + } + } + ] }, - "SalesChannelTrackingCustomer": { - "description": "Added since version: 6.7.9.0", + "CustomEntity": { + "description": "Added since version: 6.4.9.0", "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a custom entity." }, "createdAt": { "type": "string", @@ -6377,12 +5666,13 @@ }, "type": "object" }, - "SalesChannelTrackingOrder": { - "description": "Added since version: 6.7.9.0", + "User": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of user." }, "createdAt": { "type": "string", @@ -6397,123 +5687,122 @@ }, "type": "object" }, - "SalesChannelType": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefundPosition": { + "description": "Added since version: 6.4.12.0", "required": [ - "name" + "id", + "refundId", + "orderLineItemId", + "amount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel type." + "description": "Unique identity of order transaction capture refund position." }, - "createdAt": { + "versionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture refund position's version." }, - "updatedAt": { + "refundId": { + "description": "Unique identity of order transaction capture refund.", "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" - }, - "SalutationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "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": [ - "id", - "salutationKey", - "displayName", - "letterName" + "unitPrice", + "totalPrice", + "quantity" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationKey": { - "description": "Technical name given to salutation. For example: mr", - "type": "string" + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." }, - "displayName": { - "type": "string" + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." }, - "letterName": { - "type": "string" + "quantity": { + "type": "integer", + "format": "int64", + "description": "Number of items of each product." }, - "customFields": { + "calculatedTaxes": { "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" + "taxRules": { + "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "referencePrice": { + "type": "object" }, - "updatedAt": { - "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" }, - "translated": { + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, "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", @@ -6524,20 +5813,58 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "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." + } + } + } + } } }, "type": "object" }, - "ScheduledTask": { - "description": "Added since version: 6.0.0.0", + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", + "required": [ + "label" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of scheduled task." + "description": "Unique identity of app's CMS block." }, "createdAt": { "type": "string", @@ -6548,17 +5875,24 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "Script": { - "description": "Added since version: 6.4.7.0", + "Plugin": { + "description": "Added since version: 6.0.0.0", + "required": [ + "label" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a script." + "description": "Unique identity of a plugin." }, "createdAt": { "type": "string", @@ -6569,120 +5903,120 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, "type": "object" }, - "SeoUrlJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "ProductCrossSelling": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of product cross selling." }, - { - "required": [ - "id", - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "foreignKey": { - "description": "The key that references to product or category entity ID.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" + "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", + "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" }, - "SeoUrlTemplate": { + "MailTemplateMedia": { "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "mailTemplateId", + "languageId", + "mediaId" + ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Seo Url template." + "description": "Unique identity of mail template's media." }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "mailTemplateId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the mail template." }, - "isValid": { - "description": "Created SEO URL template can be made usable by setting `isValid` to true.", - "type": "boolean" + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the language." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the media." + }, + "position": { + "type": "integer", + "format": "int64", + "description": "The order of multiple media templates defined is specified using numerical values like 1,2,3, etc." + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "LogEntry": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of log entry." }, "createdAt": { "type": "string", @@ -6697,534 +6031,381 @@ }, "type": "object" }, - "ShippingMethodJsonApi": { + "MediaFolder": { "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of media folder." }, - { - "required": [ - "id", - "technicalName", - "deliveryTimeId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "technicalName": { - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", - "type": "boolean" - }, - "position": { - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime.", + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomerAddressRead": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "oneOf": [ + { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxType": { - "description": "Refers `Free`, `Net` or `Gross` type of taxes.", - "type": "string" - }, - "description": { - "type": "string" - }, - "trackingUrl": { - "type": "string" + "format": "date-time" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "type": "null" + } + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "oneOf": [ + { + "$ref": "#/components/schemas/CountryState" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "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" + { + "type": "null" } - }, - "type": "object" + ] + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } + }, + "required": [ + "customerId", + "createdAt", + "updatedAt", + "country", + "salutation" ] }, - "ShippingMethod": { + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Order": { "description": "Added since version: 6.0.0.0", "required": [ + "documents", + "orderDate", + "stateMachineState", + "price", "id", - "technicalName", - "deliveryTimeId", - "name" + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method." + "description": "Unique identity of order." }, - "name": { + "versionId": { "type": "string", - "description": "Name of the shipping method." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order version." }, - "technicalName": { + "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", - "type": "boolean" - }, - "position": { - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "mediaId": { - "description": "Unique identity of media.", + "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime.", + "billingAddressVersionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "taxType": { - "description": "Refers `Free`, `Net` or `Gross` type of taxes.", - "type": "string" - }, - "description": { - "type": "string", - "description": "Description of each shipping method." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the billing address version." }, - "trackingUrl": { + "primaryOrderDeliveryId": { "type": "string", - "description": "This URL allows to track packages." + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "primaryOrderDeliveryVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "primaryOrderTransactionId": { "type": "string", - "format": "date-time", - "readOnly": true - }, - "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" - }, - "prices": { - "description": "Shipping prices based on weight, volume, or cart value", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Shipping method logo or carrier image" - }, - "tags": { - "description": "Tags for organizing shipping methods", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "pattern": "^[0-9a-f]{32}$" }, - "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": { + "primaryOrderTransactionVersionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method price." + "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { - "description": "Unique identity of shipping method.", + "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { - "description": "Unique identity of rule.", + "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "calculation": { - "description": "Shipping price calculated based on quantity, price, weight or volume of items.", - "type": "integer", - "format": "int64" - }, - "calculationRuleId": { - "description": "Unique identity of rule calculation.", + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quantityStart": { - "description": "Starting range of quantity of an item.", - "type": "number", - "format": "float" - }, - "quantityEnd": { - "description": "Ending range of quantity of an item.", - "type": "number", - "format": "float" - }, - "currencyPrice": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - }, - "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": { + "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "orderDate": { + "description": "Date when the order was placed.", "type": "string", - "format": "date-time", "readOnly": true - } - }, - "type": "object" - }, - "Snippet": { - "description": "Added since version: 6.0.0.0", - "required": [ - "setId", - "translationKey", - "value" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of snippet." - }, - "setId": { - "description": "Unique identity od snippet set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationKey": { - "description": "Reference to the snippet in the template.", - "type": "string" - }, - "value": { - "description": "Value of the key.", - "type": "string" }, - "customFields": { + "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", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "$ref": "#/components/schemas/CalculatedPrice" }, - "createdAt": { - "type": "string", - "format": "date-time", + "amountTotal": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", "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." - }, - "name": { - "description": "Name of snippet set.", - "type": "string" - }, - "iso": { - "description": "ISO nomenclature used to classify languages.", - "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", + "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 }, - "updatedAt": { + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "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": { + "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.", + "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}$", - "description": "Unique identity of state machine." + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "description": "Unique identity of updatedBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -7236,59 +6417,91 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" }, - "states": { + "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/StateMachineState" + "$ref": "#/components/schemas/OrderAddress" } }, - "transitions": { + "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/StateMachineTransition" + "$ref": "#/components/schemas/OrderDelivery" } - } - }, - "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 + "lineItems": { + "description": "Order line items (products, discounts, fees)", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "transactions": { + "description": "Payment transactions for the order", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } }, - "fromStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } }, - "toStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "tags": { + "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" }, - "StateMachineTransition": { - "description": "Added since version: 6.0.0.0", + "AppMcpResource": { + "description": "Added since version: 6.7.11.0", + "required": [ + "label" + ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine transition." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -7299,112 +6512,56 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" } }, "type": "object" }, - "SystemConfig": { + "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "configurationKey", - "configurationValue" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of system configuration." - }, - "configurationKey": { - "description": "Config key for shop configurations.", - "type": "string" - }, - "configurationValue": { - "properties": { - "_value": { - "type": "object", - "description": "Config value for shop configurations." - } - }, - "type": "object" + "description": "Unique identity of the document base config." }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "logoId": { + "description": "Unique identity of the company logo.", "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "Tag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tag." + "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the document.", "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" }, - "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." + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" }, - "taxRate": { - "description": "Rate of tax.", - "type": "number", - "format": "float" + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", + "type": "boolean" }, - "name": { - "description": "Name defined for a Tax.", + "documentNumber": { + "description": "Unique number associated with every document.", "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." @@ -7414,49 +6571,62 @@ "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" }, - "TaxProvider": { - "description": "Added since version: 6.5.0.0", + "ProductMedia": { + "description": "Added since version: 6.0.0.0", "required": [ + "media", "id", - "priority", - "name" + "productId", + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax provider." - }, - "active": { - "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", - "type": "boolean" + "description": "Unique identity of the Product Media." }, - "name": { + "versionId": { "type": "string", - "description": "Name of the tax provider." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the ProductMedia version." }, - "priority": { - "description": "A numerical value to prioritize one the tax providers from the list.", - "type": "integer", - "format": "int64" + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "processUrl": { - "description": "External URL makes request to get tax info.", - "type": "string" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the product's version." }, - "appId": { - "description": "Unique identity of app.", + "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." @@ -7471,44 +6641,22 @@ "format": "date-time", "readOnly": true }, - "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." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "TaxRuleType": { - "description": "Added since version: 6.1.0.0", + "StateMachine": { + "description": "Added since version: 6.0.0.0", "required": [ - "typeName" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax rule type." + "description": "Unique identity of state machine." }, "createdAt": { "type": "string", @@ -7523,169 +6671,118 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "transitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } } }, "type": "object" }, - "Theme": { + "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "author", - "active" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Theme." + "description": "Unique identity of customer's address." }, - "technicalName": { + "customerId": { + "description": "Unique identity of customer.", "type": "string", - "description": "Technical name of Theme." + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "countryId": { + "description": "Unique identity of country.", "type": "string", - "description": "Name of theme which is translatable." + "pattern": "^[0-9a-f]{32}$" }, - "author": { + "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", - "description": "Name of the company." + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "description": "Description of the theme." + "pattern": "^[0-9a-f]{32}$" }, - "labels": { - "type": "object", - "description": "Identification label given to theme." + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "helpTexts": { - "type": "object", - "description": "Texts from config element." + "lastName": { + "description": "Last 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." + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" }, - "previewMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media used for previewing the theme." + "city": { + "description": "Name of customer's city.", + "type": "string" }, - "parentThemeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent theme." + "company": { + "description": "Name of customer's company.", + "type": "string" }, - "baseConfig": { - "type": "object", - "description": "Config elements of theme like header, color, etc" + "street": { + "description": "Name of customer's street.", + "type": "string" }, - "configValues": { - "type": "object" + "department": { + "description": "Name of customer's department.", + "type": "string" }, - "active": { - "type": "boolean", - "description": "When boolean value is `true`, the created theme can be made usable." + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object", - "description": "Contains the translations of all translated fields." - }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - }, - "ConfigValues": { - "description": "Chosen values for the configuration." - } - }, - "type": "object" - }, - "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 Unit." + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" }, - "shortCode": { - "type": "string", - "description": "Short name for unit, e.g., m, kg." + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" }, - "name": { - "type": "string", - "description": "Full name of the unit, e.g., Meter, kilogram." + "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." }, - "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" - }, - "User": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user." - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "isDefaultBillingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "UserAccessKey": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user access key." + "isDefaultShippingAddress": { + "description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -7696,80 +6793,70 @@ "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 }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "UserRecovery": { - "description": "Added since version: 6.0.0.0", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user recovery." + "country": { + "$ref": "#/components/schemas/Country" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "Webhook": { - "description": "Added since version: 6.3.1.0", + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of webhook." - }, - "createdAt": { + "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": { - "type": "string", - "format": "date-time", - "readOnly": true + "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." + } + } } - }, - "type": "object" + } }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.0", + "ScheduledTask": { + "description": "Added since version: 6.0.0.0", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of webhook event log." + "description": "Unique identity of scheduled task." }, "createdAt": { "type": "string", @@ -7784,59 +6871,100 @@ }, "type": "object" }, - "BreadcrumbCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Breadcrumb" - } - }, - "CartPriceReference": { + "CalculatedPrice": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "purchaseUnit": { + "unitPrice": { "type": "number" }, - "referenceUnit": { + "quantity": { "type": "number" }, - "unitName": { - "type": "string" + "rawTotal": { + "type": "number" }, - "price": { + "totalPrice": { "type": "number" }, - "apiAlias": { + "taxStatus": { "type": "string", - "const": "cart_price_reference" - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } + "enum": [ + "net", + "tax-free" ] }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "const": "cart_regulation_price" - } - } - }, - { - "type": "null" - } - ] + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "const": "cart_tax_calculated" + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "cart_regulation_price" + } + } + }, + { + "type": "null" + } + ] }, "hasRange": { "type": "boolean" @@ -7851,6 +6979,26 @@ "type": "null" } ] + }, + "apiAlias": { + "type": "string", + "const": "calculated_price" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, "required": [ @@ -7858,750 +7006,702 @@ "hasRange", "regulationPrice", "listPrice", + "referencePrice", "calculatedTaxes", "totalPrice", "quantity", - "unitName" + "unitPrice", + "positionPrice", + "netPrice", + "taxRules", + "rawTotal", + "taxStatus" ] }, - "CrossSellingElement": { - "type": "object", + "App": { + "description": "Added since version: 6.3.1.0", + "required": [ + "label" + ], "properties": { - "crossSelling": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of App." }, - "total": { - "type": "integer", - "format": "int32" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "streamId": { + "updatedAt": { "type": "string", - "format": "uuid" + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" }, "apiAlias": { "type": "string", - "const": "cross_selling_element" + "const": "cart_list_price" } }, "required": [ - "crossSelling", - "products", - "total", "apiAlias" ] }, - "Breadcrumb": { - "type": "object", + "OrderDelivery": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", + "stateId", + "shippingDateEarliest", + "shippingDateLatest" + ], "properties": { - "name": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Order's delivery." }, - "categoryId": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderDelivery's version." + }, + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "$ref": "#/components/schemas/Category/properties/type" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order's version." }, - "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" - } - } + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "path": { - "type": "string" + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order's shipping address version." }, - "seoUrls": { + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingCodes": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "type": "string" + }, + "description": "Tracking code is a unique URL code assigned to each package, which allows you to monitor the movement of the parcel." }, - "apiAlias": { + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", - "const": "breadcrumb" - } - }, - "required": [ - "name", - "categoryId", - "type", - "translated", - "path", - "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" - } - ] - }, - "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" - } - ] - } - } - }, - "Criteria": { - "type": "object", - "description": "Criteria to query entities.", - "properties": { - "page": { - "description": "Search result page", - "type": "integer" - }, - "term": { - "description": "Search term", - "type": "string" + "format": "date-time" }, - "limit": { - "description": "Number of items per result page", - "type": "integer" + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", + "type": "string", + "format": "date-time" }, - "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" - } - ] - }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "type": { - "description": "To filter the results and aggregations with filter types like ==, >=, etc." + "unitPrice": { + "type": "number", + "format": "float", + "description": "Shipping cost of product per item (where, quantity=1)." }, - "field": { - "description": "To filter the results and aggregations by field like an property identifier." + "totalPrice": { + "type": "number", + "format": "float", + "description": "Shipping cost of product based on quantity." }, - "value": { - "description": "To filter the results and aggregations by value." + "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" }, - "ids": { - "type": "array", - "description": "List of ids to search for", - "items": { - "type": "string" - } + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "query": { + "createdAt": { "type": "string", - "description": "The query string to search for" - }, - "associations": { - "$ref": "#/components/schemas/Associations" + "format": "date-time", + "readOnly": true }, - "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." - }, - "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." - } - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "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." - }, - "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." - } - } + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "shippingOrderAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" - } + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, - "grouping": { + "positions": { + "description": "Line items included in this delivery", "type": "array", - "description": "Perform groupings over certain fields", "items": { - "type": "string", - "description": "Name of a field" + "$ref": "#/components/schemas/OrderDeliveryPosition" } - }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" - }, - "includes": { - "$ref": "#/components/schemas/Includes" - }, - "excludes": { - "$ref": "#/components/schemas/Excludes" } - } + }, + "type": "object" }, - "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" + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture." }, - "term": { - "description": "Search term", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture's version." }, - "limit": { - "description": "Number of items per result page", - "type": "integer" + "orderTransactionId": { + "description": "Unique identity of order transaction.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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" + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction version." + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float", + "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" + } }, - { - "$ref": "#/components/schemas/MultiNotFilter" + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "type": "object" + } + }, + "type": "object" }, - "ids": { - "type": "array", - "description": "List of ids to search for", - "items": { - "type": "string" - } + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "query": { + "createdAt": { "type": "string", - "description": "The query string to search for" + "format": "date-time", + "readOnly": true }, - "associations": { - "$ref": "#/components/schemas/Associations" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "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" - } - ] - } + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "$ref": "#/components/schemas/Sort" - } + "transaction": { + "$ref": "#/components/schemas/OrderTransaction" }, - "aggregations": { + "refunds": { "type": "array", "items": { - "$ref": "#/components/schemas/Aggregation" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" + "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" + }, + "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." }, - "total-count-mode": { - "$ref": "#/components/schemas/TotalCountMode" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "includes": { - "$ref": "#/components/schemas/Includes" + "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", + "type": "boolean" }, - "excludes": { - "$ref": "#/components/schemas/Excludes" + "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 } - } - }, - "Associations": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Criteria" - } + }, + "type": "object" }, - "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" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationFilter", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationTerms", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationHistogram", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationHistogram" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - }, - { - "title": "AggregationRange", - "allOf": [ - { - "$ref": "#/components/schemas/AggregationRange" - }, - { - "$ref": "#/components/schemas/SubAggregations" - } - ] - } - ] - }, - "SubAggregations": { + "CartItems": { "type": "object", + "required": [ + "items" + ], "properties": { - "aggregation": { - "anyOf": [ - { - "$ref": "#/components/schemas/AggregationMetrics" - }, - { - "$ref": "#/components/schemas/AggregationEntity" - }, - { - "$ref": "#/components/schemas/AggregationFilter" - }, - { - "$ref": "#/components/schemas/AggregationTerms" - }, - { - "$ref": "#/components/schemas/AggregationHistogram" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + }, + "properties": { + "id": { + "description": "Unique identity of cart item." }, - { - "$ref": "#/components/schemas/AggregationRange" + "modified": { + "description": "When boolean value is `true`, the cart is said to be modified." } - ] + } } } }, - "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", + "ProductSearchConfigField": { + "description": "Added since version: 6.3.5.0", "properties": { - "score": { - "type": "number" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product Search Configuration field." }, - "query": { - "oneOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "additionalProperties": true + "type": "object" }, - "Sort": { - "type": "object", + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", + "required": [ + "name" + ], "properties": { - "field": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of app's script condition." }, - "order": { + "createdAt": { "type": "string", - "enum": [ - "ASC", - "DESC" - ] + "format": "date-time", + "readOnly": true }, - "naturalSorting": { - "type": "boolean" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "type": { - "type": "string" + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." } }, - "required": [ - "field", - "order" - ] - }, - "Filters": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "type": "object" }, - "SimpleFilter": { - "type": "object", + "NewsletterRecipient": { + "description": "Added since version: 6.0.0.0", "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "contains", - "equalsAny", - "prefix", - "suffix" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of newsletter recipient." }, - "field": { - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "value": { - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "required": [ - "type", - "field", - "value" - ] + "type": "object" }, - "EqualsFilter": { - "type": "object", + "Tag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "equals" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of tag." }, - "field": { + "name": { "type": "string" }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "null" - } - ] + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "required": [ - "type", - "field", - "value" - ] + "type": "object" }, - "MultiNotFilter": { - "type": "object", + "MediaThumbnailSize": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "width", + "height" + ], "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "multi", - "not" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of media thumbnail size defined." }, - "operator": { + "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", - "enum": [ - "and", - "or", - "nor", - "nand" - ] + "format": "date-time", + "readOnly": true }, - "queries": { - "$ref": "#/components/schemas/Filters" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "required": [ - "type", - "operator", - "queries" - ] + "type": "object" }, - "RangeFilter": { - "type": "object", + "Flow": { + "description": "Added since version: 6.4.6.0", "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "range" - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of flow." }, - "field": { - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "parameters": { - "type": "object", - "properties": { - "gte": { - "type": "number" - }, - "gt": { - "type": "number" - }, - "lte": { - "type": "number" - }, - "lt": { - "type": "number" - } - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "required": [ - "type", - "field", - "parameters" - ] + "type": "object" }, - "CustomerGroup": { + "StateMachineState": { "description": "Added since version: 6.0.0.0", "required": [ "translated", - "id", + "technicalName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer's group." + "description": "Unique identity of state machine state." + }, + "technicalName": { + "description": "Technical name of StateMachineState.", + "type": "string" }, "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" + "description": "Display name of StateMachineState." }, "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" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "registrationTitle": { + "updatedAt": { "type": "string", - "description": "Title defined for the customer group during registration." + "format": "date-time", + "readOnly": true }, - "registrationIntroduction": { + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "PromotionSalesChannel": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", - "description": "A brief description about the registration." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of promotion on sales channel." }, - "registrationOnlyCompanyRegistration": { - "type": "boolean", - "description": "Register as a company rather than as a private customer group." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "registrationSeoMetaDescription": { + "updatedAt": { "type": "string", - "description": "A short description of the registration page for search results listings." + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "MailTemplateType": { + "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 mail template type." + }, + "name": { + "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." }, "createdAt": { "type": "string", @@ -8615,210 +7715,113 @@ }, "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" }, - "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" - } - } - } - } - }, - "CartError": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } - }, - "required": [ - "key", - "level", - "message", - "messageKey" - ] - }, - "Document": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode" - ], + "OrderTransaction": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId" + ], "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." + "description": "Unique identity of order transaction." }, - "referencedDocumentId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of reference document." + "description": "Unique identity of OrderTransaction's version." }, "orderId": { + "description": "Unique identity of an order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the order." + "pattern": "^[0-9a-f]{32}$" }, - "documentMediaFileId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document media file." + "description": "Unique identity of an order's version." }, - "documentA11yMediaFileId": { + "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the order's version." - }, - "config": { - "type": "object", + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "name": { - "type": "string" + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." }, - "title": { - "type": "string" + "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" } }, - "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." + "type": "object" }, - "static": { - "type": "boolean", - "description": "When `true`, the document is uploaded else it is generated by the system." + "validationData": { + "type": "object" }, - "deepLinkCode": { + "stateId": { + "description": "Unique identity of state.", "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" + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -8834,745 +7837,871 @@ "format": "date-time", "readOnly": true }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "order": { - "$ref": "#/components/schemas/Order" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, - "referencedDocument": { - "$ref": "#/components/schemas/Document" + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" }, - "dependentDocuments": { + "captures": { + "description": "Payment captures for this transaction", "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/OrderTransactionCapture" } }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" - }, - "documentA11yMediaFile": { - "$ref": "#/components/schemas/Media" - }, - "fileType": { - "type": "string", - "description": "Type of file like PDF." - } - }, - "type": "object" - }, - "CartDelivery": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", + "shippingCosts": { "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } - }, - "location": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "const": "cart_delivery_shipping_location" + "calculatedTaxes": { + "description": "Contains calculated taxes based on shipping costs/methods." }, - "country": { - "$ref": "#/components/schemas/Country" + "taxRules": { + "description": "Pricing based on multiple taxes." }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" + "referencePrice": { + "description": "Original cost price of the product." }, - "state": { - "$ref": "#/components/schemas/CountryState" + "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." + } + } } } - }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } - }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" } - } + }, + "type": "object" }, - "ProductListingResult": { - "allOf": [ - { - "$ref": "#/components/schemas/EntitySearchResult" - }, - { - "type": "object", - "properties": { - "currentFilters": { + "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", - "description": "Contains the state of the filters. These can be used to create listing filters.", "properties": { - "navigationId": { + "shippingMethodId": { "type": "string" }, - "manufacturer": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "name": { + "type": "string" }, - "price": { - "type": "object", - "properties": { - "min": { - "type": "integer", - "default": 0 - }, - "max": { - "type": "integer", - "default": 0 - } - }, - "required": [ - "min", - "max" - ] + "description": { + "type": "string" + } + } + } + }, + "orderDeliveries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "orderId": { + "type": "string" }, - "rating": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ] + "shippingOrderAddressId": { + "type": "string" }, - "shipping-free": { - "type": "boolean", - "default": false + "shippingMethodId": { + "type": "string" }, - "properties": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "shippingDateEarliest": { + "type": "string", + "format": "date-time" }, - "search": { + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "stateId": { "type": "string" } - }, - "required": [ - "manufacturer", - "navigationId", - "price", - "properties", - "rating", - "shipping-free" - ] - }, - "availableSortings": { - "type": "array", - "description": "Contains the available sorting. These can be used to show a sorting select-box in the product listing.", - "items": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "translated": { - "type": "object", - "properties": { - "label": { - "type": "string" - } - }, - "required": [ - "label" - ] - }, - "key": { - "type": "string" - }, - "priority": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "const": "product_sorting" - } - }, - "required": [ - "label", - "translated", - "key", - "priority", - "apiAlias" - ] - } - }, - "sorting": { - "type": "string" - }, - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" } - }, - "entity": { - "type": "string", - "enum": [ - "product" - ] - }, - "apiAlias": { - "type": "string", - "const": "product_listing" } }, - "required": [ - "elements", - "availableSortings", - "currentFilters", - "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." - }, - "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", - "const": "product_purchase_limit" - } - } - }, - "ContextMeasurementSystemInfo": { - "type": "object", - "description": "Configuration of the measurement system used in the store, by default including units for length and weight.", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "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" + } + } } - } - } - } - }, - "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": { - "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" - }, - "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" + }, + "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" + } + } + } + } + } + }, + "properties": { + "name": { + "description": "Name of the shipping method." }, "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 + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." }, - "isCloseout": { - "description": "When the value is set to true, the product is hidden when sold out.", - "type": "boolean" + "description": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc." }, - "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 + "deliveryTimeId": { + "description": "Unique identity of the delivery time." }, - "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" + "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." + } + } }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true + "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." + } + } }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", - "type": "string" + "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." + } + } }, - "ean": { - "description": "Indicates EAN of the product.", - "type": "string" + "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." + } + } }, - "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" + "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." + }, + "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." + } + } }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" + "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." + } + } }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", - "type": "integer", - "format": "int64" + "availabilityRuleId": { + "description": "Unique identity of availability rule." }, - "purchaseUnit": { - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", - "type": "number", - "format": "float" + "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." + } + } }, - "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" + "mediaId": { + "description": "Unique identity of media." }, - "shippingFree": { - "description": "Indicates weather the shipping price is free or not.", - "type": "boolean" + "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." + } + } }, - "markAsTopseller": { - "description": "Indicates weather the product is top seller or not.", - "type": "boolean" + "tags": { + "properties": { + "name": { + "description": "Name of the tag." + } + } + } + } + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "const": "cart_delivery_information" }, - "weight": { - "description": "The weight of the product.", - "type": "number", - "format": "float" + "freeDelivery": { + "type": "boolean" }, - "width": { - "description": "The width of the product.", - "type": "number", - "format": "float" + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "const": "cart_delivery_time" + } + } }, "height": { - "description": "The height of the product.", - "type": "number", - "format": "float" + "type": "integer" }, "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" + "type": "integer" }, - "ratingAverage": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "number", - "format": "float", - "readOnly": true + "restockTime": { + "type": "integer" }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "stock": { + "type": "integer" }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "weight": { + "type": "integer" }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "width": { + "type": "integer" + } + }, + "required": [ + "apiAlias" + ] + }, + "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 shipping method." }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "name": { + "type": "string", + "description": "Name of the shipping method." }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "technicalName": { + "type": "string" }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", + "type": "boolean" }, - "childCount": { + "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", - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "format": "int64" }, - "sales": { - "description": "Runtime field, cannot be used as part of the criteria.", - "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." }, - "metaDescription": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", - "description": "A short description of the product for search results listings." + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", - "description": "Name of the product." + "pattern": "^[0-9a-f]{32}$" }, - "keywords": { - "type": "string", - "description": "Keywords that give additional information about the Product." + "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", + "type": "string" }, "description": { "type": "string", - "description": "Description of the product." - }, - "descriptionTeaser": { - "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", - "type": "string", - "readOnly": true + "description": "Description of each shipping method." }, - "metaTitle": { + "trackingUrl": { "type": "string", - "description": "A page title indexed by search engines and appears in search results listings." + "description": "This URL allows to track packages." }, - "packUnit": { + "createdAt": { "type": "string", - "description": "Type of packing. For example, bottle, tin, crate, etc." + "format": "date-time", + "readOnly": true }, - "packUnitPlural": { + "updatedAt": { "type": "string", - "description": "Type of packing in plural. For example, bottles, tins, crates, etc." + "format": "date-time", + "readOnly": true }, - "customFields": { + "translated": { "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, - "ogTitle": { - "type": "string" + "description": "Contains the translations of all translated fields." }, - "ogDescription": { - "type": "string" + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] + "availabilityRule": { + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, - "states": { + "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true, - "description": "Internal field." + "$ref": "#/components/schemas/ShippingMethodPrice" + } }, - "calculatedPrice": { - "type": "object", - "$ref": "#/components/schemas/CalculatedPrice", - "description": "Runtime field, cannot be used as part of the criteria." + "media": { + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, - "calculatedPrices": { + "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { - "type": "object", - "additionalProperties": false, - "allOf": [ - { - "$ref": "#/components/schemas/CalculatedPrice" - } - ] - }, - "description": "Runtime field, cannot be used as part of the criteria." + "$ref": "#/components/schemas/Tag" + } }, - "calculatedMaxPurchase": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "calculatedCheapestPrice": { - "type": "object", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "totalPrice": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/ReferencePrice" - }, - { - "type": "null" - } - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/ListPrice" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - } - }, - "required": [ - "price" - ] - }, - { - "type": "null" - } - ] - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "" - }, - { - "type": "null" - } - ] - }, - "apiAlias": { - "type": "string", - "const": "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" + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" + } + }, + "type": "object" + }, + "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." }, - "sortedProperties": { - "type": "object" + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "measurements": { + "customFields": { "type": "object", - "$ref": "#/components/schemas/ProductMeasurements" + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdAt": { "type": "string", @@ -9584,4248 +8713,596 @@ "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", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - }, - "parent": { - "$ref": "#/components/schemas/Product", - "description": "Unique identity of the product." - }, - "children": { - "description": "Product variants that inherit from this parent product", + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/CustomerWishlistProduct" } + } + }, + "type": "object" + }, + "Rule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of rule." }, - "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." - }, - "tax": { - "$ref": "#/components/schemas/Tax", - "description": "Tax configuration (rate and calculation rules)" - }, - "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer", - "description": "Product manufacturer or brand information" - }, - "unit": { - "$ref": "#/components/schemas/Unit", - "description": "Product unit of measure (e.g., piece, liter, kg)" - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia", - "description": "Main product image displayed in listings and detail pages" - }, - "openGraphMedia": { - "$ref": "#/components/schemas/Media", - "description": "Open Graph image for social media sharing" + "name": { + "description": "Name of the rule defined.", + "type": "string" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "Custom CMS page layout for the product detail page" + "description": { + "description": "Description of the rule.", + "type": "string" }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product", - "description": "Canonical product reference for variant consolidation and SEO purposes" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "media": { - "description": "Product images and media gallery", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "crossSellings": { - "description": "Cross-selling configurations (related products, accessories, similar items)", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } + "updatedAt": { + "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" + "extensions": { + "description": "To store additional data to a rule from extensions." + } + }, + "type": "object" + }, + "ProductJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource", + "required": [ + "options" + ], + "properties": { + "options": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group", + "option", + "translated" + ], + "properties": { + "group": { + "type": "string" + }, + "option": { + "type": "string" + }, + "translated": { + "type": "object", + "properties": { + "group": { + "type": "string" + }, + "option": { + "type": "string" + } + }, + "required": [ + "group", + "option" + ] + } + } + } + } } }, - "productReviews": { - "description": "Customer reviews and ratings for the product", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - }, - "mainCategories": { - "description": "Primary category assignments per sales channel for SEO and navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - }, - "seoUrls": { - "description": "SEO-friendly URLs for the product across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - }, - "options": { - "description": "Product variant options (e.g., size, color) that define different variants", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - }, - "properties": { - "description": "Product properties and characteristics for filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - }, - "categories": { - "description": "Categories this product is assigned to", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "streams": { - "description": "Dynamic product streams this product belongs to based on defined filters", - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - }, - "categoriesRo": { - "description": "Read-only category tree including all parent categories for optimized queries", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "tags": { - "description": "Tags for organizing and filtering products", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "seoCategory": { - "$ref": "#/components/schemas/Category", - "description": "Main category used for SEO URL generation in the current sales channel" - }, - "apiAlias": { - "type": "string", - "const": "product" - }, - "variantListingConfig": { - "oneOf": [ - { - "type": "object", - "properties": { - "displayParent": { - "type": "boolean" - } - } + { + "required": [ + "id", + "taxId", + "productNumber", + "stock", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ] - }, - "mainVariantId": { - "description": "Unique identity of main variant." - }, - "externalReference": { - "description": "External payment provider token." - } - }, - "type": "object" - }, - "CookieGroupCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CookieGroup" - } - }, - "MediaThumbnail": { - "description": "Added since version: 6.0.0.0", - "required": [ - "url", - "id", - "mediaId", - "width", - "height" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media thumbnail." - }, - "mediaId": { - "description": "Unique identity of media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaThumbnailSizeId": { - "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 - }, - "url": { - "description": "Public url of media thumbnail.", - "type": "string" - }, - "path": { - "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" - }, - "AggregationMetrics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "avg", - "count", - "max", - "min", - "stats", - "sum" - ] - }, - "field": { - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "CrossSellingElementCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CrossSellingElement" - }, - "properties": { - "total": { - "description": "Number of cross selling elements found." - } - } - }, - "CustomerAddressBody": { - "description": "Added since version: 6.0.0.0", - "required": [ - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "properties": { - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "street": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "additionalAddressLine1": { - "type": "string" - }, - "additionalAddressLine2": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "SalesChannelContext": { - "type": "object", - "properties": { - "token": { - "description": "Context the user session", - "type": "string" - }, - "currentCustomerGroup": { - "type": "object", - "description": "Customer group of the current user", - "properties": { - "name": { + "versionId": { "type": "string", - "description": "Name of customer group to which the customer belongs within the specific sales channel they are currently interacting with." + "pattern": "^[0-9a-f]{32}$" }, - "displayGross": { - "type": "boolean", - "description": "When `true`, product's gross price is displayed for that customer group who belongs to the specific sales channel they are currently interacting with." - } - } - }, - "fallbackCustomerGroup": { - "description": "Fallback group if the default customer group is not applicable", - "type": "object", - "properties": { - "name": { - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "displayGross": { - "type": "boolean" - } - } - }, - "currency": { - "$ref": "#/components/schemas/Currency", - "properties": { - "isoCode": { - "description": "Standard international three digit code to represent currency in a given sales channel. For example, USD." + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate in a specific sales channel the customer is currently interacting with." + "manufacturerId": { + "description": "Unique identity of the manufacturer.", + "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 - $ in a given sales channel." + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { - "description": "Acronym for international currencies, for example, USD in a given sales channel." + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Full name of the currency in a given sales channel. For example, US-Dollar." + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "The order of the tabs for multiple currencies defined in a given sales channel." + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "decimalPrecision": { - "description": "It defines the round off value for currency to the nearest decimal point in a given sales channel. If set to 2, it rounds off to two significant decimal points." + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria." - } - } - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel", - "properties": { - "typeId": { - "description": "Unique identity of a sales channel's type within a specific sales channel." + "deliveryTimeId": { + "description": "Unique identity of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "languageId": { - "description": "Unique identity of a sales channel's language within a specific sales channel." + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "description": "Unique identity of a sales channel's currency within a specific sales channel." + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of a sales channel's payment method within a specific sales channel." + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { - "description": "Unique identity of a sales channel's shipping method within a specific sales channel." + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of a sales channel's country within a specific sales channel." + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "navigationCategoryId": { - "description": "Unique identity of a sales channel's navigation category within a specific sales channel." + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", + "type": "string" }, - "navigationCategoryDepth": { - "description": "It determines the number of levels of subcategories in the storefront category menu within a specific sales channel." + "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" }, - "footerCategoryId": { - "description": "Unique identity of a sales channel's footer category within a specific sales channel." + "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", + "type": "boolean" }, - "serviceCategoryId": { - "description": "Unique identity of a sales channel's service category within a specific sales channel." + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", + "readOnly": true }, - "name": { - "description": "Name of the sales channel." + "isCloseout": { + "description": "When the value is set to true, the product is hidden when sold out.", + "type": "boolean" }, - "shortName": { - "description": "A short name for sales channel." + "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 }, - "accessKey": { - "description": "Access key to store api." + "stock": { + "description": "Indicates the number of products available.", + "type": "integer", + "format": "int64" }, - "active": { - "description": "When `true`, the sales channel is enabled." + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "maintenance": { - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", + "type": "string" }, - "maintenanceIpWhitelist": { - "description": "Array of IP address allowed to access the sales channel." + "ean": { + "description": "Indicates EAN of the product.", + "type": "string" }, - "mailHeaderFooterId": { - "description": "Unique identity of a sales channel's mail header and footer within a specific sales channel." + "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" }, - "customerGroupId": { - "description": "Unique identity of a sales channel's customer group within a specific sales channel." + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" }, - "hreflangActive": { - "description": "When `true`, the sales channel pages are available in different languages within a specific sales channel." + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" }, - "hreflangDefaultDomainId": { - "description": "Unique identity of a sales channel's hreflangDefaultDomain within a specific sales channel." + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" }, - "analyticsId": { - "description": "Unique identity of a sales channel's analytics within a specific sales channel." - } - } - }, - "measurementSystem": { - "$ref": "#/components/schemas/ContextMeasurementSystemInfo" - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - }, - "properties": { - "taxRate": { - "description": "Rate of tax within a specific sales channel." + "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" }, - "name": { - "description": "Name defined for a Tax within a specific sales channel." - } - } - }, - "customer": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/Customer" - } - ], - "properties": { - "groupId": { - "description": "Unique identity of a customer's group within a specific sales channel." - }, - "defaultPaymentMethodId": { - "description": "Unique identity of a customer's default payment method within a specific sales channel." - }, - "salesChannelId": { - "description": "Unique identity of sales channel the customer is currently interacting with." - }, - "languageId": { - "description": "Unique identity of language within a specific sales channel the customer is interacting." + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" }, - "lastPaymentMethodId": { - "description": "Unique identity of customer's last payment method within a specific sales channel." + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" }, - "defaultBillingAddressId": { - "description": "Unique identity of customer's default billing address within a specific sales channel." + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" }, - "defaultShippingAddressId": { - "description": "Unique identity of customer's default shipping address within a specific sales channel." + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" }, - "customerNumber": { - "description": "Name of the customer within a specific sales channel the customer is interacting." + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" }, - "salutationId": { - "description": "Unique identity of customer's default shipping address within a specific sales channel." + "length": { + "description": "The length of the product.", + "type": "number", + "format": "float" }, - "firstName": { - "description": "First name of the customer within a specific sales channel." + "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" }, - "lastName": { - "description": "Last name of the customer within a specific sales channel." + "ratingAverage": { + "description": "Average of all the ratings.", + "type": "number", + "format": "float", + "readOnly": true }, - "company": { - "description": "Company name of the customer within a specific sales channel." + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "password": { - "description": "Password of the customer within a specific sales channel." + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "email": { - "description": "Email of the customer within a specific sales channel." + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "title": { - "description": "Customer's title or honorifics like Mr, Mrs, etc within a specific sales channel." + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links within a specific sales channel." + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "campaignCode": { - "description": "A unique identifier for a campaign within a specific sales channel." + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "active": { - "description": "When `true`, the status of the customer is set active within a specific sales channel." + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "doubleOptInRegistration": { - "description": "When `true`, user subscriptions to an email marketing list is allowed within a specific sales channel." + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "doubleOptInEmailSentDate": { - "description": "Date and time when the double opt-in email was sent within a specific sales channel." + "metaDescription": { + "type": "string" }, - "doubleOptInConfirmDate": { - "description": "Date and time when the double opt-in email was confirmed within a specific sales channel." + "name": { + "type": "string" }, - "hash": { - "description": "Password hash for account recovery within a specific sales channel." + "keywords": { + "type": "string" }, - "guest": { - "description": "Boolean value is `true` for a guest account within a specific sales channel." + "description": { + "type": "string" }, - "firstLogin": { - "description": "Captures date and time of customer's first login within a specific sales channel." + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true }, - "lastLogin": { - "description": "Captures date and time of customer's last login within a specific sales channel." + "metaTitle": { + "type": "string" }, - "newsletter": { - "description": "When `true`, then the customer gets subscribe to the newsletter" + "packUnit": { + "type": "string" }, - "birthday": { - "description": "Captures customer's birthday details within a specific sales channel." + "packUnitPlural": { + "type": "string" }, - "lastOrderDate": { - "description": "Captures customer's last order date within a specific sales channel." + "customFields": { + "type": "object" }, - "orderCount": { - "description": "Captures the number of orders placed by a customer within a specific sales channel." + "ogTitle": { + "type": "string" }, - "legacyEncoder": { - "description": "encapsulates shop credentials when needed to migrate shop system from old instance to new instance" + "ogDescription": { + "type": "string" }, - "legacyPassword": { - "description": "Hashed password of the old shop system" + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string", + "enum": [ + "physical", + "digital" + ] }, - "autoIncrement": { - "description": "Internal field. " + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session." - } - } - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "properties": { - "pluginId": { - "description": "Unique identity of payment plugin within a specific sales channel." + "calculatedPrice": { + "type": "object" }, - "handlerIdentifier": { - "description": "Internal field that contains system identifier details for payment methods like Paypal." + "calculatedPrices": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "name": { - "description": "Name of the payment method within a specific sales channel." + "calculatedMaxPurchase": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" }, - "description": { - "description": "A short description about the payment method within a specific sales channel." + "calculatedCheapestPrice": { + "type": "object" }, - "position": { - "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc within a specific sales channel." + "isNew": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "active": { - "description": "When `true`, the payment method is available for usage within a specific sales channel." + "sortedProperties": { + "type": "object" }, - "availabilityRuleId": { - "description": "Unique identity of the rule for the payment method." + "measurements": { + "type": "object" }, - "mediaId": { - "description": "Unique identity of media used in payment method within a specific sales channel." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "formattedHandlerIdentifier": { - "description": "Internal field that contains system identifier details for payment methods like Paypal." - } - } - }, - "shippingLocation": { - "type": "object", - "properties": { - "apiAlias": { + "updatedAt": { "type": "string", - "const": "cart_delivery_shipping_location" + "format": "date-time", + "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod", - "properties": { - "name": { - "description": "Name of the shipping method within a specific sales channel." - }, - "active": { - "description": "When `true`, the shipping method is available for usage within a specific sales channel." - }, - "description": { - "description": "A short description about the shipping method within a specific sales channel." - }, - "trackingUrl": { - "description": "URL that allows to track packages for a specific sales channel." - }, - "deliveryTimeId": { - "description": "Unique identity of deliveryTime within a specific sales channel." - }, - "availabilityRuleId": { - "description": "Unique identity of the rule for the payment method." - }, - "mediaId": { - "description": "Unique identity of media used in shipping method within a specific sales channel." - } - } - }, - "context": { - "description": "Core context with general configuration values and state", - "type": "object", - "properties": { - "versionId": { - "type": "string", - "description": "Unique identity of context's version in a specific sales channel." - }, - "currencyId": { - "type": "string", - "description": "Unique identity of currency context in a specific sales channel." - }, - "currencyFactor": { - "type": "integer", - "description": "Unique identity of currency factor context in a specific sales channel." - }, - "currencyPrecision": { - "type": "integer", - "format": "int32", - "description": "It defines the round off value of currency to the nearest decimal point. If set to 2, it rounds off to two significant decimal points." - }, - "languageIdChain": { - "type": "array", - "items": { - "type": "string" - } - }, - "scope": { - "type": "string", - "description": "Scope defines if its related to system or user context." + "translated": { + "type": "object" }, - "source": { - "type": "object", - "required": [ - "salesChannelId", - "type" - ], + "relationships": { "properties": { - "type": { - "type": "string", - "enum": [ - "sales-channel", - "shop-api" - ] + "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" }, - "salesChannelId": { - "type": "string" - } - }, - "description": "When context is related to user in the source, then there is userId." - }, - "taxState": { - "type": "string", - "description": "Tax state can either be `gross` or `net`." - }, - "useCache": { - "type": "boolean", - "description": "When boolean value is `true`, caching is used." - } - } - }, - "itemRounding": { - "type": "object", - "required": [ - "decimals", - "interval", - "roundForNet", - "apiAlias" - ], - "properties": { - "apiAlias": { - "type": "string", - "const": "shopware_core_framework_data_abstraction_layer_pricing_cash_rounding_config" - }, - "decimals": { - "type": "integer", - "format": "int32" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - } - }, - "totalRounding": { - "type": "object", - "required": [ - "decimals", - "interval", - "roundForNet", - "apiAlias" - ], - "properties": { - "apiAlias": { - "type": "string", - "const": "shopware_core_framework_data_abstraction_layer_pricing_cash_rounding_config" - }, - "decimals": { - "type": "integer", - "format": "int32" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - } - }, - "languageInfo": { - "type": "object", - "required": [ - "localeCode", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "localeCode": { - "type": "string" - } - } - }, - "apiAlias": { - "type": "string", - "const": "sales_channel_context" - } - }, - "required": [ - "salesChannel", - "apiAlias", - "itemRounding", - "totalRounding", - "languageInfo" - ] - }, - "CookieRouteResponse": { - "type": "object", - "description": "Response containing cookie groups and their configuration hash.", - "properties": { - "apiAlias": { - "type": "string", - "const": "cookie_groups_hash" - }, - "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" - }, - "languageId": { - "type": "string", - "format": "uuid", - "description": "The language ID for which the cookie configuration was generated. Used to store hashes per language.", - "example": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" - } - }, - "required": [ - "elements", - "hash", - "languageId", - "apiAlias" - ], - "example": { - "apiAlias": "cookie_groups_hash", - "elements": [ - { - "isRequired": true, - "description": "Cookies required for this shop to function:", - "name": "Technically required", - "entries": [ - { - "name": "Session", - "hidden": false, - "cookie": "session-", - "apiAlias": "cookie_entry" - }, - { - "name": "Timezone", - "hidden": false, - "cookie": "timezone", - "apiAlias": "cookie_entry" - }, - { - "value": "1", - "expiration": 30, - "name": "Cookie preferences", - "hidden": true, - "cookie": "cookie-preference", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - }, - { - "isRequired": false, - "description": "Cookies used for statistics and shop performance metrics.", - "name": "Statistics", - "entries": [ - { - "value": "1", - "expiration": 30, - "name": "Google Analytics", - "hidden": false, - "cookie": "google-analytics-enabled", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - }, - { - "isRequired": false, - "description": "Allows Google to collect personal data for online advertising and marketing.", - "name": "Marketing", - "entries": [ - { - "value": "1", - "expiration": 30, - "name": "Google Advertising", - "hidden": false, - "cookie": "google-ads-enabled", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - }, - { - "isRequired": false, - "name": "Comfort features", - "entries": [ - { - "value": "1", - "expiration": 30, - "name": "YouTube video", - "hidden": false, - "cookie": "youtube-video", - "apiAlias": "cookie_entry" - } - ], - "apiAlias": "cookie_group" - } - ], - "hash": "f86b6a872cb83dbd22d838ceda1aa3d4", - "languageId": "2fbb5fe2e29a4d70aa5854ce7ce3e20b" - } - }, - "NavigationRouteResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - }, - "properties": { - "id": { - "description": "Unique identity of navigation route response." - } - } - }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" - }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "errors": { - "type": "object", - "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" + "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" + } + } + } }, - "key": { - "type": "string" + "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" + } + } + } + } }, - "level": { - "type": "number" + "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" + } + } + } }, - "message": { - "type": "string" + "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" + } + } + } }, - "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." - } - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } - }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", - "type": "array", - "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - }, - "properties": { - "paymentMethodId": { - "description": "Unique identity of payment method." - } - } - }, - "modified": { - "type": "boolean", - "description": "It signifies any changes to cart." - }, - "customerComment": { - "description": "A comment that can be added to the cart.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "affiliateCode": { - "description": "An affiliate tracking code", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "campaignCode": { - "description": "A campaign tracking code", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "apiAlias": { - "type": "string", - "const": "cart" - }, - "id": { - "description": "Unique identity of cart." - } - }, - "required": [ - "price", - "apiAlias" - ] - }, - "OrderRouteResponse": { - "type": "object", - "properties": { - "orders": { - "type": "object", - "allOf": [ - { - "type": "object", - "required": [ - "elements" - ], - "properties": { - "elements": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - { - "$ref": "#/components/schemas/EntitySearchResult" - } - ] - }, - "paymentChangeable": { - "type": "object", - "description": "The key-value pairs contain the uuid of the order as key and a boolean as value, indicating that the payment method can still be changed.", - "additionalProperties": { - "type": "boolean" - } - } - }, - "required": [ - "orders" - ] - }, - "CookieEntryCollection": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CookieEntry" - } - }, - "EntitySearchResult": { - "type": "object", - "properties": { - "entity": { - "type": "string" - }, - "total": { - "type": "integer", - "description": "The total number of found entities" - }, - "aggregations": { - "type": "array", - "description": "Contains aggregated data. A simple example is the determination of the average price from a product search query.", - "items": { - "type": "object" - } - }, - "page": { - "type": "integer", - "description": "The actual page. This can be used for pagination." - }, - "limit": { - "type": "integer", - "description": "The actual limit. This is used for pagination and goes together with the page." - } - } - }, - "AccountNewsletterRecipient": { - "type": "object", - "properties": { - "status": { - "$ref": "#/components/schemas/NewsletterStatus" - }, - "apiAlias": { - "type": "string", - "const": "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" - } - ] - } - } - } - ], - "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." - } - } - }, - "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." - } - } - }, - "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." - } - } - } - } - }, - "CartPriceQuantity": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "const": "cart_price_quantity" - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } - }, - "type": { - "type": "string" - } - }, - "required": [ - "apiAlias" - ] - }, - "Price": { - "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" - }, - "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" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "AggregationEntity": { - "title": "AggregationEntity", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "entity" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "definition": { - "description": "The entity definition e.g \"product_manufacturer\".", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field", - "definition" - ] - }, - "AggregationFilter": { - "title": "AggregationFilter", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "filter" - ] - }, - "filter": { - "type": "array", - "items": { - "$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" - }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "terms" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "limit": { - "description": "The number of terms to return", - "type": "number" - }, - "sort": { - "type": "array", - "description": "Sorting the aggregation result.", - "items": { - "$ref": "#/components/schemas/Sort" - } - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationHistogram": { - "title": "AggregationHistogram", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "histogram" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "interval": { - "description": "The interval of the histogram", - "type": "number" - }, - "format": { - "description": "The format of the histogram", - "type": "string" - }, - "timeZone": { - "description": "The timezone of the histogram", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "AggregationRange": { - "title": "AggregationRange", - "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string", - "enum": [ - "range" - ] - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - }, - "ranges": { - "description": "The ranges of the aggregation", - "type": "array", - "items": { - "type": "object", - "anyOf": [ - { - "type": "object", - "title": "From and to", - "properties": { - "from": { - "type": "number", - "description": "The lower bound of the range" - }, - "to": { - "type": "number", - "description": "The upper bound of the range" - } - }, - "required": [ - "from", - "to" - ] - }, - { - "type": "object", - "title": "From only", - "properties": { - "from": { - "type": "string", - "description": "The lower bound of the range" - } - }, - "required": [ - "from" - ] - }, - { - "type": "object", - "title": "To only", - "properties": { - "to": { - "type": "string", - "description": "The upper bound of the range" - } - }, - "required": [ - "to" - ] - } - ] - } - } - }, - "required": [ - "name", - "type", - "field", - "ranges" - ] - }, - "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" - } - } - }, - "NewsletterStatus": { - "type": "string", - "enum": [ - "notSet", - "optIn", - "optOut", - "direct", - "undefined" - ], - "description": "The subscription status. Possible values are: notSet, optIn, optOut, direct, undefined." - }, - "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" - ] - }, - "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", - "const": "cms_slot" - }, - "VersionId": { - "description": "Unique identity of CMS slot's version." - } - }, - "type": "object" - }, - "Customer": { - "description": "Added since version: 6.0.0.0", - "required": [ - "apiAlias", - "activeBillingAddress", - "activeShippingAddress", - "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer." - }, - "groupId": { - "description": "Unique identity of customer group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "lastPaymentMethodId": { - "description": "Unique identity of previous payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerNumber": { - "description": "Unique number assigned to identity a customer.", - "type": "string" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "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" - }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "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" - }, - "doubleOptInEmailSentDate": { - "description": "Date and time when the double opt-in email was sent.", - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "description": "Date and time when the double opt-in email was confirmed.", - "type": "string", - "format": "date-time" - }, - "hash": { - "description": "Password hash for account recovery.", - "type": "string" - }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", - "type": "boolean" - }, - "firstLogin": { - "description": "To capture date and time of customer's first login.", - "type": "string", - "format": "date-time" - }, - "lastLogin": { - "description": "To capture date and time of customer's last login.", - "type": "string", - "format": "date-time" - }, - "birthday": { - "description": "To capture customer's birthday details.", - "type": "string" - }, - "lastOrderDate": { - "description": "Captures last order date.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderCount": { - "description": "Captures the number of orders placed.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderTotalAmount": { - "description": "Sum of total amount to be paid.", - "type": "number", - "format": "float", - "readOnly": true - }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFields": { - "type": "object", - "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.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "group": { - "$ref": "#/components/schemas/CustomerGroup", - "description": "Customer group determining pricing and permissions" - }, - "language": { - "$ref": "#/components/schemas/Language", - "description": "Preferred language for customer communication" - }, - "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod", - "description": "Last used payment method by the customer" - }, - "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Default billing address for the customer" - }, - "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Currently active billing address in the session" - }, - "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Default shipping address for the customer" - }, - "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress", - "description": "Currently active shipping address in the session" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation", - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" - }, - "addresses": { - "description": "All addresses saved for the customer", - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "apiAlias": { - "type": "string", - "const": "customer" - }, - "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" - } - } - } - ] - }, - "CustomerAddressRead": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "oneOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "oneOf": [ - { - "$ref": "#/components/schemas/CountryState" - }, - { - "type": "null" - } - ] - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "required": [ - "customerId", - "createdAt", - "updatedAt", - "country", - "salutation" - ] - }, - "Order": { - "description": "Added since version: 6.0.0.0", - "required": [ - "documents", - "orderDate", - "stateMachineState", - "price", - "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order version." - }, - "orderNumber": { - "description": "Unique number associated with every order.", - "type": "string" - }, - "billingAddressId": { - "description": "Unique identity of the billing address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the billing address version." - }, - "primaryOrderDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderDeliveryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "primaryOrderTransactionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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." - }, - "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", - "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)." - }, - "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.", - "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" - } - }, - "billingAddress": { - "$ref": "#/components/schemas/OrderAddress", - "description": "Billing address for the order" - }, - "deliveries": { - "description": "Delivery information including shipping address and tracking", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - }, - "lineItems": { - "description": "Order line items (products, discounts, fees)", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - }, - "transactions": { - "description": "Payment transactions for the order", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - }, - "documents": { - "description": "Generated documents (invoices, delivery notes, credit notes)", - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - }, - "tags": { - "description": "Tags assigned to the order for organization and filtering", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "extensions": { - "description": "To store additional data to an order from extensions." - } - }, - "type": "object" - }, - "ProductMedia": { - "description": "Added since version: 6.0.0.0", - "required": [ - "media", - "id", - "productId", - "mediaId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "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" - }, - "CustomerAddress": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "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}$" - }, - "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" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "zipcode": { - "description": "Postal or zip code of customer's address.", - "type": "string" - }, - "city": { - "description": "Name of customer's city.", - "type": "string" - }, - "company": { - "description": "Name of customer's company.", - "type": "string" - }, - "street": { - "description": "Name of customer's street.", - "type": "string" - }, - "department": { - "description": "Name of customer's department.", - "type": "string" - }, - "title": { - "description": "Titles given to customer like Dr. , Prof., etc", - "type": "string" - }, - "phoneNumber": { - "description": "Customer's phone number.", - "type": "string" - }, - "additionalAddressLine1": { - "description": "Additional customer's address information.", - "type": "string" - }, - "additionalAddressLine2": { - "description": "Additional customer's address information.", - "type": "string" - }, - "hash": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, - "customFields": { - "type": "object", - "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", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "rawTotal": { - "type": "number" - }, - "totalPrice": { - "type": "number" - }, - "taxStatus": { - "type": "string", - "enum": [ - "net", - "tax-free" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "const": "cart_tax_calculated" - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" - }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "const": "cart_regulation_price" - } - } - }, - { - "type": "null" - } - ] - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "apiAlias": { - "type": "string", - "const": "calculated_price" - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules", - "rawTotal", - "taxStatus" - ] - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "const": "cart_list_price" - } - }, - "required": [ - "apiAlias" - ] - }, - "CartItems": { - "type": "object", - "required": [ - "items" - ], - "properties": { - "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." - } - } - } - } - }, - "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" - }, - "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" - } - } - } - } - } - }, - "properties": { - "name": { - "description": "Name of the shipping method." - }, - "active": { - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." - }, - "description": { - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc." - }, - "deliveryTimeId": { - "description": "Unique identity of the delivery time." - }, - "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." - } - } - }, - "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." - } - } - }, - "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." - } - } - }, - "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." - } - } - }, - "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." - }, - "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." - } - } - }, - "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." - } - } - } - } - }, - "CartDeliveryInformation": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "const": "cart_delivery_information" - }, - "freeDelivery": { - "type": "boolean" - }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { - "type": "string" - }, - "apiAlias": { - "type": "string", - "const": "cart_delivery_time" - } - } - }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" - }, - "restockTime": { - "type": "integer" - }, - "stock": { - "type": "integer" - }, - "weight": { - "type": "integer" - }, - "width": { - "type": "integer" - } - }, - "required": [ - "apiAlias" - ] - }, - "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}$" - }, - "cmsPageId": { - "description": "Unique identity of CMS page.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "openGraphMediaId": { - "description": "Media used as Open Graph image for social media sharing.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productNumber": { - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", - "type": "string" - }, - "restockTime": { - "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", - "type": "boolean" - }, - "available": { - "description": "Indicates weather the product is available or not.", - "type": "boolean", - "readOnly": true - }, - "isCloseout": { - "description": "When the value is set to true, the product is hidden when sold out.", - "type": "boolean" - }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "stock": { - "description": "Indicates the number of products available.", - "type": "integer", - "format": "int64" - }, - "displayGroup": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "manufacturerNumber": { - "description": "Unique number that describes the manufacturer.", - "type": "string" - }, - "ean": { - "description": "Indicates EAN of the product.", - "type": "string" - }, - "purchaseSteps": { - "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", - "type": "integer", - "format": "int64" - }, - "maxPurchase": { - "description": "Maximum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "minPurchase": { - "description": "Minimum number of items that can be purchased.", - "type": "integer", - "format": "int64" - }, - "purchaseUnit": { - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", - "type": "number", - "format": "float" - }, - "referenceUnit": { - "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", - "type": "number", - "format": "float" - }, - "shippingFree": { - "description": "Indicates weather the shipping price is free or not.", - "type": "boolean" - }, - "markAsTopseller": { - "description": "Indicates weather the product is top seller or not.", - "type": "boolean" - }, - "weight": { - "description": "The weight of the product.", - "type": "number", - "format": "float" - }, - "width": { - "description": "The width of the product.", - "type": "number", - "format": "float" - }, - "height": { - "description": "The height of the product.", - "type": "number", - "format": "float" - }, - "length": { - "description": "The length of the product.", - "type": "number", - "format": "float" - }, - "releaseDate": { - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", - "type": "string", - "format": "date-time" - }, - "ratingAverage": { - "description": "Average of all the ratings.", - "type": "number", - "format": "float", - "readOnly": true - }, - "categoryTree": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "categoryIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "sales": { - "description": "Frequency of the product sales.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "metaDescription": { - "type": "string" - }, - "name": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "description": { - "type": "string" - }, - "descriptionTeaser": { - "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", - "type": "string", - "readOnly": true - }, - "metaTitle": { - "type": "string" - }, - "packUnit": { - "type": "string" - }, - "packUnitPlural": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, - "type": { - "description": "The type of the product, e.g., physical or digital.", - "type": "string", - "enum": [ - "physical", - "digital" - ] - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "deprecated": true - }, - "calculatedPrice": { - "type": "object" - }, - "calculatedPrices": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "calculatedMaxPurchase": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "calculatedCheapestPrice": { - "type": "object" - }, - "isNew": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "sortedProperties": { - "type": "object" - }, - "measurements": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "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" + "type": "object" }, "manufacturer": { "description": "Product manufacturer or brand information", @@ -14391,148 +9868,2443 @@ }, "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" + "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" + } + ] + }, + "PromotionIndividualCode": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of promotion individual code." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "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" + ] + }, + "UserRecovery": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of user recovery." + }, + "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 property group." + }, + "name": { + "type": "string", + "description": "Name of the property group." + }, + "description": { + "type": "string", + "description": "Description on property group." + }, + "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", + "type": "string" + }, + "sortingType": { + "description": "Sorting the property group by name or position.", + "type": "string" + }, + "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", + "type": "boolean" + }, + "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", + "type": "boolean" + }, + "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." + }, + "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." + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + }, + "type": "object" + }, + "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 Product configurator setting." + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product configurator setting version." + }, + "productId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "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}$" + }, + "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", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "type": "object" + }, + "Association": { + "additionalProperties": { + "$ref": "#/components/schemas/Association" + } + }, + "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": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "type": "object" + }, + "Currency": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" + ], + "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" + }, + "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" + }, + "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." + }, + "configurationKey": { + "description": "Config key for shop configurations.", + "type": "string" + }, + "configurationValue": { + "properties": { + "_value": { + "type": "object", + "description": "Config value for shop configurations." + } + }, + "type": "object" + }, + "salesChannelId": { + "description": "Unique identity of 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 + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "Locale": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "code", + "name", + "territory" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "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 locale. For example: English." + }, + "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." + }, + "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" + }, + "TaxRule": { + "description": "Added since version: 6.1.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of tax rule." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Media": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "fileExtension", + "fileName", + "hasFile", + "path", + "private", + "url", + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of media." + }, + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" + }, + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" + }, + "uploadedAt": { + "description": "Date and time at which media was added.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "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 + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "height": { + "type": "integer", + "format": "int64" + }, + "width": { + "type": "integer", + "format": "int64" + } + }, + "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." + }, + "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." + }, + "thumbnails": { + "description": "Generated thumbnail images in various sizes", + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + }, + "apiAlias": { + "type": "string", + "const": "media" + }, + "extensions": { + "description": "To store additional data to a media from extensions." + } + }, + "type": "object" + }, + "ProductExport": { + "description": "Added since version: 6.1.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Exported Product." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CountryState": { + "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." + }, + "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", + "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" + }, + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "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 + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "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" + }, + "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" + }, + "ProductDownload": { + "description": "Added since version: 6.4.19.0", + "required": [ + "id", + "productId", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity downloaded product." + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of downloaded product's version." + }, + "productId": { + "description": "Unique identity of Product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "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." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "MailTemplate": { + "description": "Added since version: 6.0.0.0", + "required": [ + "subject", + "contentHtml", + "contentPlain" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of mail template." + }, + "systemDefault": { + "type": "boolean", + "description": "Unused field. To be removed in future." + }, + "senderName": { + "type": "string", + "description": "Name of the sender in the mail." + }, + "contentHtml": { + "type": "string", + "description": "HTML content in the mail." + }, + "contentPlain": { + "type": "string", + "description": "Textual content in the mail." + }, + "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." + }, + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } + } + }, + "type": "object" + }, + "SalesChannelFile": { + "description": "Added since version: 6.7.12.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "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 CMS page." + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS page version." + }, + "name": { + "type": "string", + "description": "Name of the CMS page." + }, + "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}$" + }, + "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." + }, + "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", + "const": "cms_page" + } + }, + "type": "object" + }, + "CmsBlock": { + "description": "Added since version: 6.0.0.0", + "required": [ + "apiAlias", + "slots", + "id", + "position", + "type", + "sectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "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" + }, + "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": { + "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}$" + }, + "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", + "const": "cms_block" + } + }, + "type": "object" + }, + "CustomField": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a custom field." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "languageId", + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "name", + "homeEnabled" + ], + "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}$" + }, + "navigationCategoryVersionId": { + "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}$" + }, + "footerCategoryVersionId": { + "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}$" + }, + "serviceCategoryVersionId": { + "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" + }, + "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." + }, + "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." + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" + }, + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" + }, + "country": { + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" + }, + "domains": { + "description": "Domain URLs configured for the sales channel", + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "navigationCategory": { + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" + }, + "footerCategory": { + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" + }, + "serviceCategory": { + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" + }, + "hreflangDefaultDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "type": "object" + }, + "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.", + "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", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Country": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of the country." + }, + "name": { + "type": "string", + "description": "Name of the country." + }, + "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", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "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" + }, + "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" + }, + "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", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + }, + "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`." + }, + "companyTaxFree": { + "description": "When a registered company is free from paying taxes, then the boolean value is `true`." + } + }, + "type": "object" + }, + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of App flow event." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ProductSorting": { + "description": "Added since version: 6.3.2.0", + "required": [ + "key", + "priority", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Product sorting." + }, + "key": { + "type": "string", + "description": "A keyword associated to identify product sorting." + }, + "priority": { + "type": "integer", + "format": "int64", + "description": "A numerical value to prioritize the product sorting." + }, + "label": { + "type": "string", + "description": "Label given to a product sorting." + }, + "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" + }, + "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." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "NavigationType": { + "type": "string", + "enum": [ + "main-navigation", + "footer-navigation", + "service-navigation" + ] + }, + "SuccessResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + } + }, + "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 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", + "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" + }, + "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." + }, + "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" + }, + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } + } + }, + "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" + }, + "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." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ReferencePrice": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "cart_price_reference" + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/ListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "cart_regulation_price" } + } + }, + { + "type": "null" + } + ] + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "oneOf": [ + { + "type": "string", + "format": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "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." + }, + "name": { + "description": "Name of snippet set.", + "type": "string" + }, + "iso": { + "description": "ISO nomenclature used to classify languages.", + "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 + }, + "snippets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + }, + "type": "object" + }, + "OrderAddress": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "countryId", + "firstName", + "lastName", + "street", + "city" + ], + "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." + }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "street": { + "description": "Street address", + "type": "string" + }, + "zipcode": { + "description": "Zip code of the country.", + "type": "string" + }, + "city": { + "description": "Name of the city.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "department": { + "description": "Name of the department.", + "type": "string" + }, + "title": { + "description": "Title name given to customer like DR. , Prof., etc.", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the customer.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional address input if necessary.", + "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", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "ListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "cart_list_price" + } + }, + "required": [ + "apiAlias" + ] + }, + "OrderLineItem": { + "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." + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of OrderLineItem's version." + }, + "orderId": { + "description": "Unique identity of order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order's version." + }, + "productId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of products's version." + }, + "promotionId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent product." + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "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" } }, - "type": "object" - } - ] - }, - "Sitemap": { - "type": "object", - "properties": { - "filename": { + "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", - "description": "Name of the file which holds a list of all URL's." + "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", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "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" + } }, - "created": { + "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" + "const": "order_line_item" + }, + "extensions": { + "type": "object", + "description": "To store additional data to an order line item from extensions." + }, + "translated": { + "type": "object" } }, - "required": [ - "filename", - "created" - ] - }, - "Association": { - "additionalProperties": { - "$ref": "#/components/schemas/Association" - } + "type": "object" }, - "Media": { + "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", - "fileExtension", - "fileName", - "hasFile", - "path", - "private", - "url", - "id" + "typeName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." - }, - "mimeType": { - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", - "type": "string" - }, - "fileExtension": { - "description": "Type of file indication. For example: jpeg, png.", - "type": "string" + "description": "Unique identity of number range's type." }, - "uploadedAt": { - "description": "Date and time at which media was added.", + "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, - "fileName": { - "description": "Name of the media file uploaded.", - "type": "string" - }, - "fileSize": { - "description": "Size of the file media file uploaded.", - "type": "integer", - "format": "int64", + "updatedAt": { + "type": "string", + "format": "date-time", "readOnly": true }, - "metaData": { + "translated": { "type": "object", - "readOnly": true, - "properties": { - "height": { - "type": "integer", - "format": "int64" - }, - "width": { - "type": "integer", - "format": "int64" - } - }, - "description": "Details of the media file uploaded." - }, - "config": { - "type": "object" - }, - "alt": { + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "TaxProvider": { + "description": "Added since version: 6.5.0.0", + "required": [ + "id", + "priority", + "name" + ], + "properties": { + "id": { "type": "string", - "description": "Alternate text for media." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of tax provider." }, - "title": { + "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", + "type": "boolean" + }, + "name": { "type": "string", - "description": "Title name give to the media." + "description": "Name of the tax provider." }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "priority": { + "description": "A numerical value to prioritize one the tax providers from the list.", + "type": "integer", + "format": "int64" }, - "path": { + "processUrl": { + "description": "External URL makes request to get tax info.", "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" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -14551,95 +12323,88 @@ "translated": { "type": "object", "description": "Contains the translations of all translated fields." - }, - "thumbnails": { - "description": "Generated thumbnail images in various sizes", - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - }, - "apiAlias": { - "type": "string", - "const": "media" - }, - "extensions": { - "description": "To store additional data to a media from extensions." } }, "type": "object" }, - "SeoUrl": { + "Language": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo" + "localeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Seo Url." + "description": "Unique identity of language." }, - "salesChannelId": { - "description": "Unique identity of sales channel.", + "parentId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of parent language." }, - "languageId": { - "description": "Unique identity of language.", + "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { - "description": "The key that references to product or category entity ID.", + "translationCodeId": { + "description": "Unique identity of translation code.", "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\"", + "name": { + "description": "Name of the language.", "type": "string" }, - "isCanonical": { - "description": "When set to true, search redirects to the main URL.", + "active": { "type": "boolean" }, - "isModified": { - "description": "When boolean value is `true`, the seo url is changed.", - "type": "boolean" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "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" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "error": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "parent": { + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "locale": { + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" + }, + "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" + }, + "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." }, "createdAt": { "type": "string", @@ -14652,61 +12417,18 @@ "readOnly": true } }, - "type": "object", - "title": "SeoUrlEntity" + "type": "object" }, - "CmsPage": { + "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", - "sections", - "id", - "type" + "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." - }, - "name": { - "type": "string", - "description": "Name of the CMS page." - }, - "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}$" - }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + "description": "Unique identity of number range." }, "createdAt": { "type": "string", @@ -14721,41 +12443,21 @@ "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", - "const": "cms_page" } }, "type": "object" }, - "CmsBlock": { + "Category": { "description": "Added since version: 6.0.0.0", "required": [ "apiAlias", - "slots", - "id", - "position", + "breadcrumb", + "children", + "childCount", + "translated", "type", - "sectionId" + "id", + "name" ], "properties": { "id": { @@ -14765,85 +12467,158 @@ "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS Block version." + "description": "Unique identity of category's version." }, - "cmsSectionVersionId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS Section version." + "description": "Unique identity of parent category." }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", + "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." + }, + "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" + "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 block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" + }, + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, "name": { - "description": "Unique name of the CMS Block.", - "type": "string" + "type": "string", + "description": "Name of the category." }, - "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" + "linkType": { + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ], + "description": "linkType : `external`, `category`, `product`, `landing_page`." }, - "marginBottom": { - "description": "Defines for the margin area on the bottom of an element.", - "type": "string" + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "When a particular category is clicked, it gets redirected to internal link." }, - "marginLeft": { - "description": "Defines for the margin area on the left of an element.", - "type": "string" + "externalLink": { + "type": "string", + "description": "When a particular category is clicked, it gets redirected to external link." }, - "marginRight": { - "description": "Defines the margin area on the right of an element.", - "type": "string" + "linkNewTab": { + "type": "boolean", + "description": "Category opens in a new tab of the browser." }, - "backgroundColor": { - "description": "Defines the background color of an element.", - "type": "string" + "description": { + "type": "string", + "description": "Information about the category." }, - "backgroundMediaId": { - "description": "Unique identity of background media.", + "metaTitle": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "A page title indexed by search engines and appears in search results listings." }, - "backgroundMediaMode": { - "description": "Background media mode accept values `cover`, `auto`, `contain`.", - "type": "string" + "metaDescription": { + "type": "string", + "description": "A short description of the page for search results listings." }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" + "keywords": { + "type": "string", + "description": "Keywords that help to search the category." }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sectionId": { - "description": "Unique identity of section.", + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS page's version." + }, + "customEntityTypeId": { "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." + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, + "seoUrl": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "createdAt": { "type": "string", @@ -14855,599 +12630,610 @@ "format": "date-time", "readOnly": true }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" + "translated": { + "type": "object", + "additionalProperties": true, + "properties": { + "breadcrumb": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "breadcrumb" + ], + "description": "Contains the translations of all translated fields." }, - "slots": { + "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/CmsSlot" + "$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", - "const": "cms_block" + "const": "category" } }, "type": "object" }, - "NavigationType": { - "type": "string", - "enum": [ - "main-navigation", - "footer-navigation", - "service-navigation" - ] - }, - "SuccessResponse": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - } - } - }, - "ReferencePrice": { - "type": "object", + "ProductKeywordDictionary": { + "description": "Added since version: 6.0.0.0", + "required": [ + "languageId", + "keyword" + ], "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" - }, - "price": { - "type": "number" - }, - "apiAlias": { + "id": { "type": "string", - "const": "cart_price_reference" - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/ListPrice" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "const": "cart_regulation_price" - } - } - }, - { - "type": "null" - } - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of product keyword." }, - "hasRange": { - "type": "boolean" + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "variantId": { - "oneOf": [ - { - "type": "string", - "format": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "keyword": { + "description": "The keywords that help to search the product.", + "type": "string" } }, - "required": [ - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] + "type": "object" }, - "ListPrice": { - "type": "object", - "description": "", + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "value", + "appId", + "localeId" + ], "properties": { - "discount": { - "type": "number" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of app snippet." }, - "percentage": { - "type": "number" + "value": { + "type": "string", + "description": "Value of App Administration Snippet." }, - "price": { - "type": "number" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of app in app snippet." }, - "apiAlias": { + "localeId": { "type": "string", - "const": "cart_list_price" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity that specifies the language and country." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "required": [ - "apiAlias" - ] + "type": "object" }, - "OrderLineItem": { + "DocumentType": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", "id", - "orderId", - "identifier", - "quantity", - "label", - "children", - "states" + "technicalName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderLineItem." + "description": "Unique identity of the document type." }, - "versionId": { + "name": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of OrderLineItem's version." + "description": "Name of the document type." }, - "orderId": { - "description": "Unique identity of order.", + "technicalName": { + "description": "Technical name of document type.", + "type": "string" + }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's version." + "format": "date-time", + "readOnly": true }, - "productId": { - "description": "Unique identity of product.", + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "CustomerRecovery": { + "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 the customer recovery account." }, - "productVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of products's version." + "format": "date-time", + "readOnly": true }, - "promotionId": { - "description": "Unique identity of product.", + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "Integration": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent product." + "format": "date-time", + "readOnly": true }, - "parentVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent's version." + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "LineItemType": { + "type": "string", + "deprecated": true, + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity" + ] + }, + "LineItem": { + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "coverId": { - "description": "Unique identity of cover image.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "cover": { + "$ref": "#/components/schemas/Media" }, - "identifier": { - "description": "It is a unique identity of an item in cart before its converted to an order.", + "dataContextHash": { "type": "string" }, - "referencedId": { - "description": "Unique identity of type of entity.", + "dataTimestamp": { "type": "string" }, - "quantity": { - "description": "Number of items of product.", - "type": "integer", - "format": "int64" + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { + "type": "string", + "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", + "description": "Unique identity of line item." }, "label": { - "description": "It is a typical product name given to the line item.", - "type": "string" + "type": "string", + "description": "It is a typical product name given to the line item." + }, + "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": { - "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": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "markAsTopseller": { - "type": "boolean" - }, - "optionIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "const": "calculated_price" }, - "options": { + "calculatedTaxes": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "const": "cart_tax_calculated" + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] } }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "productNumber": { - "type": "string" + "quantity": { + "type": "number" }, - "propertyIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] }, - "releaseDate": { - "type": "string", - "format": "date-time" + "regulationPrice": { + "oneOf": [ + { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "const": "cart_regulation_price" + } + } + }, + { + "type": "null" + } + ] }, - "stock": { - "type": "integer", - "format": "int64" + "totalPrice": { + "type": "number" }, - "streamIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "unitPrice": { + "type": "number" }, - "tagIds": { + "taxRules": { "type": "array", + "description": "Currently active tax rules and/or rates", "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" + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, - "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" + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] }, "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" + "$ref": "#/components/schemas/CartPriceQuantity" }, - "totalPrice": { - "description": "Cost of product based on quantity.", + "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" - ] + "description": "Number of items of product." }, - "customFields": { + "quantityInformation": { "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", - "format": "date-time", - "readOnly": true + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" + } + } }, - "updatedAt": { + "referencedId": { "type": "string", - "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" - } + "description": "Unique identity of type of entity." }, - "downloads": { - "description": "Digital downloads associated with this line item", - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } + "removable": { + "type": "boolean", + "description": "Allows the line item to be removable from the cart when set to true." }, - "parent": { - "$ref": "#/components/schemas/OrderLineItem" + "stackable": { + "type": "boolean", + "description": "Allows to change the quantity of the line item when set to true." }, - "children": { + "states": { + "deprecated": true, "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] } }, - "apiAlias": { - "type": "string", - "const": "order_line_item" - }, - "extensions": { - "type": "object", - "description": "To store additional data to an order line item from extensions." + "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." }, - "translated": { - "type": "object" + "uniqueIdentifier": { + "type": "string" } }, - "type": "object" + "required": [ + "id", + "type" + ] }, - "Category": { + "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": [ - "apiAlias", - "breadcrumb", - "children", - "childCount", - "translated", - "type", "id", - "name" + "email", + "firstName", + "lastName" ], "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 order customer." }, - "parentId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent category." + "description": "Unique identity of OrderCustomer's version." }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of parent category's version." + "email": { + "description": "Email address of the customer.", + "type": "string" }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", + "salutationId": { + "description": "Unique identity of salutation.", "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." + "firstName": { + "description": "First name of the customer.", + "type": "string" }, - "mediaId": { - "description": "Unique identity of media added to identify category.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "lastName": { + "description": "Last name of the customer.", + "type": "string" }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" + "company": { + "description": "Name of the company.", + "type": "string" }, - "breadcrumb": { + "title": { + "description": "Title name given to the customer like Dr, prof. etc.", + "type": "string" + }, + "vatIds": { "type": "array", "items": { - "type": "string", - "additionalProperties": false + "type": "string" }, - "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." + "description": "Unique identity of VAT." }, - "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 + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" }, - "path": { - "description": "A relative URL to the category.", + "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 }, - "childCount": { - "type": "number", - "format": "int64", - "readOnly": true, - "description": "Number of categories below the main category." + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "type": { - "description": "Type of categories like `page`, `folder`, `link`.", + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "Unit": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "shortCode", + "name" + ], + "properties": { + "id": { "type": "string", - "enum": [ - "page", - "link", - "folder" - ] - }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", - "type": "boolean" + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of Unit." }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" + "shortCode": { + "type": "string", + "description": "Short name for unit, e.g., m, kg." }, "name": { "type": "string", - "description": "Name of the category." + "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." }, - "linkType": { + "createdAt": { "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ], - "description": "linkType : `external`, `category`, `product`, `landing_page`." + "format": "date-time", + "readOnly": true }, - "internalLink": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "When a particular category is clicked, it gets redirected to internal link." + "format": "date-time", + "readOnly": true }, - "externalLink": { + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + } + }, + "type": "object" + }, + "AppMcpPrompt": { + "description": "Added since version: 6.7.11.0", + "required": [ + "label" + ], + "properties": { + "id": { "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." + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "createdAt": { "type": "string", - "description": "Information about the category." + "format": "date-time", + "readOnly": true }, - "metaTitle": { + "updatedAt": { "type": "string", - "description": "A page title indexed by search engines and appears in search results listings." + "format": "date-time", + "readOnly": true }, - "metaDescription": { + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "CustomFieldSetRelation": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", - "description": "A short description of the page for search results listings." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a custom field set relation." }, - "keywords": { + "createdAt": { "type": "string", - "description": "Keywords that help to search the category." + "format": "date-time", + "readOnly": true }, - "cmsPageId": { - "description": "Unique identity of CMS page.", + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { + "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 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 + "description": "Unique identity of promotion." }, - "seoUrl": { - "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", @@ -15461,336 +13247,325 @@ }, "translated": { "type": "object", - "additionalProperties": true, - "properties": { - "breadcrumb": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "breadcrumb" - ], "description": "Contains the translations of all translated fields." + } + }, + "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." }, - "parent": { - "$ref": "#/components/schemas/Category", - "description": "Unique identity of category." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "children": { - "description": "Child categories within this category for hierarchical navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CookieEntry": { + "type": "object", + "properties": { + "cookie": { + "type": "string" }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Category image or banner" + "value": { + "type": "string" }, - "tags": { - "description": "Tags for organizing and filtering categories", - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "expiration": { + "type": "integer" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the category" + "name": { + "type": "string" }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "description": { + "type": "string" + }, + "hidden": { + "type": "boolean" }, "apiAlias": { "type": "string", - "const": "category" + "const": "cookie_entry" } }, - "type": "object" - }, - "LineItemType": { - "type": "string", - "deprecated": true, - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" + "required": [ + "cookie", + "hidden", + "apiAlias" ] }, - "LineItem": { + "FindProductVariantRouteResponse": { "type": "object", "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/Media" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { + "foundCombination": { + "type": "object", + "properties": { + "variantId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of a variant." + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Available product variant options. For example, for variant `Size`, option would be `XS`, `S`, `M`, `L`, `XL`." + } + } + } + } + }, + "OrderTransactionCaptureRefund": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "captureId", + "stateId", + "amount" + ], + "properties": { + "id": { "type": "string", - "description": "Description of line items in an order." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture refund." }, - "good": { - "type": "boolean", - "description": "When set to true, it indicates the line item is physical else it is virtual." + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture refund's version." }, - "id": { + "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", - "description": "Unique identity of line item." + "pattern": "^[0-9a-f]{32}$" }, - "label": { + "captureVersionId": { "type": "string", - "description": "It is a typical product name given to the line item." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of order transaction capture's version." }, - "modified": { - "type": "boolean", - "description": "When boolean value is `true`, line items are said to be modified." + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "modifiedByApp": { - "type": "boolean" + "externalReference": { + "description": "External payment provider token. ", + "type": "string" }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" }, - "price": { - "type": "object", + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "apiAlias": { - "type": "string", - "const": "calculated_price" - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "const": "cart_tax_calculated" - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } + "unitPrice": { + "type": "number", + "format": "float", + "description": "Price of product per item (where, quantity=1)." }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "totalPrice": { + "type": "number", + "format": "float", + "description": "Cost of product based on quantity." }, "quantity": { - "type": "number" + "type": "integer", + "format": "int64", + "description": "Number of items of each product." + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" }, "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + "type": "object" }, - "regulationPrice": { - "oneOf": [ - { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "const": "cart_regulation_price" - } - } + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" }, - { - "type": "null" + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } - ] - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" + }, + "type": "object" }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" } - } + }, + "type": "object" } }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] + "type": "object" }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "quantity": { - "type": "number", - "description": "Number of items of product." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "quantityInformation": { - "type": "object", + "updatedAt": { + "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": { - "maxPurchase": { - "type": "number" + "calculatedTaxes": { + "description": "Contains calculated taxes based on shipping costs/methods." }, - "minPurchase": { - "type": "number" + "taxRules": { + "description": "Pricing based on multiple taxes." }, - "purchaseSteps": { - "type": "number" + "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." + } + } } } - }, - "referencedId": { + } + }, + "type": "object" + }, + "ImportExportProfile": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { "type": "string", - "description": "Unique identity of type of entity." - }, - "removable": { - "type": "boolean", - "description": "Allows the line item to be removable from the cart when set to true." + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of import-export profile." }, - "stackable": { - "type": "boolean", - "description": "Allows to change the quantity of the line item when set to true." + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "states": { - "deprecated": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "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." + "translated": { + "type": "object" }, - "uniqueIdentifier": { - "type": "string" + "Integration": { + "description": "Unique identity of integration." } }, - "required": [ - "id", - "type" - ] + "type": "object" }, - "CookieEntry": { - "type": "object", + "PromotionDiscountPrices": { + "description": "Added since version: 6.0.0.0", "properties": { - "cookie": { - "type": "string" - }, - "value": { - "type": "string" - }, - "expiration": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of promotion discount price." }, - "hidden": { - "type": "boolean" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "apiAlias": { + "updatedAt": { "type": "string", - "const": "cookie_entry" + "format": "date-time", + "readOnly": true } }, - "required": [ - "cookie", - "hidden", - "apiAlias" - ] + "type": "object" }, - "FindProductVariantRouteResponse": { - "type": "object", + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", + "required": [ + "label" + ], "properties": { - "foundCombination": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of app's flow action." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object", - "properties": { - "variantId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a variant." - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Available product variant options. For example, for variant `Size`, option would be `XS`, `S`, `M`, `L`, `XL`." - } - } + "description": "Contains the translations of all translated fields." } - } + }, + "type": "object" }, "CartDeliveryPosition": { "type": "object", @@ -15820,6 +13595,104 @@ } } }, + "ProductStreamFilter": { + "description": "Added since version: 6.0.0.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of product stream filter." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "MailHeaderFooter": { + "description": "Added since version: 6.0.0.0", + "required": [ + "name" + ], + "properties": { + "id": { + "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." + }, + "name": { + "type": "string", + "description": "Name of the MailHeaderFooter." + }, + "description": { + "type": "string", + "description": "Description of the MailHeaderFooter." + }, + "headerHtml": { + "type": "string", + "description": "HTML header content." + }, + "headerPlain": { + "type": "string", + "description": "Textual header content." + }, + "footerHtml": { + "type": "string", + "description": "HTML footer content." + }, + "footerPlain": { + "type": "string", + "description": "Textual footer content." + }, + "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" + }, + "AppTemplate": { + "description": "Added since version: 6.3.1.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of App template." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ @@ -15933,7 +13806,28 @@ }, "apiAlias": { "type": "string", - "const": "cms_section" + "const": "cms_section" + } + }, + "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" @@ -16097,6 +13991,79 @@ }, "type": "object" }, + "SalesChannelDomain": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "url", + "salesChannelId", + "languageId", + "currencyId", + "snippetSetId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of sales channel domain." + }, + "url": { + "description": "URL of the sales channel domain.", + "type": "string" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language used.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "description": "Unique identity of currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "snippetSetId": { + "description": "Unique identity of snippet set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, + "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", + "type": "boolean" + }, + "customFields": { + "type": "object", + "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 + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "salesChannelDefaultHreflang": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "LandingPage": { "description": "Added since version: 6.4.0.0", "required": [ @@ -16189,6 +14156,27 @@ }, "type": "object" }, + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of webhook event log." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, "CookieGroup": { "type": "object", "properties": { @@ -16238,6 +14226,165 @@ "apiAlias" ] }, + "Theme": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "author", + "active" + ], + "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": { + "type": "string", + "description": "Description of the theme." + }, + "labels": { + "type": "object", + "description": "Identification label given to theme." + }, + "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", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object", + "description": "Contains the translations of all translated fields." + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + }, + "ConfigValues": { + "description": "Chosen values for the configuration." + } + }, + "type": "object" + }, + "Webhook": { + "description": "Added since version: 6.3.1.0", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of webhook." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "AppActionButton": { + "description": "Added since version: 6.3.1.0", + "required": [ + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of app's action button." + }, + "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" + }, + "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." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, "OrderLineItemDownload": { "description": "Added since version: 6.4.19.0", "required": [ diff --git a/storeapi.summary.json b/storeapi.summary.json index cc31123..221aec3 100644 --- a/storeapi.summary.json +++ b/storeapi.summary.json @@ -121,7 +121,6 @@ "CartPriceQuantity", "CartPriceReference", "Category", - "CategoryJsonApi", "CmsBlock", "CmsPage", "CmsSection", @@ -133,15 +132,12 @@ "CookieGroupCollection", "CookieRouteResponse", "Country", - "CountryJsonApi", "CountryState", - "CountryStateJsonApi", "Criteria", "CrossSellingElement", "CrossSellingElementCollection", "Currency", "CurrencyCountryRounding", - "CurrencyJsonApi", "CustomEntity", "CustomField", "CustomFieldSet", @@ -150,7 +146,6 @@ "Customer", "CustomerAddress", "CustomerAddressBody", - "CustomerAddressJsonApi", "CustomerAddressRead", "CustomerGroup", "CustomerRecovery", @@ -177,9 +172,7 @@ "Includes", "Integration", "LandingPage", - "LandingPageJsonApi", "Language", - "LanguageJsonApi", "LineItem", "LineItemType", "ListPrice", @@ -190,7 +183,6 @@ "MailTemplateMedia", "MailTemplateType", "MainCategory", - "MainCategoryJsonApi", "MeasurementDisplayUnit", "MeasurementSystem", "MeasurementUnits", @@ -206,7 +198,6 @@ "NavigationRouteResponse", "NavigationType", "NewsletterRecipient", - "NewsletterRecipientJsonApi", "NewsletterStatus", "NoneFieldsCriteria", "Notification", @@ -233,7 +224,6 @@ "OrderTransactionCaptureRefundPosition", "OrderWarehouseGroup", "PaymentMethod", - "PaymentMethodJsonApi", "Plugin", "Price", "Product", @@ -286,14 +276,11 @@ "SalesChannelTrackingOrder", "SalesChannelType", "Salutation", - "SalutationJsonApi", "ScheduledTask", "Script", "SeoUrl", - "SeoUrlJsonApi", "SeoUrlTemplate", "ShippingMethod", - "ShippingMethodJsonApi", "ShippingMethodPageRouteResponse", "ShippingMethodPrice", "SimpleFilter",