diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index bd711a1..bab7f95 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -4884,55 +4884,6 @@ } } }, - "/_action/media/{mediaId}/video-cover": { - "post": { - "tags": [ - "Asset Management" - ], - "summary": "Assign or remove a video cover image", - "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", - "operationId": "assignVideoCover", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "required": true, - "description": "ID of the video media entity", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "coverMediaId": { - "type": [ - "string", - "null" - ], - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the image media entity to use as cover. Set to null to remove the cover." - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Video cover assigned or removed successfully" - }, - "400": { - "description": "Invalid request" - } - } - } - }, "/_action/dsr/appointment/{appointmentId}/join-as-guide": { "post": { "tags": [ @@ -6360,9 +6311,11 @@ "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": { @@ -6372,6 +6325,7 @@ } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -6498,9 +6452,11 @@ "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": { @@ -6510,6 +6466,7 @@ } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -6601,34 +6558,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 }, @@ -6648,9 +6614,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": { @@ -6660,6 +6628,7 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, @@ -6700,10 +6669,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}$" }, @@ -7115,34 +7086,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 }, @@ -7162,9 +7142,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": { @@ -7174,6 +7156,7 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, @@ -7214,10 +7197,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}$" }, @@ -7325,21 +7310,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}$" }, @@ -7412,21 +7402,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}$" }, @@ -7552,21 +7547,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}$" }, @@ -7639,21 +7638,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}$" }, @@ -7696,10 +7699,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": { @@ -7724,7 +7729,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 }, @@ -7732,6 +7737,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -7847,10 +7853,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": { @@ -7875,7 +7883,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 }, @@ -7883,6 +7891,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -7944,10 +7953,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": { @@ -8053,10 +8064,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": { @@ -8109,38 +8122,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}$" }, @@ -8265,38 +8289,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}$" }, @@ -8342,24 +8377,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}$" }, @@ -8461,24 +8501,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}$" }, @@ -8723,15 +8768,19 @@ "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}$" }, @@ -8802,15 +8851,19 @@ "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}$" }, @@ -8862,6 +8915,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}$" }, @@ -8870,10 +8924,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": { @@ -8890,11 +8946,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 }, @@ -8904,15 +8962,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": { @@ -8959,6 +9021,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8967,6 +9030,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8990,6 +9054,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -9421,6 +9486,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}$" }, @@ -9429,10 +9495,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": { @@ -9449,11 +9517,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 }, @@ -9463,15 +9533,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": { @@ -9518,6 +9592,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9526,6 +9601,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9547,7 +9623,8 @@ "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", @@ -9679,44 +9756,56 @@ "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": { @@ -9734,6 +9823,7 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9871,44 +9961,56 @@ "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": { @@ -9926,6 +10028,7 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9981,12 +10084,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": { @@ -9998,6 +10104,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10270,12 +10377,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": { @@ -10287,6 +10397,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10409,38 +10520,48 @@ "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}$" }, @@ -10626,38 +10747,48 @@ "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}$" }, @@ -10767,9 +10898,11 @@ "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": { @@ -10786,6 +10919,7 @@ "readOnly": true }, "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10866,9 +11000,11 @@ "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": { @@ -10885,6 +11021,7 @@ "readOnly": true }, "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10928,34 +11065,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": { @@ -11002,21 +11149,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": { @@ -11279,34 +11431,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": { @@ -11353,21 +11515,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": { @@ -11451,20 +11618,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": { @@ -11598,20 +11769,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": { @@ -11671,13 +11846,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": { @@ -11687,6 +11865,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -11695,6 +11874,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -12001,13 +12181,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": { @@ -12017,6 +12200,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -12025,6 +12209,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -12379,6 +12564,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -12388,10 +12574,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}$" }, @@ -12404,9 +12592,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": { @@ -12441,6 +12631,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -12450,10 +12641,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}$" }, @@ -12466,9 +12659,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": { @@ -12506,30 +12701,39 @@ "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": { "type": "string", "format": "date-time", @@ -12623,30 +12827,39 @@ "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": { "type": "string", "format": "date-time", @@ -12686,22 +12899,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}$" }, @@ -12859,22 +13077,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}$" }, @@ -12930,10 +13153,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": { @@ -12998,10 +13223,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": { @@ -13045,26 +13272,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}$" }, @@ -13074,77 +13307,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": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for 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 @@ -13153,6 +13407,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -13164,10 +13419,12 @@ "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}$" }, @@ -13857,26 +14114,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}$" }, @@ -13886,77 +14149,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": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for 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 @@ -13965,6 +14249,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -13976,10 +14261,12 @@ "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}$" }, @@ -14150,52 +14437,67 @@ "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": { @@ -14358,52 +14660,67 @@ "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": { @@ -14458,12 +14775,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": { @@ -14609,12 +14928,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": { @@ -14714,9 +15035,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}$" }, @@ -14782,9 +15105,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}$" }, @@ -14850,10 +15175,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}$" }, @@ -14982,10 +15309,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}$" }, @@ -15035,6 +15364,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15043,6 +15373,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15137,6 +15468,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15145,6 +15477,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15190,14 +15523,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": { @@ -15306,14 +15642,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": { @@ -15712,26 +16051,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": { @@ -15782,6 +16128,7 @@ "type": "object" }, "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -15862,26 +16209,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": { @@ -15904,7 +16258,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", @@ -15932,14 +16287,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}$" }, @@ -16062,14 +16420,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}$" }, @@ -16116,6 +16477,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -16253,6 +16615,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -18483,29 +18846,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}$" }, @@ -18602,29 +18972,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}$" }, @@ -18667,24 +19044,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" }, @@ -18773,6 +19155,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -18881,24 +19264,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" }, @@ -18933,7 +19321,8 @@ "$ref": "#/components/schemas/Rule" }, "parent": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "children": { "type": "array", @@ -18964,6 +19353,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -18996,6 +19386,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -19033,20 +19424,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": { @@ -19112,20 +19508,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": { @@ -19474,21 +19875,26 @@ "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": { @@ -19577,21 +19983,26 @@ "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": { @@ -19644,25 +20055,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" }, @@ -19827,25 +20244,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" }, @@ -20314,14 +20737,17 @@ "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": { @@ -20379,6 +20805,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -20832,14 +21259,17 @@ "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": { @@ -20895,7 +21325,8 @@ "type": "object" }, "parent": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, "locale": { "$ref": "#/components/schemas/Locale", @@ -20991,6 +21422,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -21101,6 +21533,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -21156,9 +21589,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" }, @@ -21197,9 +21632,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" }, @@ -21620,6 +22057,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -21701,6 +22139,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -21753,6 +22192,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21761,6 +22201,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21769,6 +22210,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21893,6 +22335,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21901,6 +22344,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21909,6 +22353,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22233,28 +22678,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": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -22288,6 +22740,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -23138,28 +23591,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": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -23193,6 +23653,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -23440,6 +23901,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -23506,6 +23968,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -23545,13 +24008,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}$" }, @@ -23565,10 +24031,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": { @@ -23587,6 +24055,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -23756,13 +24225,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}$" }, @@ -23776,10 +24248,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": { @@ -23796,7 +24270,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." }, "children": { "type": "array", @@ -23835,16 +24310,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": { @@ -23946,16 +24425,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": { @@ -24064,6 +24547,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24072,17 +24556,19 @@ "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": { @@ -24183,6 +24669,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24191,17 +24678,19 @@ "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": { @@ -24247,10 +24736,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" }, @@ -24352,10 +24843,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" }, @@ -24408,48 +24901,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}$" }, @@ -24607,48 +25113,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}$" }, @@ -24726,12 +25245,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": { @@ -24742,10 +25264,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}$" }, @@ -24840,12 +25364,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": { @@ -24856,10 +25383,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}$" }, @@ -24903,10 +25432,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": { @@ -24916,9 +25447,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" }, @@ -25053,10 +25586,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": { @@ -25066,9 +25601,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" }, @@ -25121,14 +25658,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}$" }, @@ -25252,14 +25792,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}$" }, @@ -25303,6 +25846,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25372,6 +25916,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25413,12 +25958,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": { @@ -25522,12 +26069,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": { @@ -25595,9 +26144,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}$" }, @@ -25622,22 +26173,27 @@ "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 }, @@ -25679,21 +26235,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 }, @@ -25755,36 +26315,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}$" }, @@ -25798,10 +26366,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}$" }, @@ -26385,9 +26955,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}$" }, @@ -26412,22 +26984,27 @@ "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 }, @@ -26469,21 +27046,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 }, @@ -26545,36 +27126,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}$" }, @@ -26588,10 +27177,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}$" }, @@ -26755,14 +27346,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}$" }, @@ -26771,43 +27365,56 @@ "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": { @@ -27005,14 +27612,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}$" }, @@ -27021,43 +27631,56 @@ "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": { @@ -27122,10 +27745,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}$" }, @@ -27134,22 +27759,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": { @@ -27159,12 +27790,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": { @@ -27293,10 +27926,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}$" }, @@ -27305,22 +27940,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": { @@ -27330,12 +27971,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": { @@ -27386,6 +28029,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27394,6 +28038,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27402,10 +28047,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}$" }, @@ -27416,10 +28063,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" }, @@ -27704,6 +28353,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27712,6 +28362,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27720,10 +28371,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}$" }, @@ -27734,10 +28387,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" }, @@ -27861,6 +28516,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27869,6 +28525,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27934,14 +28591,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" }, @@ -28043,6 +28703,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28051,6 +28712,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28116,14 +28778,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" }, @@ -28162,9 +28827,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -28176,6 +28841,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28184,6 +28850,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28192,6 +28859,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28204,44 +28872,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", @@ -28303,22 +28974,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", @@ -28620,9 +29302,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -28634,6 +29316,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28642,6 +29325,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28650,6 +29334,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28662,44 +29347,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", @@ -28761,22 +29449,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", @@ -28857,6 +29556,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28865,14 +29565,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": { @@ -28975,6 +29678,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28983,14 +29687,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": { @@ -29071,6 +29778,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29079,6 +29787,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29143,6 +29852,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29338,6 +30048,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29346,6 +30057,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29410,6 +30122,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29473,6 +30186,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29481,10 +30195,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": { @@ -29674,6 +30390,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29682,10 +30399,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": { @@ -29796,6 +30515,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29804,13 +30524,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": { @@ -30000,6 +30723,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30008,13 +30732,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": { @@ -30125,6 +30852,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30133,6 +30861,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30141,12 +30870,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" }, @@ -30306,6 +31038,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30314,6 +31047,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30322,12 +31056,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" }, @@ -30428,10 +31165,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": { @@ -30445,23 +31184,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}$" }, @@ -30754,10 +31498,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": { @@ -30771,23 +31517,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}$" }, @@ -30877,46 +31628,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" }, @@ -31010,46 +31774,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" }, @@ -31128,6 +31905,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31136,14 +31914,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}$" }, @@ -31152,14 +31933,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}$" }, @@ -31168,6 +31952,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31182,9 +31967,11 @@ } }, "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" }, @@ -31194,21 +31981,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" }, @@ -31219,6 +32011,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -31229,32 +32022,40 @@ "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": { @@ -31264,29 +32065,36 @@ } }, "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 @@ -31345,20 +32153,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" }, @@ -31393,6 +32196,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", @@ -31508,6 +32323,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -32447,6 +33263,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32455,14 +33272,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}$" }, @@ -32471,14 +33291,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}$" }, @@ -32487,6 +33310,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32501,9 +33325,11 @@ } }, "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" }, @@ -32513,21 +33339,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" }, @@ -32538,6 +33369,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -32548,32 +33380,40 @@ "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": { @@ -32583,29 +33423,36 @@ } }, "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 @@ -32664,20 +33511,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" }, @@ -32712,6 +33554,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", @@ -32800,7 +33654,8 @@ } }, "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", @@ -33063,6 +33918,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33071,10 +33927,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}$" }, @@ -33082,6 +33940,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" }, @@ -33212,6 +34071,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33220,10 +34080,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}$" }, @@ -33231,6 +34093,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" }, @@ -33280,26 +34143,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}$" }, @@ -33308,6 +34178,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33439,26 +34310,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}$" }, @@ -33467,6 +34345,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33516,10 +34395,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}$" }, @@ -33528,6 +34409,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" }, @@ -33622,10 +34504,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}$" }, @@ -33634,6 +34518,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" }, @@ -33710,6 +34595,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33718,10 +34604,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" }, @@ -33823,6 +34711,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33831,10 +34720,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" }, @@ -33887,64 +34778,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": { @@ -34134,64 +35043,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": { @@ -34361,13 +35288,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": { @@ -34422,13 +35352,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": { @@ -34458,6 +35391,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34572,6 +35506,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34634,6 +35569,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34642,10 +35578,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" }, @@ -34778,6 +35716,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34786,10 +35725,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" }, @@ -34880,6 +35821,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34888,6 +35830,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34898,10 +35841,12 @@ } }, "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" }, @@ -35005,6 +35950,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35013,6 +35959,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35023,10 +35970,12 @@ } }, "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" }, @@ -35105,6 +36054,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35113,37 +36063,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": { @@ -35301,6 +36261,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35309,37 +36270,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": { @@ -35387,13 +36358,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" }, @@ -35495,13 +36469,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" }, @@ -35551,23 +36528,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" }, @@ -35662,23 +36645,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" }, @@ -35725,10 +36714,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}$" }, @@ -35737,9 +36728,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" }, @@ -35840,10 +36833,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}$" }, @@ -35852,9 +36847,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" }, @@ -36005,6 +37002,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -36216,6 +37214,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -36322,6 +37321,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36330,21 +37330,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" }, @@ -36393,6 +37398,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -36473,6 +37479,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36481,21 +37488,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" }, @@ -36516,7 +37528,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -36610,6 +37623,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36618,10 +37632,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" }, @@ -36717,6 +37733,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36725,10 +37742,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" }, @@ -36771,53 +37790,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 @@ -37153,53 +38187,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 @@ -37336,36 +38385,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": { @@ -37494,36 +38553,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": { @@ -37573,14 +38642,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" }, @@ -37676,14 +38748,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" }, @@ -37752,10 +38827,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": { @@ -37823,10 +38900,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": { @@ -37951,14 +39030,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" }, @@ -38054,14 +39136,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" }, @@ -38104,16 +39189,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" }, @@ -38212,16 +39301,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" }, @@ -38298,15 +39391,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": { @@ -38388,15 +39485,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": { @@ -38446,6 +39547,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38457,9 +39559,11 @@ "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}$" }, @@ -38657,6 +39761,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38668,9 +39773,11 @@ "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}$" }, @@ -38739,16 +39846,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 }, @@ -39233,16 +40344,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 }, @@ -39375,13 +40490,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}$" }, @@ -39393,6 +40511,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" }, @@ -39470,6 +40589,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -39550,13 +40670,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}$" }, @@ -39568,6 +40691,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" }, @@ -39591,7 +40715,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -39657,38 +40782,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}$" }, @@ -39697,10 +40831,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}$" }, @@ -39709,6 +40845,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39717,10 +40854,12 @@ "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}$" }, @@ -39731,24 +40870,30 @@ "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": { @@ -39770,6 +40915,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41004,38 +42150,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}$" }, @@ -41044,10 +42199,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}$" }, @@ -41056,6 +42213,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41064,10 +42222,12 @@ "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}$" }, @@ -41078,24 +42238,30 @@ "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": { @@ -41117,6 +42283,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41399,15 +42566,19 @@ "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" }, "createdAt": { @@ -41470,15 +42641,19 @@ "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" }, "createdAt": { @@ -41574,21 +42749,26 @@ "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}$" }, @@ -41596,6 +42776,7 @@ "$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": { @@ -41849,21 +43030,26 @@ "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}$" }, @@ -41871,6 +43057,7 @@ "$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": { @@ -42047,9 +43234,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": { @@ -42139,9 +43328,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": { @@ -42206,6 +43397,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -42409,6 +43601,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -42487,27 +43680,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" }, @@ -42542,27 +43742,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" }, @@ -42599,15 +43806,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": { @@ -42678,15 +43889,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": { @@ -42730,33 +43945,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": { @@ -42864,33 +44088,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": { @@ -42941,19 +44174,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": { @@ -43021,19 +44259,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": { @@ -43080,9 +44323,11 @@ "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" }, @@ -43090,21 +44335,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}$" }, @@ -43463,9 +44713,11 @@ "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" }, @@ -43473,21 +44725,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}$" }, @@ -43581,26 +44838,32 @@ "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" }, @@ -43732,26 +44995,32 @@ "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" }, @@ -43834,16 +45103,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": { @@ -43913,16 +45186,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": { @@ -43963,12 +45240,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": { @@ -44070,12 +45349,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": { @@ -44124,6 +45405,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -44265,6 +45547,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -44333,32 +45616,40 @@ "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}$" }, @@ -44548,32 +45839,40 @@ "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}$" }, @@ -44628,12 +45927,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}$" }, @@ -44985,12 +46286,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}$" }, @@ -45090,17 +46393,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}$" }, @@ -45229,17 +46536,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}$" }, @@ -45286,6 +46597,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -45297,6 +46609,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45362,6 +46675,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -45373,6 +46687,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45809,14 +47124,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" }, @@ -45949,14 +47266,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" }, @@ -46013,26 +47332,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}$" }, @@ -46134,26 +47459,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}$" }, @@ -46202,14 +47533,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" }, @@ -46235,10 +47569,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" }, @@ -46364,14 +47700,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" }, @@ -46397,10 +47736,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" }, @@ -46445,10 +47786,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" }, @@ -46523,10 +47866,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" }, @@ -47078,41 +48423,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}$" }, @@ -47771,41 +49127,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}$" }, @@ -48132,16 +49499,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" }, @@ -48211,16 +49582,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" }, @@ -48261,10 +49636,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": { @@ -48332,10 +49709,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": { @@ -48375,9 +49754,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}$" }, @@ -48443,9 +49824,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}$" }, @@ -48629,26 +50012,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": { @@ -48658,13 +50048,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": { @@ -48703,26 +50096,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": { @@ -48732,13 +50132,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": { diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index f2aff40..3937fee 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,7 +20,6 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/_action/media/{mediaId}/video-cover", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request",