From ca6c260539260b3dc61ea86109a99dd531cbd8cd Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Fri, 6 Feb 2026 16:17:15 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagCustomizedProducts-adminapi.json | 6490 ++++++++++++++---- SwagCustomizedProducts-adminapi.summary.json | 37 + 2 files changed, 5112 insertions(+), 1415 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 6640de0..7af63b5 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.6.1" + "version": "6.7.9999999-dev" }, "servers": [ { @@ -150,23 +150,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" @@ -227,14 +210,24 @@ "summary": "Search for the Swag Customized Products Template resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplate", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -428,23 +421,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" @@ -500,6 +476,86 @@ } } }, + "/aggregate/swag-customized-products-template": { + "post": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "Aggregate for the Swag Customized Products Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-configuration": { "get": { "tags": [ @@ -635,23 +691,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" @@ -712,14 +751,24 @@ "summary": "Search for the Swag Customized Products Template Configuration resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -913,23 +962,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" @@ -985,6 +1017,86 @@ } } }, + "/aggregate/swag-customized-products-template-configuration": { + "post": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-configuration-share": { "get": { "tags": [ @@ -1120,23 +1232,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" @@ -1197,14 +1292,24 @@ "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1398,23 +1503,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" @@ -1470,6 +1558,86 @@ } } }, + "/aggregate/swag-customized-products-template-configuration-share": { + "post": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-exclusion": { "get": { "tags": [ @@ -1605,23 +1773,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" @@ -1682,14 +1833,24 @@ "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1883,23 +2044,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" @@ -1955,6 +2099,86 @@ } } }, + "/aggregate/swag-customized-products-template-exclusion": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-exclusion-condition": { "get": { "tags": [ @@ -2090,23 +2314,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" @@ -2167,14 +2374,24 @@ "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2368,23 +2585,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" @@ -2440,6 +2640,86 @@ } } }, + "/aggregate/swag-customized-products-template-exclusion-condition": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion Condition" + ], + "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-exclusion-operator": { "get": { "tags": [ @@ -2575,23 +2855,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" @@ -2652,14 +2915,24 @@ "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2853,23 +3126,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" @@ -2925,6 +3181,86 @@ } } }, + "/aggregate/swag-customized-products-template-exclusion-operator": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion Operator" + ], + "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-option": { "get": { "tags": [ @@ -3060,23 +3396,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" @@ -3137,14 +3456,24 @@ "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOption", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3338,23 +3667,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" @@ -3410,6 +3722,86 @@ } } }, + "/aggregate/swag-customized-products-template-option": { + "post": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Aggregate for the Swag Customized Products Template Option resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOption", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-option-price": { "get": { "tags": [ @@ -3545,23 +3937,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" @@ -3622,14 +3997,24 @@ "summary": "Search for the Swag Customized Products Template Option Price resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3823,23 +4208,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" @@ -3895,6 +4263,86 @@ } } }, + "/aggregate/swag-customized-products-template-option-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-option-value": { "get": { "tags": [ @@ -4030,23 +4478,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" @@ -4107,14 +4538,24 @@ "summary": "Search for the Swag Customized Products Template Option Value resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4308,23 +4749,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Value resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" @@ -4380,6 +4804,86 @@ } } }, + "/aggregate/swag-customized-products-template-option-value": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/swag-customized-products-template-option-value-price": { "get": { "tags": [ @@ -4515,23 +5019,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" @@ -4592,14 +5079,24 @@ "summary": "Search for the Swag Customized Products Template Option Value Price resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4793,23 +5290,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" @@ -4864,6 +5344,233 @@ } } } + }, + "/aggregate/swag-customized-products-template-option-value-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/consents": { + "get": { + "tags": [ + "Consent Management", + "Experimental" + ], + "summary": "List all consents for current user", + "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "fetchConsents", + "responses": { + "200": { + "description": "List of consents with their status", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ConsentState" + }, + "example": { + "product_analytics": { + "name": "product_analytics", + "scopeName": "admin_user", + "identifier": "userId-12345", + "status": "accepted", + "actor": "userId-12345", + "updatedAt": "2024-01-15T10:20:30Z" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "requested", + "actor": null, + "updatedAt": null + } + } + } + } + } + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" + } + } + } + }, + "/consents/accept": { + "post": { + "tags": [ + "Consent Management", + "Experimental" + ], + "summary": "Accept a consent", + "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "acceptConsent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } + } + } + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } + } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" + } + } + } + }, + "/consents/revoke": { + "post": { + "tags": [ + "Consent Management", + "Experimental" + ], + "summary": "Revoke a consent", + "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "revokeConsent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } + } + } + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } + } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" + } + } + } } }, "components": { @@ -5227,9 +5934,7 @@ { "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -5237,19 +5942,21 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -5368,9 +6075,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -5378,19 +6083,21 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -5426,8 +6133,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "userId", - "aclRoleId", - "createdAt" + "aclRoleId" ], "properties": { "id": { @@ -5472,13 +6178,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -5487,34 +6189,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -5534,9 +6245,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -5546,12 +6259,34 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string" }, @@ -5565,10 +6300,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -5969,13 +6706,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -5984,34 +6717,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -6031,9 +6773,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -6043,12 +6787,34 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string" }, @@ -6062,10 +6828,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6165,7 +6933,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -6174,21 +6941,26 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6253,7 +7025,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -6262,21 +7033,26 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6310,8 +7086,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -6350,8 +7125,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -6396,7 +7170,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -6405,21 +7178,25 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object" }, "template": { + "description": "Template that defines app CMS block.", "type": "string" }, "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6484,7 +7261,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -6493,21 +7269,25 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object" }, "template": { + "description": "Template that defines app CMS block.", "type": "string" }, "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6542,7 +7322,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -6551,10 +7330,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app flow action.", "type": "string" }, "badge": { @@ -6579,7 +7360,7 @@ "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -6587,6 +7368,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -6694,7 +7476,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -6703,10 +7484,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app flow action.", "type": "string" }, "badge": { @@ -6731,7 +7514,7 @@ "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -6739,6 +7522,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -6792,8 +7576,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -6801,10 +7584,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, "aware": { @@ -6902,8 +7687,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -6911,10 +7695,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, "aware": { @@ -6959,8 +7745,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -6968,38 +7753,49 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Name of the app.", "type": "string" }, "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7116,8 +7912,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -7125,38 +7920,49 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Name of the app.", "type": "string" }, "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7194,7 +8000,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -7203,24 +8008,29 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, "script": { + "description": "Internal field.", "type": "string" }, "config": { "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7314,7 +8124,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -7323,24 +8132,29 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, "script": { + "description": "Internal field.", "type": "string" }, "config": { "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7380,8 +8194,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -7519,8 +8332,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -7579,8 +8391,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -7588,18 +8399,25 @@ "pattern": "^[0-9a-f]{32}$" }, "template": { + "description": "Template for an app.", "type": "string" }, "path": { + "description": "A relative URL to the app template.", "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7656,8 +8474,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -7665,18 +8482,25 @@ "pattern": "^[0-9a-f]{32}$" }, "template": { + "description": "Template for an app.", "type": "string" }, "path": { + "description": "A relative URL to the app template.", "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7702,10 +8526,6 @@ { "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -7726,6 +8546,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7734,10 +8555,12 @@ "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" }, "autoIncrement": { @@ -7754,11 +8577,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -7768,15 +8593,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "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" }, "cmsPageIdSwitched": { @@ -7823,6 +8652,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7831,6 +8661,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7854,6 +8685,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -7883,6 +8715,7 @@ "type": "object" }, "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -7914,6 +8747,7 @@ "type": "object" }, "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -8005,6 +8839,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering categories", "properties": { "links": { "type": "object", @@ -8036,6 +8871,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the category", "properties": { "links": { "type": "object", @@ -8218,6 +9054,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -8260,10 +9097,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -8284,6 +9117,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8292,10 +9126,12 @@ "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" }, "autoIncrement": { @@ -8312,11 +9148,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -8326,15 +9164,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "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" }, "cmsPageIdSwitched": { @@ -8381,6 +9223,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8389,6 +9232,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8410,16 +9254,19 @@ "type": "object" }, "parent": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." }, "children": { + "description": "Child categories within this category for hierarchical navigation", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" }, "products": { "type": "array", @@ -8434,13 +9281,15 @@ } }, "tags": { + "description": "Tags for organizing and filtering categories", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" }, "productStream": { "$ref": "#/components/schemas/ProductStream" @@ -8470,6 +9319,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -8521,53 +9371,72 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "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": { @@ -8585,20 +9454,13 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -8714,53 +9576,72 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "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": { @@ -8778,20 +9659,13 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -8826,8 +9700,7 @@ { "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -8842,12 +9715,15 @@ "type": "string" }, "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": { @@ -8859,6 +9735,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8884,6 +9761,7 @@ "relationships": { "properties": { "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -8915,6 +9793,7 @@ "type": "object" }, "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -8975,6 +9854,7 @@ "type": "object" }, "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -9079,8 +9959,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -9095,12 +9974,15 @@ "type": "string" }, "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": { @@ -9112,6 +9994,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9135,13 +10018,15 @@ "type": "object" }, "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "previewMedia": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, "categories": { "type": "array", @@ -9150,6 +10035,7 @@ } }, "landingPages": { + "description": "Landing pages using this CMS layout", "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" @@ -9181,47 +10067,64 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9242,14 +10145,6 @@ "customFields": { "type": "object" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -9365,47 +10260,64 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9426,14 +10338,6 @@ "customFields": { "type": "object" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -9470,8 +10374,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -9482,10 +10385,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -9502,13 +10414,7 @@ "readOnly": true }, "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9570,8 +10476,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -9582,10 +10487,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -9602,13 +10516,7 @@ "readOnly": true }, "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9640,8 +10548,6 @@ { "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -9654,34 +10560,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -9728,21 +10644,26 @@ "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": { @@ -9764,6 +10685,7 @@ "relationships": { "properties": { "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -9992,8 +10914,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -10006,34 +10926,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -10080,21 +11010,26 @@ "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": { @@ -10114,6 +11049,7 @@ "type": "object" }, "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { "$ref": "#/components/schemas/CountryState" @@ -10169,7 +11105,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -10178,20 +11113,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -10317,7 +11256,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -10326,20 +11264,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -10390,7 +11332,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -10400,13 +11341,16 @@ "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": { @@ -10416,6 +11360,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -10424,6 +11369,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -10721,7 +11667,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -10731,13 +11676,16 @@ "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": { @@ -10747,6 +11695,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -10755,6 +11704,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -10873,8 +11823,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -11016,8 +11965,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -11103,8 +12051,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -11112,6 +12059,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -11121,10 +12069,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11137,9 +12087,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -11166,8 +12118,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -11175,6 +12126,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -11184,10 +12136,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11200,9 +12154,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -11232,8 +12188,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -11241,25 +12196,37 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { "type": "boolean" }, "createdAt": { @@ -11347,8 +12314,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -11356,25 +12322,37 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { "type": "boolean" }, "createdAt": { @@ -11408,8 +12386,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -11417,22 +12394,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11582,8 +12564,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -11591,22 +12572,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11654,8 +12640,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -11663,10 +12648,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -11723,8 +12710,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -11732,10 +12718,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -11771,10 +12759,7 @@ "customerNumber", "firstName", "lastName", - "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "email" ], "properties": { "id": { @@ -11782,26 +12767,32 @@ "pattern": "^[0-9a-f]{32}$" }, "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}$" }, @@ -11811,86 +12802,98 @@ "readOnly": true }, "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": { - "type": "string" - }, - "company": { + "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" }, - "vatIds": { - "type": "array", - "items": { - "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 customer 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 @@ -11899,6 +12902,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -11910,16 +12914,15 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -11928,10 +12931,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -11945,6 +12944,7 @@ "relationships": { "properties": { "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -12003,6 +13003,7 @@ "type": "object" }, "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -12032,6 +13033,7 @@ "type": "object" }, "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -12061,6 +13063,7 @@ "type": "object" }, "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { "links": { "type": "object", @@ -12089,7 +13092,38 @@ }, "type": "object" }, + "activeBillingAddress": { + "description": "Currently active billing address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } + } + }, + "type": "object" + }, "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -12118,7 +13152,38 @@ }, "type": "object" }, + "activeShippingAddress": { + "description": "Currently active shipping address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } + } + }, + "type": "object" + }, "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -12148,6 +13213,7 @@ "type": "object" }, "addresses": { + "description": "All addresses saved for the customer", "properties": { "links": { "type": "object", @@ -12210,6 +13276,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -12477,35 +13544,6 @@ } }, "type": "object" - }, - "defaultPaymentMethod": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultPaymentMethod" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8f35e31802b72bf010a333999b26f3a6" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -12527,10 +13565,7 @@ "customerNumber", "firstName", "lastName", - "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "email" ], "properties": { "id": { @@ -12538,26 +13573,32 @@ "pattern": "^[0-9a-f]{32}$" }, "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}$" }, @@ -12567,86 +13608,98 @@ "readOnly": true }, "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": { - "type": "string" - }, - "company": { + "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" }, - "vatIds": { - "type": "array", - "items": { - "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 customer 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 @@ -12655,6 +13708,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -12666,16 +13720,15 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -12684,10 +13737,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -12699,27 +13748,42 @@ "readOnly": true }, "group": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$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" + "$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" + "$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" @@ -12732,6 +13796,7 @@ } }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -12769,9 +13834,6 @@ }, "updatedBy": { "$ref": "#/components/schemas/User" - }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" @@ -12790,8 +13852,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -12799,52 +13860,71 @@ "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": { @@ -12995,8 +14075,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -13004,52 +14083,71 @@ "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": { @@ -13089,7 +14187,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -13101,12 +14198,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -13241,7 +14340,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -13253,12 +14351,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -13311,8 +14411,7 @@ "description": "Added since version: 6.3.1.0", "required": [ "customerGroupId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -13351,8 +14450,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -13360,9 +14458,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13420,8 +14520,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -13429,9 +14528,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13489,8 +14590,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -13498,10 +14598,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13622,8 +14724,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -13631,10 +14732,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13676,8 +14779,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -13685,6 +14787,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13693,6 +14796,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13779,8 +14883,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -13788,6 +14891,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13796,6 +14900,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13830,8 +14935,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -13842,14 +14946,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -13947,8 +15054,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -13959,14 +15065,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -14010,11 +15119,9 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -14025,9 +15132,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -14040,6 +15144,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -14220,6 +15328,35 @@ } }, "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -14234,11 +15371,9 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -14249,9 +15384,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -14264,6 +15396,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -14313,6 +15449,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -14327,9 +15466,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -14337,26 +15474,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "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" }, "config": { @@ -14407,6 +15551,7 @@ "type": "object" }, "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -14479,9 +15624,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -14489,26 +15632,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "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" }, "config": { @@ -14531,7 +15681,8 @@ "$ref": "#/components/schemas/DocumentType" }, "logo": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Logo in the document at the top-right corner." }, "salesChannels": { "type": "array", @@ -14551,8 +15702,7 @@ { "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -14560,14 +15710,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14682,8 +15835,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -14691,14 +15843,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14734,7 +15889,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -14746,6 +15900,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -14872,7 +16027,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -14884,6 +16038,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -14933,8 +16088,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -14942,29 +16096,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15053,8 +16214,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -15062,29 +16222,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15119,8 +16286,7 @@ { "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -15128,24 +16294,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -15234,6 +16405,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -15334,8 +16506,7 @@ "description": "Added since version: 6.4.6.0", "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -15343,24 +16514,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -15395,7 +16571,8 @@ "$ref": "#/components/schemas/Rule" }, "parent": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "children": { "type": "array", @@ -15418,8 +16595,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -15427,6 +16603,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -15451,8 +16628,7 @@ "description": "Added since version: 6.4.18.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -15460,6 +16636,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -15489,8 +16666,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -15498,20 +16674,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -15569,8 +16750,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -15578,20 +16758,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -15622,8 +16807,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -15840,8 +17024,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -15923,37 +17106,45 @@ { "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -15965,12 +17156,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -16029,37 +17214,45 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -16071,12 +17264,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -16110,8 +17297,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -16119,25 +17305,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -16218,6 +17410,37 @@ }, "type": "object" }, + "stateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "c78c7ea361b7def0876b75bd1bd37879" + } + } + } + } + }, + "type": "object" + }, "aclRoles": { "properties": { "links": { @@ -16263,8 +17486,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -16272,25 +17494,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -16343,6 +17571,12 @@ "app": { "$ref": "#/components/schemas/App" }, + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, "aclRoles": { "type": "array", "items": { @@ -16389,7 +17623,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -16481,6 +17714,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -16541,6 +17775,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -16583,7 +17818,6 @@ "description": "Added since version: 6.4.0.0", "required": [ "id", - "createdAt", "name", "url" ], @@ -16648,7 +17882,8 @@ } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", @@ -16657,6 +17892,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -16739,8 +17975,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -16752,16 +17987,22 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -16778,6 +18019,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -16807,6 +18049,7 @@ "type": "object" }, "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -16836,6 +18079,7 @@ "type": "object" }, "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -16865,6 +18109,7 @@ "type": "object" }, "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -17216,8 +18461,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -17229,16 +18473,22 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -17253,15 +18503,19 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, "locale": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, "translationCode": { - "$ref": "#/components/schemas/Locale" + "$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" @@ -17337,7 +18591,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -17347,6 +18600,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -17448,7 +18702,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -17458,6 +18711,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -17505,8 +18759,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -17514,9 +18767,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -17547,8 +18802,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -17556,9 +18810,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -17593,7 +18849,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -17680,7 +18935,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -17741,7 +18995,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -17864,7 +19117,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -17972,7 +19224,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -17984,6 +19235,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -18054,7 +19306,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -18066,6 +19317,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -18110,8 +19362,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -18119,6 +19370,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18127,6 +19379,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18135,6 +19388,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18251,8 +19505,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -18260,6 +19513,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18268,6 +19522,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18276,6 +19531,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18301,6 +19557,289 @@ }, "type": "object" }, + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "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" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "measurementSystem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_system" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c0484ac171c930ce54e78cd2e0d80e5a" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "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" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" + } + }, + "type": "object" + }, + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "units": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_display_unit" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "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" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "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" + }, "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -18309,8 +19848,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -18318,31 +19856,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "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": { - "type": "string", - "readOnly": true + "description": "Name of the media file uploaded.", + "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -18376,11 +19918,15 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -18526,6 +20072,7 @@ "type": "object" }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "properties": { "links": { "type": "object", @@ -19141,6 +20688,37 @@ }, "type": "object" }, + "a11yDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "f6c460e0d75110fa1ec7529fe364dbb5" + } + } + } + } + }, + "type": "object" + }, "appPaymentMethods": { "properties": { "links": { @@ -19214,8 +20792,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -19223,31 +20800,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "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": { - "type": "string", - "readOnly": true + "description": "Name of the media file uploaded.", + "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -19281,11 +20862,15 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -19404,6 +20989,7 @@ } }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" @@ -19517,6 +21103,12 @@ "$ref": "#/components/schemas/Document" } }, + "a11yDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, "appPaymentMethods": { "type": "array", "items": { @@ -19541,8 +21133,7 @@ { "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -19550,6 +21141,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -19608,8 +21200,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -19617,6 +21208,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -19648,8 +21240,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -19657,13 +21248,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -19677,10 +21271,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -19699,6 +21295,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -19860,8 +21457,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -19869,13 +21465,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -19889,10 +21488,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -19909,7 +21510,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." }, "children": { "type": "array", @@ -19940,8 +21542,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -19949,16 +21550,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -20052,8 +21657,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -20061,16 +21665,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -20171,8 +21779,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20180,21 +21787,28 @@ "pattern": "^[0-9a-f]{32}$" }, "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": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -20243,6 +21857,35 @@ } }, "type": "object" + }, + "mediaThumbnailSize": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail_size" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0d0b8659a3a47e9d7e1481961f127fd0" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -20258,8 +21901,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20267,21 +21909,28 @@ "pattern": "^[0-9a-f]{32}$" }, "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": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -20302,6 +21951,9 @@ }, "media": { "$ref": "#/components/schemas/Media" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" @@ -20316,8 +21968,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20325,10 +21976,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -20377,6 +22030,37 @@ } }, "type": "object" + }, + "mediaThumbnails": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -20391,8 +22075,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20400,10 +22083,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -20425,6 +22110,12 @@ "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } + }, + "mediaThumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } } }, "type": "object" @@ -20442,8 +22133,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -20451,48 +22141,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20642,8 +22345,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -20651,48 +22353,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20762,8 +22477,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -20771,12 +22485,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -20787,10 +22504,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20877,8 +22596,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -20886,12 +22604,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -20902,10 +22623,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20941,7 +22664,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -20950,10 +22672,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -20963,9 +22687,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -21092,7 +22818,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -21101,10 +22826,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -21114,9 +22841,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -21161,8 +22890,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -21170,14 +22898,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21293,8 +23024,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -21302,14 +23032,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21345,8 +23078,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -21354,6 +23086,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21415,8 +23148,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -21424,6 +23156,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21457,7 +23190,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -21466,12 +23198,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -21567,7 +23301,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -21576,12 +23309,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -21632,8 +23367,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -21650,9 +23384,11 @@ "readOnly": true }, "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}$" }, @@ -21660,23 +23396,44 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "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 }, @@ -21718,21 +23475,25 @@ "type": "object" }, "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 }, @@ -21794,30 +23555,44 @@ "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" + }, + "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21831,10 +23606,12 @@ "type": "object" }, "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}$" }, @@ -21893,6 +23670,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -21921,7 +23699,68 @@ }, "type": "object" }, + "primaryOrderDelivery": { + "description": "Primary delivery information for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" + } + } + } + }, + "type": "object" + }, + "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbaa9e50388c524d97853a4fc4476b0e" + } + } + } + }, + "type": "object" + }, "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -21951,6 +23790,7 @@ "type": "object" }, "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -21980,6 +23820,7 @@ "type": "object" }, "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -22038,6 +23879,7 @@ "type": "object" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -22069,6 +23911,7 @@ "type": "object" }, "billingAddress": { + "description": "Billing address for the order", "properties": { "links": { "type": "object", @@ -22098,6 +23941,7 @@ "type": "object" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", @@ -22129,6 +23973,7 @@ "type": "object" }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", @@ -22160,6 +24005,7 @@ "type": "object" }, "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -22191,6 +24037,7 @@ "type": "object" }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -22222,6 +24069,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -22330,8 +24178,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -22348,9 +24195,11 @@ "readOnly": true }, "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}$" }, @@ -22358,23 +24207,44 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "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 }, @@ -22416,21 +24286,25 @@ "type": "object" }, "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 }, @@ -22492,30 +24366,44 @@ "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" + }, + "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22529,10 +24417,12 @@ "type": "object" }, "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}$" }, @@ -22589,54 +24479,73 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/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" + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$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" @@ -22665,8 +24574,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -22678,14 +24586,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22694,43 +24605,60 @@ "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" }, "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" }, "vatId": { + "description": "Unique identity of VAT.", "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": { @@ -22912,8 +24840,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -22925,14 +24852,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22941,43 +24871,60 @@ "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" }, "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" }, "vatId": { + "description": "Unique identity of VAT.", "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": { @@ -23026,8 +24973,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -23039,10 +24985,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23051,22 +24999,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -23076,12 +25030,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -23198,8 +25154,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -23211,10 +25166,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23223,22 +25180,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -23248,12 +25211,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -23291,10 +25256,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -23306,6 +25269,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23314,6 +25278,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23322,10 +25287,12 @@ "pattern": "^[0-9a-f]{32}$" }, "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}$" }, @@ -23336,10 +25303,12 @@ } }, "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" }, @@ -23416,6 +25385,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -23474,6 +25444,7 @@ "type": "object" }, "shippingOrderAddress": { + "description": "Shipping address for this delivery", "properties": { "links": { "type": "object", @@ -23503,6 +25474,7 @@ "type": "object" }, "shippingMethod": { + "description": "Shipping method used for this delivery", "properties": { "links": { "type": "object", @@ -23532,6 +25504,7 @@ "type": "object" }, "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -23561,6 +25534,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -23578,10 +25580,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -23593,6 +25593,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23601,6 +25602,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23609,10 +25611,12 @@ "pattern": "^[0-9a-f]{32}$" }, "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}$" }, @@ -23623,10 +25627,12 @@ } }, "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" }, @@ -23701,22 +25707,29 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, "shippingMethod": { - "$ref": "#/components/schemas/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" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -23731,8 +25744,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -23744,6 +25756,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23752,6 +25765,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23817,14 +25831,17 @@ "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" }, @@ -23914,8 +25931,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -23927,6 +25943,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23935,6 +25952,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24000,14 +26018,17 @@ "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" }, @@ -24046,11 +26067,9 @@ "identifier", "quantity", "label", - "position", - "states", "price", "children", - "createdAt" + "states" ], "properties": { "id": { @@ -24062,6 +26081,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24070,6 +26090,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24078,6 +26099,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24090,44 +26112,47 @@ "pattern": "^[0-9a-f]{32}$" }, "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" }, "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" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -24189,22 +26214,33 @@ "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" }, "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" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -24218,6 +26254,7 @@ "relationships": { "properties": { "cover": { + "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", @@ -24276,6 +26313,7 @@ "type": "object" }, "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -24334,6 +26372,7 @@ "type": "object" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", @@ -24396,6 +26435,7 @@ "type": "object" }, "downloads": { + "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", @@ -24502,11 +26542,9 @@ "identifier", "quantity", "label", - "position", - "states", "price", "children", - "createdAt" + "states" ], "properties": { "id": { @@ -24518,6 +26556,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24526,6 +26565,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24534,6 +26574,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24546,44 +26587,47 @@ "pattern": "^[0-9a-f]{32}$" }, "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" }, "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" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -24645,22 +26689,33 @@ "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" }, "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" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -24672,18 +26727,21 @@ "readOnly": true }, "cover": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, "product": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -24696,6 +26754,7 @@ } }, "downloads": { + "description": "Digital downloads associated with this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -24725,8 +26784,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -24738,6 +26796,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24746,14 +26805,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -24844,8 +26906,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -24857,6 +26918,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24865,14 +26927,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -24941,8 +27006,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -24954,6 +27018,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24962,6 +27027,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25026,6 +27092,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25045,6 +27112,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -25103,6 +27171,7 @@ "type": "object" }, "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -25132,6 +27201,7 @@ "type": "object" }, "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -25161,6 +27231,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -25177,8 +27276,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -25190,6 +27288,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25198,6 +27297,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25262,6 +27362,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25279,19 +27380,25 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "paymentMethod": { - "$ref": "#/components/schemas/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" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -25307,8 +27414,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25320,6 +27426,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25328,10 +27435,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -25509,8 +27618,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25522,6 +27630,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25530,10 +27639,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -25632,8 +27743,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25645,6 +27755,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25653,13 +27764,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -25837,8 +27951,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25850,6 +27963,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25858,13 +27972,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -25963,8 +28080,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25976,6 +28092,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25984,6 +28101,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25992,12 +28110,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -26145,8 +28266,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -26158,6 +28278,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26166,6 +28287,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26174,12 +28296,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -26271,7 +28396,7 @@ { "required": [ "id", - "createdAt", + "technicalName", "name" ], "properties": { @@ -26280,10 +28405,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -26297,23 +28424,28 @@ "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" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26322,38 +28454,13 @@ "type": "string", "readOnly": true }, - "synchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "asynchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "prepared": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "refundable": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "recurring": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -26370,6 +28477,7 @@ "relationships": { "properties": { "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -26621,7 +28729,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", + "technicalName", "name" ], "properties": { @@ -26630,10 +28738,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -26647,23 +28757,28 @@ "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" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26672,38 +28787,13 @@ "type": "string", "readOnly": true }, - "synchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "asynchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "prepared": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "refundable": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true - }, - "recurring": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -26718,7 +28808,8 @@ "type": "object" }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" @@ -26769,7 +28860,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -26778,46 +28868,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -26903,7 +29006,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -26912,46 +29014,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -27010,7 +29125,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -27031,6 +29145,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27039,14 +29154,17 @@ "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}$" }, @@ -27055,14 +29173,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27071,6 +29192,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27079,12 +29201,17 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "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" }, @@ -27094,21 +29221,26 @@ "readOnly": true }, "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" }, @@ -27119,6 +29251,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -27129,61 +29262,79 @@ "type": "object" }, "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" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "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 @@ -27242,20 +29393,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -27290,6 +29436,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -27340,6 +29498,7 @@ "relationships": { "properties": { "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -27371,6 +29530,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -27400,6 +29560,7 @@ "type": "object" }, "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -27431,6 +29592,7 @@ "type": "object" }, "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -27460,6 +29622,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -27489,6 +29652,7 @@ "type": "object" }, "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -27518,6 +29682,7 @@ "type": "object" }, "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -27547,6 +29712,7 @@ "type": "object" }, "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", @@ -27605,6 +29771,7 @@ "type": "object" }, "cmsPage": { + "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", @@ -27634,6 +29801,7 @@ "type": "object" }, "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", @@ -27694,6 +29862,7 @@ "type": "object" }, "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -27725,6 +29894,7 @@ "type": "object" }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -27787,6 +29957,7 @@ "type": "object" }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -27880,6 +30051,7 @@ "type": "object" }, "productReviews": { + "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", @@ -27911,6 +30083,7 @@ "type": "object" }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -27942,6 +30115,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -28035,6 +30209,7 @@ "type": "object" }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -28066,6 +30241,7 @@ "type": "object" }, "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -28097,6 +30273,7 @@ "type": "object" }, "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -28128,6 +30305,7 @@ "type": "object" }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -28159,6 +30337,7 @@ "type": "object" }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -28190,6 +30369,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -28267,7 +30447,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -28288,6 +30467,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28296,14 +30476,17 @@ "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}$" }, @@ -28312,14 +30495,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28328,6 +30514,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28336,12 +30523,17 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "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" }, @@ -28351,21 +30543,26 @@ "readOnly": true }, "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" }, @@ -28376,6 +30573,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -28386,61 +30584,79 @@ "type": "object" }, "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" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "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 @@ -28499,20 +30715,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -28547,6 +30758,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -28595,43 +30818,53 @@ "type": "object" }, "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "parent": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, "children": { + "description": "Product variants that inherit from this parent product", "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, "unit": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, "cover": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" }, "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" }, "prices": { "type": "array", @@ -28640,12 +30873,14 @@ } }, "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" @@ -28658,6 +30893,7 @@ } }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -28676,18 +30912,21 @@ } }, "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" @@ -28706,36 +30945,42 @@ } }, "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" @@ -28832,8 +31077,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -28845,6 +31089,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28853,10 +31098,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28864,6 +31111,7 @@ "type": "object" }, "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" }, @@ -28982,8 +31230,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -28995,6 +31242,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29003,10 +31251,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29014,6 +31264,7 @@ "type": "object" }, "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" }, @@ -29052,10 +31303,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29066,26 +31314,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29094,6 +31349,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29214,10 +31470,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29228,26 +31481,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29256,6 +31516,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29297,8 +31558,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29306,10 +31566,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29318,6 +31580,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -29404,8 +31667,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29413,10 +31675,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29425,6 +31689,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -29489,8 +31754,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -29502,6 +31766,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29510,10 +31775,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -29603,8 +31870,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -29616,6 +31882,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29624,10 +31891,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -29672,8 +31941,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -29681,64 +31949,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -29920,8 +32206,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -29929,64 +32214,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -30026,7 +32329,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30101,7 +32403,6 @@ "description": "Added since version: 6.3.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30158,13 +32459,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { @@ -30219,13 +32523,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "language": { @@ -30243,7 +32550,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30256,6 +32562,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30358,7 +32665,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30371,6 +32677,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30421,8 +32728,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -30434,6 +32740,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30442,10 +32749,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -30566,8 +32875,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -30579,6 +32887,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30587,10 +32896,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -30666,8 +32977,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -30679,6 +32989,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30687,17 +32998,23 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -30789,8 +33106,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -30802,6 +33118,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30810,17 +33127,23 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -30891,8 +33214,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -30900,6 +33222,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30908,37 +33231,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "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": { @@ -31088,8 +33421,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -31097,6 +33429,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31105,37 +33438,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "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": { @@ -31175,10 +33518,7 @@ { "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -31186,13 +33526,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -31286,10 +33629,7 @@ "description": "Added since version: 6.3.5.0", "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -31297,13 +33637,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -31345,11 +33688,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -31357,23 +33696,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -31460,11 +33805,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -31472,23 +33813,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -31523,8 +33870,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -31536,10 +33882,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31548,9 +33896,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -31639,8 +33989,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -31652,10 +34001,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31664,9 +34015,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -31702,7 +34055,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -31755,7 +34107,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -31807,7 +34158,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31820,6 +34170,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -31832,6 +34183,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -31983,7 +34338,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31996,6 +34350,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -32008,6 +34363,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -32058,8 +34417,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -32067,6 +34425,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32075,21 +34434,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -32138,6 +34502,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -32210,8 +34575,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -32219,6 +34583,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32227,21 +34592,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -32262,7 +34632,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -32348,8 +34719,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -32357,6 +34727,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32365,10 +34736,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { + "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", "format": "int64" }, @@ -32456,8 +34829,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -32465,6 +34837,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32473,10 +34846,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { + "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", "format": "int64" }, @@ -32508,14 +34883,6 @@ { "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -32527,53 +34894,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -32898,14 +35280,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -32917,53 +35291,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -33092,9 +35481,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules", - "createdAt" + "value" ], "properties": { "id": { @@ -33102,36 +35489,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -33252,9 +35649,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules", - "createdAt" + "value" ], "properties": { "id": { @@ -33262,36 +35657,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -33333,8 +35738,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -33342,14 +35746,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -33437,8 +35844,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -33446,14 +35852,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -33514,8 +35923,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -33523,10 +35931,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -33586,8 +35996,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -33595,10 +36004,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -33715,8 +36126,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -33724,14 +36134,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -33819,8 +36232,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -33828,14 +36240,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -33870,8 +36285,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -33879,16 +36293,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -33979,8 +36397,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -33988,16 +36405,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -34060,9 +36481,6 @@ { "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -34077,15 +36495,19 @@ "type": "string" }, "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": { @@ -34153,9 +36575,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -34170,15 +36589,19 @@ "type": "string" }, "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": { @@ -34220,7 +36643,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -34229,6 +36651,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34240,12 +36663,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -34428,7 +36857,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -34437,6 +36865,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34448,12 +36877,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -34507,8 +36942,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -34516,16 +36950,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -35069,8 +37507,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -35078,16 +37515,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -35279,8 +37720,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -35288,13 +37728,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35306,6 +37749,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -35383,6 +37827,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -35455,8 +37900,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -35464,13 +37908,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35482,6 +37929,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -35505,7 +37953,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -35562,7 +38011,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -35572,38 +38020,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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}$" }, "analyticsId": { + "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}$" }, @@ -35612,10 +38069,12 @@ "pattern": "^[0-9a-f]{32}$" }, "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}$" }, @@ -35624,6 +38083,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35632,35 +38092,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "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" }, "maintenanceIpWhitelist": { @@ -35682,6 +38153,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35943,6 +38415,7 @@ "type": "object" }, "language": { + "description": "Default language for the sales channel", "properties": { "links": { "type": "object", @@ -36001,6 +38474,7 @@ "type": "object" }, "currency": { + "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", @@ -36030,6 +38504,7 @@ "type": "object" }, "paymentMethod": { + "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", @@ -36059,6 +38534,7 @@ "type": "object" }, "shippingMethod": { + "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", @@ -36088,6 +38564,7 @@ "type": "object" }, "country": { + "description": "Default country for the sales channel", "properties": { "links": { "type": "object", @@ -36208,6 +38685,7 @@ "type": "object" }, "domains": { + "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", @@ -36270,6 +38748,7 @@ "type": "object" }, "navigationCategory": { + "description": "Root category for navigation menu", "properties": { "links": { "type": "object", @@ -36299,6 +38778,7 @@ "type": "object" }, "footerCategory": { + "description": "Root category for footer navigation", "properties": { "links": { "type": "object", @@ -36328,6 +38808,7 @@ "type": "object" }, "serviceCategory": { + "description": "Root category for service pages", "properties": { "links": { "type": "object", @@ -36898,7 +39379,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -36908,38 +39388,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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}$" }, "analyticsId": { + "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}$" }, @@ -36948,10 +39437,12 @@ "pattern": "^[0-9a-f]{32}$" }, "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}$" }, @@ -36960,6 +39451,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36968,35 +39460,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "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" }, "maintenanceIpWhitelist": { @@ -37018,6 +39521,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37126,22 +39630,27 @@ "$ref": "#/components/schemas/SalesChannelType" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" }, "country": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" }, "orders": { "type": "array", @@ -37159,6 +39668,7 @@ "$ref": "#/components/schemas/CmsPage" }, "domains": { + "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -37171,13 +39681,16 @@ } }, "navigationCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" }, "footerCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" }, "serviceCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" }, "productVisibilities": { "type": "array", @@ -37283,8 +39796,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -37292,15 +39804,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Unique identity for tracking.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "createdAt": { @@ -37353,9 +39873,13 @@ ] }, "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "description": "Sales channel analytics configuration", "required": [ "id", + "active", + "trackOrders", + "anonymizeIp", + "trackOffcanvasCart", "createdAt" ], "properties": { @@ -37364,15 +39888,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Google Analytics tracking ID (e.g., UA-XXXXX-Y or G-XXXXXXXX)", "type": "string" }, "active": { + "description": "Whether Google Analytics tracking is enabled", "type": "boolean" }, "trackOrders": { + "description": "Track order completions in Google Analytics", "type": "boolean" }, "anonymizeIp": { + "description": "Anonymize visitor IP addresses for GDPR compliance", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, "createdAt": { @@ -37381,7 +39913,10 @@ "readOnly": true }, "updatedAt": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "readOnly": true }, @@ -37460,8 +39995,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -37469,25 +40003,34 @@ "pattern": "^[0-9a-f]{32}$" }, "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": { @@ -37697,8 +40240,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -37706,25 +40248,34 @@ "pattern": "^[0-9a-f]{32}$" }, "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": { @@ -37857,7 +40408,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -37866,9 +40416,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -37950,7 +40502,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -37959,9 +40510,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -38017,7 +40570,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -38027,6 +40579,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -38221,7 +40774,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -38231,6 +40783,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -38301,9 +40854,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -38311,27 +40862,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -38358,9 +40916,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -38368,27 +40924,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -38417,8 +40980,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -38426,15 +40988,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -38497,8 +41063,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -38506,15 +41071,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -38550,8 +41119,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -38559,33 +41127,42 @@ "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" }, "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": { @@ -38685,8 +41262,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -38694,33 +41270,42 @@ "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" }, "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": { @@ -38763,8 +41348,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -38772,19 +41356,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -38844,8 +41433,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -38853,19 +41441,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -38896,9 +41489,8 @@ { "required": [ "id", + "technicalName", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -38909,10 +41501,15 @@ "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" }, @@ -38920,21 +41517,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38944,9 +41546,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -38963,6 +41562,7 @@ "relationships": { "properties": { "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -38992,6 +41592,7 @@ "type": "object" }, "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -39021,6 +41622,7 @@ "type": "object" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -39052,6 +41654,7 @@ "type": "object" }, "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -39081,6 +41684,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -39205,6 +41809,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -39274,9 +41879,8 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -39287,10 +41891,15 @@ "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" }, @@ -39298,21 +41907,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39322,9 +41936,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -39339,21 +41950,26 @@ "type": "object" }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "$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" + "$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" @@ -39378,7 +41994,8 @@ } }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" @@ -39395,8 +42012,7 @@ { "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -39404,31 +42020,40 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -39544,8 +42169,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -39553,31 +42177,40 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -39644,8 +42277,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -39653,16 +42285,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -39724,8 +42360,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -39733,16 +42368,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -39775,8 +42414,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -39784,12 +42422,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -39883,8 +42523,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -39892,12 +42531,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -39938,7 +42579,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -39947,6 +42587,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -40080,7 +42721,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -40089,6 +42729,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -40149,8 +42790,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -40158,32 +42798,44 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40314,6 +42966,35 @@ } }, "type": "object" + }, + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -40332,8 +43013,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -40341,32 +43021,44 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40391,6 +43083,9 @@ }, "user": { "$ref": "#/components/schemas/User" + }, + "integration": { + "$ref": "#/components/schemas/Integration" } }, "type": "object" @@ -40406,7 +43101,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -40415,12 +43109,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40764,7 +43460,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -40773,12 +43468,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40870,8 +43567,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -40879,17 +43575,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41010,8 +43710,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -41019,17 +43718,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41067,7 +43770,6 @@ "required": [ "id", "internalName", - "createdAt", "displayName" ], "properties": { @@ -41292,7 +43994,6 @@ "required": [ "id", "internalName", - "createdAt", "displayName" ], "properties": { @@ -41390,8 +44091,7 @@ "id", "hash", "configuration", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41501,8 +44201,7 @@ "id", "hash", "configuration", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41557,9 +44256,7 @@ { "required": [ "id", - "oneTime", - "templateConfigurationId", - "createdAt" + "templateConfigurationId" ], "properties": { "id": { @@ -41633,9 +44330,7 @@ "SwagCustomizedProductsTemplateConfigurationShare": { "required": [ "id", - "oneTime", - "templateConfigurationId", - "createdAt" + "templateConfigurationId" ], "properties": { "id": { @@ -41682,8 +44377,7 @@ "required": [ "id", "name", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41789,8 +44483,7 @@ "required": [ "id", "name", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41844,8 +44537,7 @@ "id", "templateExclusionId", "templateOptionId", - "templateExclusionOperatorId", - "createdAt" + "templateExclusionOperatorId" ], "properties": { "id": { @@ -42019,8 +44711,7 @@ "id", "templateExclusionId", "templateOptionId", - "templateExclusionOperatorId", - "createdAt" + "templateExclusionOperatorId" ], "properties": { "id": { @@ -42082,8 +44773,7 @@ "SwagCustomizedProductsTemplateExclusionConditionValues": { "required": [ "templateExclusionConditionId", - "templateOptionValueId", - "createdAt" + "templateOptionValueId" ], "properties": { "id": { @@ -42135,7 +44825,6 @@ "id", "operator", "templateOptionType", - "createdAt", "label" ], "properties": { @@ -42211,7 +44900,6 @@ "id", "operator", "templateOptionType", - "createdAt", "label" ], "properties": { @@ -42260,7 +44948,6 @@ "id", "type", "templateId", - "createdAt", "displayName" ], "properties": { @@ -42311,7 +44998,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "calculatedPrice": { "type": "object" @@ -42507,7 +45197,6 @@ "id", "type", "templateId", - "createdAt", "displayName" ], "properties": { @@ -42558,7 +45247,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "calculatedPrice": { "type": "object" @@ -42623,8 +45315,7 @@ { "required": [ "id", - "templateOptionId", - "createdAt" + "templateOptionId" ], "properties": { "id": { @@ -42644,7 +45335,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -42735,8 +45429,7 @@ "SwagCustomizedProductsTemplateOptionPrice": { "required": [ "id", - "templateOptionId", - "createdAt" + "templateOptionId" ], "properties": { "id": { @@ -42756,7 +45449,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -42795,7 +45491,6 @@ "id", "templateOptionId", "position", - "createdAt", "displayName" ], "properties": { @@ -42841,7 +45536,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -42999,7 +45697,6 @@ "id", "templateOptionId", "position", - "createdAt", "displayName" ], "properties": { @@ -43045,7 +45742,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43097,8 +45797,7 @@ { "required": [ "id", - "templateOptionValueId", - "createdAt" + "templateOptionValueId" ], "properties": { "id": { @@ -43118,7 +45817,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43209,8 +45911,7 @@ "SwagCustomizedProductsTemplateOptionValuePrice": { "required": [ "id", - "templateOptionValueId", - "createdAt" + "templateOptionValueId" ], "properties": { "id": { @@ -43230,7 +45931,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43269,8 +45973,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -43278,6 +45981,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -43289,6 +45993,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43346,8 +46051,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -43355,6 +46059,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -43366,6 +46071,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43394,8 +46100,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -43708,8 +46413,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -43796,9 +46500,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -43806,14 +46508,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -44005,9 +46709,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -44015,14 +46717,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -44138,7 +46842,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -44147,26 +46850,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44260,7 +46969,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -44269,26 +46977,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44329,8 +47043,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -44338,14 +47051,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -44371,10 +47087,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -44492,8 +47210,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -44501,14 +47218,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -44534,10 +47254,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -44574,7 +47296,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -44583,10 +47304,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -44653,7 +47376,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -44662,10 +47384,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -44705,8 +47429,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -44905,8 +47628,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -45084,7 +47806,6 @@ { "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -45160,7 +47881,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -45213,9 +47933,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -45223,41 +47941,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45722,9 +48451,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -45732,41 +48459,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45899,8 +48637,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -45908,16 +48645,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -45979,8 +48720,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -45988,16 +48728,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -46030,8 +48774,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -46039,10 +48782,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -46102,8 +48847,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -46111,10 +48855,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -46146,8 +48892,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -46155,9 +48900,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46215,8 +48962,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -46224,9 +48970,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46257,9 +49005,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -46345,9 +49091,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -46406,8 +49150,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -46415,26 +49158,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -46444,13 +49194,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -46481,8 +49234,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -46490,26 +49242,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -46519,13 +49278,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -46547,64 +49309,193 @@ }, "type": "object" }, - "infoConfigResponse": { + "ConsentState": { "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt" + ], "properties": { - "version": { + "name": { "type": "string", - "description": "The Shopware version." + "description": "The name of the consent" }, - "versionRevision": { + "scopeName": { "type": "string", - "description": "The Shopware version revision." + "description": "The scope of the consent that defines how the identifier is resolved" }, - "adminWorker": { - "type": "object", - "description": "Information about the admin worker.", - "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "State of the admin worker." - }, - "transports": { - "type": "array", - "description": "Configured transports.", - "items": { - "type": "string" - } + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + } + } + }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" + }, + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" } } + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "bundles": { + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", "type": "object", - "description": "Asset files of active extensions", - "additionalProperties": { - "type": "object", - "properties": { - "css": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the css file." - } - }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the js file." - } - } + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } + }, + "required": [ + "gross", + "net", + "linked" + ] }, - "settings": { + "regulationPrice": { + "description": "", "type": "object", "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } + }, + "required": [ + "gross", + "net", + "linked" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" } } } @@ -46681,7 +49572,7 @@ "administration" ] }, - "scopes": { + "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "username": { @@ -46695,7 +49586,7 @@ }, "required": [ "client_id", - "scopes", + "scope", "username", "password" ] @@ -46717,7 +49608,7 @@ "administration" ] }, - "scopes": { + "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "refresh_token": { @@ -46727,41 +49618,51 @@ }, "required": [ "client_id", - "scopes", + "scope", "refresh_token" ] } ] }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the event" - }, - "class": { - "type": "string", - "description": "Class name of the event" - }, - "data": { - "type": "object", - "description": "Available data of event" - }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" + "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." } } } @@ -46783,22 +49684,19 @@ "type": "array", "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] } }, @@ -46827,53 +49725,29 @@ "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": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] } }, "associations": { - "type": "object", - "description": "Used to fetch associations which are not fetched by default." + "$ref": "#/components/schemas/Associations" }, "aggregations": { "type": "array", - "description": "Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)", "items": { - "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" - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] + "$ref": "#/components/schemas/Aggregation" } }, "grouping": { @@ -46901,34 +49775,811 @@ "exact", "next-pages" ] + }, + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "includes": { + "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, - "flowBuilderActionsResponse": { + "Includes": { + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Filters": { "type": "array", "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "anyOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] + }, + "field": { + "type": "string" + }, + "value": { "type": "string" } }, - "extensions": { - "type": "array", - "items": { + "required": [ + "type", + "field", + "value" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equalsAny", + "equalsAll" + ] + }, + "field": { "type": "string" }, - "description": "Extensions data of event" + "value": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type", + "field", + "value" + ] + } + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multi", + "not" + ] + }, + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] + }, + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "type": "string" + }, + "parameters": { + "type": "object", + "properties": { + "gte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "gt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } } } + }, + "required": [ + "type", + "field", + "parameters" + ] + }, + "Sort": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + "naturalSorting": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "required": [ + "field", + "order" + ] + }, + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" } + }, + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" + } + ] + } + } + }, + "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" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "infoConfigResponse": { + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Shopware version." + }, + "shopId": { + "type": "string", + "description": "Unique shop identifier." + }, + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." + }, + "adminWorker": { + "type": "object", + "description": "Admin worker feature flags and transport configuration.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." + }, + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled." + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." + }, + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { + "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." + }, + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." + }, + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + } + }, + "additionalProperties": false + }, + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true + } + } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false } }, "responses": { @@ -47260,12 +50911,13 @@ "securitySchemes": { "oAuth": { "type": "oauth2", - "description": "Authentication API", + "description": "Authentication using OAuth 2.0", "flows": { "password": { - "tokenUrl": "http://localhost:8000/api/oauth/token", + "tokenUrl": "/api/oauth/token", "scopes": { - "write": "Full write access" + "write": "Full write access", + "admin": "Admin scope for administrative operations" } }, "clientCredentials": { @@ -47291,7 +50943,7 @@ "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", - "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { @@ -47490,6 +51142,14 @@ "name": "Main Category", "description": "The endpoint for operations on Main Category" }, + { + "name": "Measurement Display Unit", + "description": "The endpoint for operations on Measurement Display Unit" + }, + { + "name": "Measurement System", + "description": "The endpoint for operations on Measurement System" + }, { "name": "Media", "description": "The endpoint for operations on Media" diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index a3268e6..dcc3650 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,5 +1,18 @@ { "paths": [ + "/aggregate/swag-customized-products-template", + "/aggregate/swag-customized-products-template-configuration", + "/aggregate/swag-customized-products-template-configuration-share", + "/aggregate/swag-customized-products-template-exclusion", + "/aggregate/swag-customized-products-template-exclusion-condition", + "/aggregate/swag-customized-products-template-exclusion-operator", + "/aggregate/swag-customized-products-template-option", + "/aggregate/swag-customized-products-template-option-price", + "/aggregate/swag-customized-products-template-option-value", + "/aggregate/swag-customized-products-template-option-value-price", + "/consents", + "/consents/accept", + "/consents/revoke", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", @@ -35,6 +48,13 @@ "AclRole", "AclRoleJsonApi", "AclUserRole", + "Aggregation", + "AggregationEntity", + "AggregationFilter", + "AggregationHistogram", + "AggregationMetrics", + "AggregationRange", + "AggregationTerms", "App", "AppActionButton", "AppActionButtonJsonApi", @@ -55,6 +75,7 @@ "AppShippingMethodJsonApi", "AppTemplate", "AppTemplateJsonApi", + "Associations", "Category", "CategoryJsonApi", "CategoryTag", @@ -66,6 +87,7 @@ "CmsSectionJsonApi", "CmsSlot", "CmsSlotJsonApi", + "ConsentState", "Country", "CountryJsonApi", "CountryState", @@ -107,6 +129,9 @@ "DocumentJsonApi", "DocumentType", "DocumentTypeJsonApi", + "EqualsFilter", + "Excludes", + "Filters", "Flow", "FlowJsonApi", "FlowSequence", @@ -119,6 +144,7 @@ "ImportExportLogJsonApi", "ImportExportProfile", "ImportExportProfileJsonApi", + "Includes", "Integration", "IntegrationJsonApi", "IntegrationRole", @@ -141,6 +167,11 @@ "MailTemplateTypeJsonApi", "MainCategory", "MainCategoryJsonApi", + "MeasurementDisplayUnit", + "MeasurementDisplayUnitJsonApi", + "MeasurementSystem", + "MeasurementSystemJsonApi", + "MeasurementUnits", "Media", "MediaDefaultFolder", "MediaDefaultFolderJsonApi", @@ -155,6 +186,7 @@ "MediaThumbnailJsonApi", "MediaThumbnailSize", "MediaThumbnailSizeJsonApi", + "MultiNotFilter", "NewsletterRecipient", "NewsletterRecipientJsonApi", "NewsletterRecipientTag", @@ -200,6 +232,7 @@ "PaymentMethodJsonApi", "Plugin", "PluginJsonApi", + "Price", "Product", "ProductCategory", "ProductCategoryTree", @@ -267,6 +300,7 @@ "PropertyGroupJsonApi", "PropertyGroupOption", "PropertyGroupOptionJsonApi", + "RangeFilter", "Rule", "RuleCondition", "RuleConditionJsonApi", @@ -300,10 +334,12 @@ "ShippingMethodPrice", "ShippingMethodPriceJsonApi", "ShippingMethodTag", + "SimpleFilter", "Snippet", "SnippetJsonApi", "SnippetSet", "SnippetSetJsonApi", + "Sort", "StateMachine", "StateMachineHistory", "StateMachineHistoryJsonApi", @@ -312,6 +348,7 @@ "StateMachineStateJsonApi", "StateMachineTransition", "StateMachineTransitionJsonApi", + "SubAggregations", "SwagCustomizedProductsTemplate", "SwagCustomizedProductsTemplateConfiguration", "SwagCustomizedProductsTemplateConfigurationJsonApi",