diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index a2fb2b4..0833eb6 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.7.9.0" + "version": "6.7.12.1" }, "servers": [ { @@ -15,14 +15,14 @@ } ], "paths": { - "/swag-customized-products-template": { + "/app-mcp-prompt": { "get": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "List with basic information of Swag Customized Products Template resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateList", + "summary": "List with basic information of App Mcp Prompt resources.", + "description": "Available since: 6.7.11.0", + "operationId": "getAppMcpPromptList", "parameters": [ { "name": "limit", @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template resources.", + "description": "List of App Mcp Prompt resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70,7 +70,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } ] @@ -84,16 +84,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template?limit=25" + "example": "/app-mcp-prompt?limit=25" }, "last": { - "example": "/swag-customized-products-template?limit=25&page=11" + "example": "/app-mcp-prompt?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template?limit=25&page=4" + "example": "/app-mcp-prompt?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template?limit=25&page=2" + "example": "/app-mcp-prompt?limit=25&page=2" } } } @@ -114,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -129,11 +129,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "Create a new Swag Customized Products Template resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplate", + "summary": "Create a new App Mcp Prompt resources.", + "description": "Available since: 6.7.11.0", + "operationId": "createAppMcpPrompt", "parameters": [ { "name": "_response", @@ -152,14 +152,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { @@ -171,7 +171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -186,7 +186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -202,14 +202,14 @@ } } }, - "/search/swag-customized-products-template": { + "/search/app-mcp-prompt": { "post": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "Search for the Swag Customized Products Template resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplate", + "summary": "Search for the App Mcp Prompt resources.", + "description": "Available since: 6.7.11.0", + "operationId": "searchAppMcpPrompt", "parameters": [ { "name": "sw-include-search-info", @@ -237,7 +237,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { @@ -251,7 +251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -269,7 +269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -286,19 +286,19 @@ } } }, - "/swag-customized-products-template/{id}": { + "/app-mcp-prompt/{id}": { "get": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "Detailed information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplate", + "summary": "Detailed information about a App Mcp Prompt resource.", + "description": "Available since: 6.7.11.0", + "operationId": "getAppMcpPrompt", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the app_mcp_prompt", "required": true, "schema": { "type": "string", @@ -308,7 +308,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { @@ -320,7 +320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -335,7 +335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -352,16 +352,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "Delete a Swag Customized Products Template resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplate", + "summary": "Delete a App Mcp Prompt resource.", + "description": "Available since: 6.7.11.0", + "operationId": "deleteAppMcpPrompt", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the app_mcp_prompt", "required": true, "schema": { "type": "string", @@ -392,16 +392,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "Partially update information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplate", + "summary": "Partially update information about a App Mcp Prompt resource.", + "description": "Available since: 6.7.11.0", + "operationId": "updateAppMcpPrompt", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the app_mcp_prompt", "required": true, "schema": { "type": "string", @@ -419,18 +419,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template resource.", + "description": "Partially update information about a App Mcp Prompt resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { @@ -442,7 +442,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -457,7 +457,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -476,14 +476,14 @@ } } }, - "/aggregate/swag-customized-products-template": { + "/aggregate/app-mcp-prompt": { "post": { "tags": [ - "Swag Customized Products Template" + "App Mcp Prompt" ], - "summary": "Aggregate for the Swag Customized Products Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplate", + "summary": "Aggregate for the App Mcp Prompt resources.", + "description": "Available since: 6.7.11.0", + "operationId": "aggregateAppMcpPrompt", "requestBody": { "required": true, "content": { @@ -507,7 +507,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of AppMcpPrompt", "content": { "application/vnd.api+json": { "schema": { @@ -521,7 +521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -539,7 +539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppMcpPrompt" } } } @@ -556,14 +556,14 @@ } } }, - "/swag-customized-products-template-configuration": { + "/app-mcp-resource": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "List with basic information of Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationList", + "summary": "List with basic information of App Mcp Resource resources.", + "description": "Available since: 6.7.11.0", + "operationId": "getAppMcpResourceList", "parameters": [ { "name": "limit", @@ -592,7 +592,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration resources.", + "description": "List of App Mcp Resource resources.", "content": { "application/vnd.api+json": { "schema": { @@ -611,7 +611,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } ] @@ -625,16 +625,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration?limit=25" + "example": "/app-mcp-resource?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration?limit=25&page=11" + "example": "/app-mcp-resource?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration?limit=25&page=4" + "example": "/app-mcp-resource?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration?limit=25&page=2" + "example": "/app-mcp-resource?limit=25&page=2" } } } @@ -655,7 +655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -670,11 +670,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "Create a new Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfiguration", + "summary": "Create a new App Mcp Resource resources.", + "description": "Available since: 6.7.11.0", + "operationId": "createAppMcpResource", "parameters": [ { "name": "_response", @@ -693,14 +693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { @@ -712,7 +712,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -727,7 +727,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -743,14 +743,14 @@ } } }, - "/search/swag-customized-products-template-configuration": { + "/search/app-mcp-resource": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "Search for the Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "summary": "Search for the App Mcp Resource resources.", + "description": "Available since: 6.7.11.0", + "operationId": "searchAppMcpResource", "parameters": [ { "name": "sw-include-search-info", @@ -778,7 +778,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { @@ -792,7 +792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -810,7 +810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -827,19 +827,19 @@ } } }, - "/swag-customized-products-template-configuration/{id}": { + "/app-mcp-resource/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfiguration", + "summary": "Detailed information about a App Mcp Resource resource.", + "description": "Available since: 6.7.11.0", + "operationId": "getAppMcpResource", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the app_mcp_resource", "required": true, "schema": { "type": "string", @@ -849,7 +849,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { @@ -861,7 +861,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -876,7 +876,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -893,16 +893,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "Delete a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", + "summary": "Delete a App Mcp Resource resource.", + "description": "Available since: 6.7.11.0", + "operationId": "deleteAppMcpResource", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the app_mcp_resource", "required": true, "schema": { "type": "string", @@ -933,16 +933,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfiguration", + "summary": "Partially update information about a App Mcp Resource resource.", + "description": "Available since: 6.7.11.0", + "operationId": "updateAppMcpResource", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the app_mcp_resource", "required": true, "schema": { "type": "string", @@ -960,18 +960,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "Partially update information about a App Mcp Resource resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { @@ -983,7 +983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -998,7 +998,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -1017,14 +1017,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration": { + "/aggregate/app-mcp-resource": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "App Mcp Resource" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", + "summary": "Aggregate for the App Mcp Resource resources.", + "description": "Available since: 6.7.11.0", + "operationId": "aggregateAppMcpResource", "requestBody": { "required": true, "content": { @@ -1048,7 +1048,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of AppMcpResource", "content": { "application/vnd.api+json": { "schema": { @@ -1062,7 +1062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -1080,7 +1080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppMcpResource" } } } @@ -1097,14 +1097,14 @@ } } }, - "/swag-customized-products-template-configuration-share": { + "/app-mcp-tool": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", + "summary": "List with basic information of App Mcp Tool resources.", + "description": "Available since: 6.7.11.0", + "operationId": "getAppMcpToolList", "parameters": [ { "name": "limit", @@ -1133,7 +1133,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration Share resources.", + "description": "List of App Mcp Tool resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1152,7 +1152,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } ] @@ -1166,16 +1166,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration-share?limit=25" + "example": "/app-mcp-tool?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" + "example": "/app-mcp-tool?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" + "example": "/app-mcp-tool?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" + "example": "/app-mcp-tool?limit=25&page=2" } } } @@ -1196,7 +1196,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1211,11 +1211,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "Create a new Swag Customized Products Template Configuration Share resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", + "summary": "Create a new App Mcp Tool resources.", + "description": "Available since: 6.7.11.0", + "operationId": "createAppMcpTool", "parameters": [ { "name": "_response", @@ -1234,14 +1234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { @@ -1253,7 +1253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1268,7 +1268,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1284,14 +1284,14 @@ } } }, - "/search/swag-customized-products-template-configuration-share": { + "/search/app-mcp-tool": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "Search for the Swag Customized Products Template Configuration Share resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "summary": "Search for the App Mcp Tool resources.", + "description": "Available since: 6.7.11.0", + "operationId": "searchAppMcpTool", "parameters": [ { "name": "sw-include-search-info", @@ -1319,7 +1319,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { @@ -1333,7 +1333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1351,7 +1351,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1368,19 +1368,19 @@ } } }, - "/swag-customized-products-template-configuration-share/{id}": { + "/app-mcp-tool/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", + "summary": "Detailed information about a App Mcp Tool resource.", + "description": "Available since: 6.7.11.0", + "operationId": "getAppMcpTool", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the app_mcp_tool", "required": true, "schema": { "type": "string", @@ -1390,7 +1390,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { @@ -1402,7 +1402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1417,7 +1417,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1434,16 +1434,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "Delete a Swag Customized Products Template Configuration Share resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", + "summary": "Delete a App Mcp Tool resource.", + "description": "Available since: 6.7.11.0", + "operationId": "deleteAppMcpTool", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the app_mcp_tool", "required": true, "schema": { "type": "string", @@ -1474,16 +1474,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", + "summary": "Partially update information about a App Mcp Tool resource.", + "description": "Available since: 6.7.11.0", + "operationId": "updateAppMcpTool", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the app_mcp_tool", "required": true, "schema": { "type": "string", @@ -1501,18 +1501,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "description": "Partially update information about a App Mcp Tool resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { @@ -1524,7 +1524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1539,7 +1539,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1558,14 +1558,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration-share": { + "/aggregate/app-mcp-tool": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "App Mcp Tool" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", + "summary": "Aggregate for the App Mcp Tool resources.", + "description": "Available since: 6.7.11.0", + "operationId": "aggregateAppMcpTool", "requestBody": { "required": true, "content": { @@ -1589,7 +1589,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of AppMcpTool", "content": { "application/vnd.api+json": { "schema": { @@ -1603,7 +1603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1621,7 +1621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/AppMcpTool" } } } @@ -1638,14 +1638,14 @@ } } }, - "/swag-customized-products-template-exclusion": { + "/document-file": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionList", + "summary": "List with basic information of Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "getDocumentFileList", "parameters": [ { "name": "limit", @@ -1674,7 +1674,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion resources.", + "description": "List of Document File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1693,7 +1693,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } ] @@ -1707,16 +1707,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion?limit=25" + "example": "/document-file?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=11" + "example": "/document-file?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=4" + "example": "/document-file?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=2" + "example": "/document-file?limit=25&page=2" } } } @@ -1737,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1752,11 +1752,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "Create a new Swag Customized Products Template Exclusion resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusion", + "summary": "Create a new Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "createDocumentFile", "parameters": [ { "name": "_response", @@ -1775,14 +1775,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -1794,7 +1794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1809,7 +1809,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1825,14 +1825,14 @@ } } }, - "/search/swag-customized-products-template-exclusion": { + "/search/document-file": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "Search for the Swag Customized Products Template Exclusion resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "summary": "Search for the Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "searchDocumentFile", "parameters": [ { "name": "sw-include-search-info", @@ -1860,7 +1860,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -1874,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1892,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1909,19 +1909,19 @@ } } }, - "/swag-customized-products-template-exclusion/{id}": { + "/document-file/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusion", + "summary": "Detailed information about a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "getDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -1931,7 +1931,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -1943,7 +1943,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1958,7 +1958,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -1975,16 +1975,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "Delete a Swag Customized Products Template Exclusion resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusion", + "summary": "Delete a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "deleteDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -2015,16 +2015,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusion", + "summary": "Partially update information about a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "updateDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -2042,18 +2042,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "description": "Partially update information about a Document File resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -2065,7 +2065,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2080,7 +2080,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2099,14 +2099,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion": { + "/aggregate/document-file": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Document File" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", + "summary": "Aggregate for the Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "aggregateDocumentFile", "requestBody": { "required": true, "content": { @@ -2130,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -2144,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2162,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -2179,14 +2179,14 @@ } } }, - "/swag-customized-products-template-exclusion-condition": { + "/sales-channel-file": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", + "summary": "List with basic information of Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "getSalesChannelFileList", "parameters": [ { "name": "limit", @@ -2215,7 +2215,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Condition resources.", + "description": "List of Sales Channel File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2234,7 +2234,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } ] @@ -2248,16 +2248,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25" + "example": "/sales-channel-file?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" + "example": "/sales-channel-file?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" + "example": "/sales-channel-file?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" + "example": "/sales-channel-file?limit=25&page=2" } } } @@ -2278,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2293,11 +2293,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", + "summary": "Create a new Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "createSalesChannelFile", "parameters": [ { "name": "_response", @@ -2316,14 +2316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -2335,7 +2335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2350,7 +2350,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2366,14 +2366,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-condition": { + "/search/sales-channel-file": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "summary": "Search for the Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "searchSalesChannelFile", "parameters": [ { "name": "sw-include-search-info", @@ -2401,7 +2401,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -2415,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2433,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2450,19 +2450,19 @@ } } }, - "/swag-customized-products-template-exclusion-condition/{id}": { + "/sales-channel-file/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", + "summary": "Detailed information about a Sales Channel File resource.", + "description": "Available since: 6.7.12.0", + "operationId": "getSalesChannelFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the sales_channel_file", "required": true, "schema": { "type": "string", @@ -2472,7 +2472,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -2484,7 +2484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2499,7 +2499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2516,16 +2516,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", + "summary": "Delete a Sales Channel File resource.", + "description": "Available since: 6.7.12.0", + "operationId": "deleteSalesChannelFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the sales_channel_file", "required": true, "schema": { "type": "string", @@ -2556,16 +2556,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", + "summary": "Partially update information about a Sales Channel File resource.", + "description": "Available since: 6.7.12.0", + "operationId": "updateSalesChannelFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the sales_channel_file", "required": true, "schema": { "type": "string", @@ -2583,18 +2583,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "description": "Partially update information about a Sales Channel File resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -2606,7 +2606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2621,7 +2621,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2640,14 +2640,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-condition": { + "/aggregate/sales-channel-file": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Sales Channel File" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", + "summary": "Aggregate for the Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "aggregateSalesChannelFile", "requestBody": { "required": true, "content": { @@ -2671,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -2685,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2703,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -2720,14 +2720,14 @@ } } }, - "/swag-customized-products-template-exclusion-operator": { + "/swag-customized-products-template": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", + "summary": "List with basic information of Swag Customized Products Template resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", + "operationId": "getSwagCustomizedProductsTemplateList", "parameters": [ { "name": "limit", @@ -2756,7 +2756,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Operator resources.", + "description": "List of Swag Customized Products Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2775,7 +2775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } ] @@ -2789,16 +2789,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25" + "example": "/swag-customized-products-template?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" + "example": "/swag-customized-products-template?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" + "example": "/swag-customized-products-template?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" + "example": "/swag-customized-products-template?limit=25&page=2" } } } @@ -2819,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -2834,11 +2834,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", + "summary": "Create a new Swag Customized Products Template resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "createSwagCustomizedProductsTemplate", "parameters": [ { "name": "_response", @@ -2857,14 +2857,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -2876,7 +2876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -2891,7 +2891,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -2907,14 +2907,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-operator": { + "/search/swag-customized-products-template": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Search for the Swag Customized Products Template resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "searchSwagCustomizedProductsTemplate", "parameters": [ { "name": "sw-include-search-info", @@ -2942,7 +2942,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -2956,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -2974,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -2991,19 +2991,19 @@ } } }, - "/swag-customized-products-template-exclusion-operator/{id}": { + "/swag-customized-products-template/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Detailed information about a Swag Customized Products Template resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "getSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -3013,7 +3013,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -3025,7 +3025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -3040,7 +3040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -3057,16 +3057,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Delete a Swag Customized Products Template resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "deleteSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -3097,16 +3097,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Partially update information about a Swag Customized Products Template resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "updateSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -3124,18 +3124,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "description": "Partially update information about a Swag Customized Products Template resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -3147,7 +3147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -3162,7 +3162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -3181,14 +3181,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-operator": { + "/aggregate/swag-customized-products-template": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Aggregate for the Swag Customized Products Template resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "aggregateSwagCustomizedProductsTemplate", "requestBody": { "required": true, "content": { @@ -3212,7 +3212,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -3226,7 +3226,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -3244,7 +3244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -3261,14 +3261,14 @@ } } }, - "/swag-customized-products-template-option": { + "/swag-customized-products-template-configuration": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "List with basic information of Swag Customized Products Template Option resources.", + "summary": "List with basic information of Swag Customized Products Template Configuration resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionList", + "operationId": "getSwagCustomizedProductsTemplateConfigurationList", "parameters": [ { "name": "limit", @@ -3297,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option resources.", + "description": "List of Swag Customized Products Template Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3316,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } ] @@ -3330,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option?limit=25" + "example": "/swag-customized-products-template-configuration?limit=25" }, "last": { - "example": "/swag-customized-products-template-option?limit=25&page=11" + "example": "/swag-customized-products-template-configuration?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option?limit=25&page=4" + "example": "/swag-customized-products-template-configuration?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option?limit=25&page=2" + "example": "/swag-customized-products-template-configuration?limit=25&page=2" } } } @@ -3360,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3375,11 +3375,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "Create a new Swag Customized Products Template Option resources.", + "summary": "Create a new Swag Customized Products Template Configuration resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOption", + "operationId": "createSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "_response", @@ -3398,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -3417,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3432,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3448,14 +3448,14 @@ } } }, - "/search/swag-customized-products-template-option": { + "/search/swag-customized-products-template-configuration": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "Search for the Swag Customized Products Template Option resources.", + "summary": "Search for the Swag Customized Products Template Configuration resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOption", + "operationId": "searchSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "sw-include-search-info", @@ -3483,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -3497,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3515,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3532,19 +3532,19 @@ } } }, - "/swag-customized-products-template-option/{id}": { + "/swag-customized-products-template-configuration/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "Detailed information about a Swag Customized Products Template Option resource.", + "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOption", + "operationId": "getSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -3554,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -3566,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3581,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3598,16 +3598,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "Delete a Swag Customized Products Template Option resource.", + "summary": "Delete a Swag Customized Products Template Configuration resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOption", + "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -3638,16 +3638,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "Partially update information about a Swag Customized Products Template Option resource.", + "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOption", + "operationId": "updateSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -3665,18 +3665,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -3688,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3703,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3722,14 +3722,14 @@ } } }, - "/aggregate/swag-customized-products-template-option": { + "/aggregate/swag-customized-products-template-configuration": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Configuration" ], - "summary": "Aggregate for the Swag Customized Products Template Option resources.", + "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOption", + "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", "requestBody": { "required": true, "content": { @@ -3753,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -3767,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3785,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -3802,14 +3802,14 @@ } } }, - "/swag-customized-products-template-option-price": { + "/swag-customized-products-template-configuration-share": { "get": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "List with basic information of Swag Customized Products Template Option Price resources.", + "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", "parameters": [ { "name": "limit", @@ -3838,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Price resources.", + "description": "List of Swag Customized Products Template Configuration Share resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3857,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } ] @@ -3871,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-price?limit=25" + "example": "/swag-customized-products-template-configuration-share?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-price?limit=25&page=11" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-price?limit=25&page=4" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-price?limit=25&page=2" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" } } } @@ -3901,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -3916,11 +3916,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "Create a new Swag Customized Products Template Option Price resources.", + "summary": "Create a new Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionPrice", + "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "_response", @@ -3939,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -3958,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -3973,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -3989,14 +3989,14 @@ } } }, - "/search/swag-customized-products-template-option-price": { + "/search/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "Search for the Swag Customized Products Template Option Price resources.", + "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", + "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "sw-include-search-info", @@ -4024,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -4038,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4056,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4073,19 +4073,19 @@ } } }, - "/swag-customized-products-template-option-price/{id}": { + "/swag-customized-products-template-configuration-share/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", + "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPrice", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -4095,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -4107,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4122,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4139,16 +4139,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "Delete a Swag Customized Products Template Option Price resource.", + "summary": "Delete a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", + "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -4179,16 +4179,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", + "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", + "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -4206,18 +4206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Price resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -4229,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4244,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4263,14 +4263,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-price": { + "/aggregate/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Configuration Share" ], - "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", + "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", + "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", "requestBody": { "required": true, "content": { @@ -4294,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -4308,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4326,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -4343,14 +4343,14 @@ } } }, - "/swag-customized-products-template-option-value": { + "/swag-customized-products-template-exclusion": { "get": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "List with basic information of Swag Customized Products Template Option Value resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValueList", + "operationId": "getSwagCustomizedProductsTemplateExclusionList", "parameters": [ { "name": "limit", @@ -4379,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value resources.", + "description": "List of Swag Customized Products Template Exclusion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4398,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } ] @@ -4412,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-value?limit=25" + "example": "/swag-customized-products-template-exclusion?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-value?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-value?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-value?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion?limit=25&page=2" } } } @@ -4442,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4457,11 +4457,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "Create a new Swag Customized Products Template Option Value resources.", + "summary": "Create a new Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValue", + "operationId": "createSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "_response", @@ -4480,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -4499,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4514,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4530,14 +4530,14 @@ } } }, - "/search/swag-customized-products-template-option-value": { + "/search/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "Search for the Swag Customized Products Template Option Value resources.", + "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "operationId": "searchSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "sw-include-search-info", @@ -4565,7 +4565,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -4579,7 +4579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4597,7 +4597,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4614,19 +4614,19 @@ } } }, - "/swag-customized-products-template-option-value/{id}": { + "/swag-customized-products-template-exclusion/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValue", + "operationId": "getSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -4636,7 +4636,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -4648,7 +4648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4663,7 +4663,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4680,16 +4680,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "Delete a Swag Customized Products Template Option Value resource.", + "summary": "Delete a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", + "operationId": "deleteSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -4720,16 +4720,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValue", + "operationId": "updateSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -4747,18 +4747,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -4770,7 +4770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4785,7 +4785,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4804,14 +4804,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-value": { + "/aggregate/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Exclusion" ], - "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", "requestBody": { "required": true, "content": { @@ -4835,7 +4835,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -4849,7 +4849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4867,7 +4867,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -4884,14 +4884,14 @@ } } }, - "/swag-customized-products-template-option-value-price": { + "/swag-customized-products-template-exclusion-condition": { "get": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", + "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", "parameters": [ { "name": "limit", @@ -4920,7 +4920,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value Price resources.", + "description": "List of Swag Customized Products Template Exclusion Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4939,7 +4939,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } ] @@ -4953,16 +4953,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-value-price?limit=25" + "example": "/swag-customized-products-template-exclusion-condition?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" } } } @@ -4983,7 +4983,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -4998,11 +4998,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Create a new Swag Customized Products Template Option Value Price resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "_response", @@ -5021,14 +5021,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5040,7 +5040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5055,7 +5055,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5071,14 +5071,14 @@ } } }, - "/search/swag-customized-products-template-option-value-price": { + "/search/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Search for the Swag Customized Products Template Option Value Price resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "sw-include-search-info", @@ -5106,7 +5106,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5120,7 +5120,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5138,7 +5138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5155,19 +5155,19 @@ } } }, - "/swag-customized-products-template-option-value-price/{id}": { + "/swag-customized-products-template-exclusion-condition/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -5177,7 +5177,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5189,7 +5189,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5204,7 +5204,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5221,16 +5221,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Delete a Swag Customized Products Template Option Value Price resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -5261,16 +5261,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -5288,18 +5288,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5311,7 +5311,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5326,7 +5326,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5345,14 +5345,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-value-price": { + "/aggregate/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", "requestBody": { "required": true, "content": { @@ -5376,7 +5376,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5390,7 +5390,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5408,7 +5408,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -5425,406 +5425,449 @@ } } }, - "/_action/validation/email": { - "post": { - "tags": [ - "Email support validation" - ], - "summary": "Email support.", - "description": "Checks a given email string.", - "operationId": "supportsEmail", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "email" - ], - "properties": { - "email": { - "description": "The email to be verified.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Email is supported" - }, - "400": { - "description": "Invalid request payload. The argument 'email' may be missing.", - "content": { - "application/json": { - "schema": { - "properties": { - "errors": { - "description": "Contains the error message.", - "type": "array" - } - }, - "type": "object" - }, - "example": { - "errors": [ - { - "code": "0", - "status": "400", - "title": "Unprocessable Content", - "detail": "This value should not be blank." - } - ] - } - } - } - }, - "422": { - "description": "Email address is not supported.", - "content": { - "application/json": { - "schema": { - "properties": { - "errors": { - "description": "Contains the validation error.", - "type": "array" - } - }, - "type": "object" - }, - "example": { - "errors": [ - { - "code": "0", - "status": "422", - "title": "Unprocessable Content", - "detail": "This value is not a supported email address." - } - ] - } - } - } - } - } - } - }, - "/app-system/shop/verify": { + "/swag-customized-products-template-exclusion-operator": { "get": { "tags": [ - "App System", - "Public" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", "parameters": [ { - "name": "runId", - "in": "query", - "description": "A unique identifier used to look up the token", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", + "name": "limit", "in": "query", - "description": "A unique identifier", - "required": true, + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string" + "type": "integer" } - } - ], - "responses": { - "204": { - "description": "An empty response signalling successful verification." }, - "400": { - "description": "Malformed request or unsuccessful verification." - } - } - } - }, - "/_action/system-config": { - "get": { - "tags": [ - "System Config" - ], - "summary": "Get configuration values", - "description": "Returns the configuration values for the given domain and optional sales channel.", - "operationId": "getConfigurationValues", - "parameters": [ { - "name": "domain", + "name": "page", "in": "query", - "description": "The configuration domain.", - "required": true, + "description": "The page to be returned", "schema": { - "type": "string" + "type": "integer" } }, { - "name": "salesChannelId", + "name": "query", "in": "query", - "description": "The sales channel ID to scope the configuration to.", + "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } - }, - { - "name": "inherit", - "in": "query", - "description": "Whether to include inherited (global) values.", - "schema": { - "type": "boolean", - "default": false - } } ], "responses": { "200": { - "description": "Returns the configuration values as a key-value object." + "description": "List of Swag Customized Products Template Exclusion Operator resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-exclusion-operator?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" } } }, "post": { "tags": [ - "System Config" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Save configuration values", - "description": "Saves the given configuration key-value pairs for the given sales channel.", - "operationId": "saveConfiguration", + "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { - "name": "salesChannelId", - "in": "query", - "description": "The sales channel ID to scope the configuration to.", - "schema": { - "type": "string" - } - }, - { - "name": "silent", + "name": "_response", "in": "query", - "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "description": "Data format for response. Empty if none is provided.", "schema": { - "type": "boolean", - "default": false + "type": "string", + "enum": [ + "basic", + "detail" + ] } } ], "requestBody": { - "description": "Key-value pairs of configuration values to save.", - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": true + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, - "responses": { - "204": { - "description": "Configuration saved successfully." - } - } - } - }, - "/_action/system-config/check": { - "get": { - "tags": [ - "System Config" - ], - "summary": "Check configuration", - "description": "Checks if a configuration domain exists.", - "operationId": "checkConfiguration", - "parameters": [ - { - "name": "domain", - "in": "query", - "description": "The configuration domain to check.", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { "200": { - "description": "Returns whether the configuration domain exists." - } - } - } - }, - "/_action/system-config/schema": { - "get": { - "tags": [ - "System Config" - ], - "summary": "Get configuration schema", - "description": "Returns the configuration schema for the given domain.", - "operationId": "getConfiguration", - "parameters": [ - { - "name": "domain", - "in": "query", - "description": "The configuration domain.", - "required": true, - "schema": { - "type": "string" + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } } - } - ], - "responses": { - "200": { - "description": "Returns the configuration schema." + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/system-config/batch": { + "/search/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "System Config" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Batch save configuration values", - "description": "Saves configuration values for multiple sales channels at once. The request body is keyed by sales channel ID (use \"null\" for global scope).", - "operationId": "batchSaveConfiguration", + "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { - "name": "silent", - "in": "query", - "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { - "type": "boolean", - "default": false + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" } } ], "requestBody": { - "description": "Object keyed by sales channel ID, each containing key-value pairs of configuration values.", "required": true, "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": true - } + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { - "204": { - "description": "Configuration saved successfully." + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/media/{mediaId}/external-thumbnails": { - "post": { + "/swag-customized-products-template-exclusion-operator/{id}": { + "get": { "tags": [ - "Asset Management" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Add external thumbnails to media", - "description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.", - "operationId": "addExternalThumbnails", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { - "name": "mediaId", + "name": "id", "in": "path", - "description": "ID of the external media entity the thumbnails will be attached to.", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { - "$ref": "#/components/schemas/MediaId" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "thumbnails": { - "type": "array", - "description": "List of external thumbnails to attach", - "items": { - "$ref": "#/components/schemas/ExternalThumbnail" - } - } - } - } - } - } - }, "responses": { - "201": { - "description": "Thumbnails attached successfully", + "200": { + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "mediaId": { - "description": "ID of the media entity the thumbnails were attached to.", - "$ref": "#/components/schemas/MediaId" - }, - "thumbnailsCreated": { - "type": "integer" + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } }, - "400": { - "description": "Media is not an external media entity or path is missing" - }, "404": { - "description": "Media entity not found" + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ - "Asset Management" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Delete all external thumbnails from media", - "description": "Removes all externally stored thumbnail entries from the given media entity. Only works on external media (media with an HTTP/HTTPS path). Used to replace outdated thumbnails with new ones.", - "operationId": "deleteExternalThumbnails", + "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { - "name": "mediaId", + "name": "id", "in": "path", - "description": "ID of the external media entity the thumbnails will be deleted from..", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { - "$ref": "#/components/schemas/MediaId" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Swag Customized Products Template Exclusion Operator" + ], + "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" } } ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + }, "responses": { "200": { - "description": "Thumbnails deleted successfully", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "mediaId": { - "description": "ID of the media entity the thumbnails were deleted from.", - "$ref": "#/components/schemas/MediaId" + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -5832,390 +5875,5504 @@ } }, "400": { - "description": "Media is not an external media entity or path is missing" + "$ref": "#/components/responses/400" }, "404": { - "description": "Media entity not found" + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/user/logout": { + "/aggregate/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Authorization & Authentication" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Logout the current user", - "description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.", - "operationId": "userLogout", - "responses": { - "204": { - "description": "Tokens have been revoked successfully." - }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." - }, - "403": { - "description": "The authenticated source does not have a user ID associated." - } - } - } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" + "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + ] + } }, - { - "$ref": "#/components/schemas/pagination" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } } - ] + } }, - "data": { - "$ref": "#/components/schemas/data" + "400": { + "$ref": "#/components/responses/400" }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" + } + } + }, + "/swag-customized-products-template-option": { + "get": { + "tags": [ + "Swag Customized Products Template Option" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" + "summary": "List with basic information of Swag Customized Products Template Option resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } }, - "links": { - "$ref": "#/components/schemas/links" + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" + "responses": { + "200": { + "description": "List of Swag Customized Products Template Option resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-option?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-option?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-option?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-option?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + } + } }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true + } }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ - { - "$ref": "#/components/schemas/resource" - }, + "post": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Create a new Swag Customized Products Template Option resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateOption", + "parameters": [ { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/attributes" - }, - "relationships": { - "$ref": "#/components/schemas/relationships" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } } }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + ] } }, - { - "$ref": "#/components/schemas/link" + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } } - ] + } }, - "related": { - "$ref": "#/components/schemas/link" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, + } + }, + "/search/swag-customized-products-template-option": { + "post": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Search for the Swag Customized Products Template Option resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOption", + "parameters": [ { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" } } } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ - { - "required": [ - "data" - ] - }, - { - "required": [ - "meta" - ] - }, - { - "required": [ - "links" - ] - }, - { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + ] + } }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" - }, - { - "$ref": "#/components/schemas/relationshipToMany" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } } - ] + } } } - } - ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ - { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." }, - { - "$ref": "#/components/schemas/linkage" - } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" - ], - "properties": { - "type": { + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Detailed information about a Swag Customized Products Template Option resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOption", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Delete a Swag Customized Products Template Option resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOption", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Partially update information about a Swag Customized Products Template Option resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateOption", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Option resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-option": { + "post": { + "tags": [ + "Swag Customized Products Template Option" + ], + "summary": "Aggregate for the Swag Customized Products Template Option resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOption", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-price": { + "get": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "List with basic information of Swag Customized Products Template Option Price resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Swag Customized Products Template Option Price resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-option-price?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-option-price?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-option-price?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-option-price?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Create a new Swag Customized Products Template Option Price resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateOptionPrice", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-option-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Search for the Swag Customized Products Template Option Price resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-price/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Delete a Swag Customized Products Template Option Price resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Option Price resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-option-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-value": { + "get": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "List with basic information of Swag Customized Products Template Option Value resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValueList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Swag Customized Products Template Option Value resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-option-value?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-option-value?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-option-value?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-option-value?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Create a new Swag Customized Products Template Option Value resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-option-value": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Search for the Swag Customized Products Template Option Value resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-value/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Delete a Swag Customized Products Template Option Value resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Option Value resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-option-value": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValue", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-value-price": { + "get": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Swag Customized Products Template Option Value Price resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-option-value-price?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Create a new Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-option-value-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Search for the Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-value-price/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Delete a Swag Customized Products Template Option Value Price resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-option-value-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value Price" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_action/mail-template/simulate": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Simulate a mail template", + "description": "Generates simulated data for a given event name and renders the provided mail template content against it.", + "operationId": "simulateMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "templateParts", + "eventName" + ], + "properties": { + "templateParts": { + "description": "A map of mail template fields and their template content to render.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "example": { + "subject": "Order {{ order.orderNumber }} confirmation", + "senderName": "{{ salesChannel.name }}", + "contentHtml": "
Hello {{ order.orderCustomer.firstName }}
", + "contentPlain": "Hello {{ order.orderCustomer.firstName }}" + } + }, + "eventName": { + "description": "The business event name used to generate simulated mail template data.", + "type": "string", + "example": "checkout.order.placed" + }, + "salesChannelId": { + "description": "Identifier of the sales channel that should be used for the simulate request.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + }, + "strictRendering": { + "description": "Enables strict variable rendering and surfaces errors for unknown variables. Defaults to `true`.", + "type": "boolean", + "default": true + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A map of render results keyed by the same field names that were provided in the request's `templateParts` object.", + "additionalProperties": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template field. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Example mail" + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request data or invalid eventName", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/mail-template/preview": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Fetches the required data needed for the mail template and generates a preview.", + "operationId": "mailTemplatePreview", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateId" + ], + "properties": { + "mailTemplateId": { + "description": "Identifier of the mail template which should be rendered.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f678906" + }, + "salesChannelId": { + "description": "Identifier of the sales channel that should be used for the preview request.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + }, + "includeHeaderFooter": { + "description": "Includes the sales channel mail header and footer in `contentHtml` and `contentPlain`. Defaults to `false`.", + "type": "boolean", + "default": false + }, + "strictRendering": { + "description": "Enables strict variable rendering and enables errors on e.g. unknown variables. Defaults to `false`.", + "type": "boolean", + "default": false + }, + "entities": { + "description": "A map of entity names and corresponding identifiers that define entities which should be used additionally during rendering.", + "type": "object", + "additionalProperties": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "example": { + "order": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a", + "customer": "a1b2c3d4e5f67890b3c4d5e6f7a8b90a" + } + }, + "templateData": { + "description": "A map of template data that should be used additionally during rendering. Values in this map override generated or entity-derived template data with the same top-level keys.", + "type": "object", + "additionalProperties": true, + "example": { + "salesChannel": { + "name": "Storefront" + }, + "order": { + "orderNumber": "SW10042" + } + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "subject", + "senderName", + "contentHtml", + "contentPlain" + ], + "properties": { + "subject": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template's subject. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Example mail" + } + } + }, + "senderName": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template's sender name. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Storefront" + } + } + }, + "contentHtml": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template in html format. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "
Hello Mr. Mustermann,
this is example mail content, the current date is 16.03.2026.
" + } + } + }, + "contentPlain": { + "type": "object", + "required": [ + "type", + "content" + ], + "properties": { + "type": { + "description": "The type of the render result (either `success` or `error`)", + "type": "string", + "enum": [ + "success", + "error" + ], + "example": "success" + }, + "content": { + "description": "The rendered content of the mail template in plain text format. Also contains the error when rendering this field wasn't possible.", + "type": "string", + "example": "Hello Mr. Mustermann, this is example mail content, the current date is 16.03.2026." + } + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request data or invalid mailTemplateId", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/mail-template/get-data-and-send": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Fetch the template data and send a mail", + "description": "Generates the required data needed for the mail template, renders the mail content and sends it to the customer.", + "operationId": "generateAndSendMail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateId", + "recipients", + "salesChannelId" + ], + "properties": { + "mailTemplateId": { + "description": "Identifier of the mail template which should be rendered.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + }, + "recipients": { + "description": "A map of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format. If passed, this content will be used instead of the content from the mail template.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text. If passed, this content will be used instead of the content from the mail template.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail. If passed, this subject will be used instead of the subject from the mail template.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender. If passed, this sender name will be used instead of the sender name from the mail template.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string", + "format": "email" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "documentIds": { + "description": "List of document identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "type": "array", + "items": { + "required": [ + "content", + "fileName", + "mimeType" + ], + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A mail address or a map of recipients with name and mail address to be set in BCC.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "recipientsCc": { + "description": "A mail address or a map of recipients with name and mail address to be set in CC.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "replyTo": { + "description": "A mail address or a map of mail addresses with name to be set in reply-to.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "returnPath": { + "description": "A mail address or a map of mail addresses with name to be set in return-path.", + "oneOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient. Can be null to omit the display name.", + "type": [ + "string", + "null" + ] + } + } + ] + }, + "entities": { + "description": "A map of entity names and corresponding identifiers that define entities which should be used additionally during rendering.", + "type": "object", + "additionalProperties": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "example": { + "order": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a", + "customer": "a1b2c3d4e5f67890b3c4d5e6f7a8b90a" + } + }, + "templateData": { + "description": "A map of template data that should be used additionally during rendering. Values in this map override generated or entity-derived template data with the same top-level keys.", + "type": "object", + "additionalProperties": true, + "example": { + "salesChannel": { + "name": "Storefront" + }, + "order": { + "orderNumber": "SW10042" + } + } + }, + "testMode": { + "description": "Enables mail test mode. The mail is still sent, but template rendering runs with the renderer's test mode enabled, a fallback `order.deepLinkCode` of `home` is injected when missing, and debug headers such as `X-Shopware-Language-Id` plus available event or sales-channel headers are added to the message.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "required": [ + "size" + ], + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Invalid request data or invalid mailTemplateId", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/mail-template/available-variables": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Fetch the available variables for a business event and an optional parent variable path.", + "description": "Fetches the available variables that a business event provides for a certain parent variable path to determine which variables can be used in a mail template.", + "operationId": "mailTemplateAvailableVariables", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "eventName" + ], + "properties": { + "eventName": { + "description": "The business event name that provides the available variables.", + "type": "string", + "example": "checkout.order.placed" + }, + "parentVariablePath": { + "description": "The path to the parent field of which the available variables should be returned. If omitted or empty, the top-level variables of the business event are returned.", + "type": "string", + "example": "order.transactions" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The available variables got fetched successfully.", + "content": { + "application/json": { + "schema": { + "items": { + "type": "object", + "required": [ + "fieldName", + "hasChildren" + ], + "properties": { + "fieldName": { + "description": "The name of the variable.", + "type": "string", + "example": "salesChannel" + }, + "hasChildren": { + "description": "Shows if behind the variable are more nested variables which can be accessed by another request to this endpoint with the updated parent variable path: `.`", + "type": "boolean", + "example": true + } + } + }, + "type": "array", + "description": "A collection of the available variables which also show if behind the variables are more nested variables." + } + } + } + }, + "400": { + "description": "Invalid request data or invalid eventName", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}": { + "get": { + "tags": [ + "Sales Channel Files" + ], + "summary": "List discovered sales channel files", + "description": "Lists all discovered public files for a file family and sales channel, including content type and the stored sales-channel configuration when one exists.", + "operationId": "listSalesChannelFiles", + "parameters": [ + { + "name": "fileFamily", + "in": "path", + "description": "File family below `Resources/views/files`, for example `agentic`.", + "required": true, + "schema": { + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" + } + }, + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel for which stored configuration should be loaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Discovered sales channel files for the given file family.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFileListResponse" + } + } + } + }, + "400": { + "description": "Invalid file family.", + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/detail": { + "get": { + "tags": [ + "Sales Channel Files" + ], + "summary": "Load sales channel file detail", + "description": "Loads detail data for a discovered public file, including contributing Twig templates, their source content, and the stored sales-channel configuration when one exists.", + "operationId": "getSalesChannelFileDetail", + "parameters": [ + { + "name": "fileFamily", + "in": "path", + "description": "File family below `Resources/views/files`, for example `agentic`.", + "required": true, + "schema": { + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" + } + }, + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel for which stored configuration should be loaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Public file path without a leading slash. Subfolders are supported, for example `.well-known/ucp.json`.", + "required": true, + "schema": { + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + } + } + ], + "responses": { + "200": { + "description": "Detail data for the discovered sales channel file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFileDetailResponse" + } + } + } + }, + "400": { + "description": "Invalid file family or file name.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The requested sales channel file was not discovered.", + "$ref": "#/components/responses/404" + } + } + } + }, + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/preview": { + "post": { + "tags": [ + "Sales Channel Files" + ], + "summary": "Preview a sales channel file", + "description": "Renders a discovered public file for a sales channel with the supplied Twig template overrides. This allows Administration previews without persisting the overrides first.", + "operationId": "previewSalesChannelFile", + "parameters": [ + { + "name": "fileFamily", + "in": "path", + "description": "File family below `Resources/views/files`, for example `agentic`.", + "required": true, + "schema": { + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" + } + }, + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel used to build the rendering context.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "description": "Preview input containing the public file name and optional Twig overrides keyed by Twig namespace.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFilePreviewRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Rendered preview content.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFilePreviewResponse" + } + } + } + }, + "400": { + "description": "Invalid request payload, file family, or file name.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The requested sales channel file was not discovered.", + "$ref": "#/components/responses/404" + } + } + } + }, + "/_action/media/presign-upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Prepare a presigned upload", + "description": "Creates or reuses a media entity and returns a presigned S3 URL for direct browser-to-storage upload. The client uploads the file directly to the returned URL, then calls the finalize endpoint.", + "operationId": "presignUpload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileName", + "extension", + "mimeType" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file without extension" + }, + "extension": { + "type": "string", + "description": "File extension, e.g. `jpg`, `png`, `pdf`" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file, e.g. `image/jpeg`" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder to place the new media in" + }, + "private": { + "type": "boolean", + "default": false, + "description": "Whether the media should be private" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of an existing media entity to replace. If omitted, a new entity is created." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Presigned upload prepared successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mediaId", + "url", + "path", + "expiresAt", + "isDuplicate" + ], + "properties": { + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media entity" + }, + "url": { + "type": "string", + "description": "Presigned URL to upload the file to via HTTP PUT" + }, + "path": { + "type": "string", + "description": "Storage path of the media file, required for the finalize call" + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "Expiration time of the presigned URL" + }, + "isDuplicate": { + "type": "boolean", + "description": "Whether a file with the same name already exists" + } + } + } + } + } + }, + "400": { + "description": "Bad request. The file extension is not supported or the file name is invalid.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The media entity with the given `mediaId` was not found.", + "$ref": "#/components/responses/404" + }, + "422": { + "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`) must not be blank.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } + } + } + } + }, + "/_action/media/{mediaId}/finalize-upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Finalize a presigned upload", + "description": "Confirms that the file has been uploaded to storage via the presigned URL and updates the media entity with file metadata.", + "operationId": "finalizeUpload", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "required": true, + "description": "ID of the media entity to finalize", + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileName", + "extension", + "mimeType", + "path" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file without extension" + }, + "extension": { + "type": "string", + "description": "File extension, e.g. `jpg`, `png`, `pdf`" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "path": { + "type": "string", + "description": "Storage path returned by the presign-upload endpoint" + }, + "width": { + "type": "integer", + "description": "Image width in pixels (optional, for images only)" + }, + "height": { + "type": "integer", + "description": "Image height in pixels (optional, for images only)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Upload finalized successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "mediaId" + ], + "properties": { + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the finalized media entity" + } + } + } + } + } + }, + "400": { + "description": "Bad request. The file extension is not supported, the storage path does not match, the file name is already taken, or the file could not be found on the remote storage.", + "$ref": "#/components/responses/400" + }, + "404": { + "description": "The media entity with the given `mediaId` was not found.", + "$ref": "#/components/responses/404" + }, + "422": { + "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`, `path`) must not be blank.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } + } + } + } + }, + "/_action/number-range/{numberRangeId}/preview-pattern": { + "get": { + "tags": [ + "Number Range Management" + ], + "summary": "Preview a persisted number range", + "description": "Previews the next value for a concrete persisted number range without incrementing its state. Optional `pattern` and `start` query parameters can be used to preview unsaved changes while editing the number range. Use `/_action/number-range/reserve/{type}` for actual allocation by business type and sales channel.", + "operationId": "numberRangePreviewPatternById", + "parameters": [ + { + "name": "numberRangeId", + "in": "path", + "description": "Identifier of the number range to preview.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "pattern", + "in": "query", + "description": "Optional pattern override for the preview.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "start", + "in": "query", + "description": "Optional start value override for the preview.", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "The previewed number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The previewed number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "404": { + "description": "Number range not found" + } + } + } + }, + "/_action/integration/{integrationId}/mcp-allowlist": { + "post": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "Save MCP allowlist for an integration", + "description": "Saves the per-integration MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `integration_mcp.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "saveMcpAllowlist", + "parameters": [ + { + "name": "integrationId", + "in": "path", + "required": true, + "description": "The integration UUID.", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "allowlist" + ], + "properties": { + "allowlist": { + "oneOf": [ + { + "type": "object", + "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", + "properties": { + "tools": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed tool names. Empty array = no tools allowed." + }, + { + "type": "null", + "description": "Null = all tools allowed." + } + ] + }, + "resources": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed resource URIs. Empty array = no resources allowed." + }, + { + "type": "null", + "description": "Null = all resources allowed." + } + ] + }, + "prompts": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed prompt names. Empty array = no prompts allowed." + }, + { + "type": "null", + "description": "Null = all prompts allowed." + } + ] + } + } + }, + { + "type": "null", + "description": "Null = all capabilities unrestricted." + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Allowlist saved successfully." + }, + "400": { + "description": "Bad request — missing or invalid `allowlist` field." + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "403": { + "description": "Forbidden — caller lacks `integration_mcp.editor` privilege." + }, + "404": { + "description": "Integration not found." + } + } + } + }, + "/_action/user/{userId}/mcp-allowlist": { + "post": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "Save MCP allowlist for a user", + "description": "Saves the per-user MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `users_and_permissions.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "saveMcpAllowlistUser", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "description": "The user UUID.", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "allowlist" + ], + "properties": { + "allowlist": { + "oneOf": [ + { + "type": "object", + "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", + "properties": { + "tools": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed tool names. Empty array = no tools allowed." + }, + { + "type": "null", + "description": "Null = all tools allowed." + } + ] + }, + "resources": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed resource URIs. Empty array = no resources allowed." + }, + { + "type": "null", + "description": "Null = all resources allowed." + } + ] + }, + "prompts": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allowed prompt names. Empty array = no prompts allowed." + }, + { + "type": "null", + "description": "Null = all prompts allowed." + } + ] + } + } + }, + { + "type": "null", + "description": "Null = all capabilities unrestricted." + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Allowlist saved successfully." + }, + "400": { + "description": "Bad request — missing or invalid `allowlist` field." + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "403": { + "description": "Forbidden — caller lacks `users_and_permissions.editor` privilege." + }, + "404": { + "description": "User not found." + } + } + } + }, + "/_action/mcp/tools": { + "get": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "List registered MCP tools", + "description": "Returns all MCP tools currently registered on this Shopware installation. For all capability types (tools, resources, prompts) use `GET /_action/mcp/capabilities` instead. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "mcpToolsList", + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "responses": { + "200": { + "description": "Array of registered MCP tools.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Unique tool identifier used in `tools/call` requests.", + "example": "shopware-entity-search" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Human-readable description of what the tool does.", + "example": "Search Shopware entities and return matching records." + }, + "dependencies": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tool names that are automatically included when this tool is selected." + }, + "requiredPrivileges": { + "oneOf": [ + { + "type": "object", + "properties": { + "static": { + "type": "array", + "items": { + "type": "string" + } + }, + "entityParam": { + "type": [ + "string", + "null" + ] + }, + "operations": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + { + "type": "null" + } + ], + "description": "ACL privileges required by this tool." + } + } + } + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "403": { + "description": "Forbidden — caller lacks `integration.editor` privilege." + } + } + } + }, + "/_action/mcp/capabilities": { + "get": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "List all registered MCP capabilities", + "description": "Returns all registered MCP tools, resources, and prompts. Used by the Admin UI to populate the per-integration allowlist selector. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "mcpCapabilitiesList", + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "responses": { + "200": { + "description": "Object containing all registered MCP capabilities.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tools", + "resources", + "prompts" + ], + "properties": { + "tools": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "example": "shopware-entity-search" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "dependencies": { + "type": "array", + "items": { + "type": "string" + } + }, + "requiredPrivileges": { + "oneOf": [ + { + "type": "object", + "properties": { + "static": { + "type": "array", + "items": { + "type": "string" + } + }, + "entityParam": { + "type": [ + "string", + "null" + ] + }, + "operations": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + { + "type": "null" + } + ] + } + } + } + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "required": [ + "uri", + "name" + ], + "properties": { + "uri": { + "type": "string", + "example": "shopware://entity-list" + }, + "name": { + "type": "string", + "example": "shopware-entity-list" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "mimeType": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "prompts": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "example": "shopware-context" + }, + "description": { + "type": [ + "string", + "null" + ] + } + } + } + } + } + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "403": { + "description": "Forbidden — caller lacks `integration.editor` privilege." + } + } + } + }, + "/_mcp": { + "post": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "MCP JSON-RPC endpoint", + "description": "Handles Model Context Protocol (MCP) requests using the Streamable HTTP transport. Accepts JSON-RPC 2.0 messages for methods such as `initialize`, `tools/list`, `tools/call`, `prompts/list`, `prompts/get`, `resources/list`, and `resources/read`. Requires either an integration access key pair (`sw-access-key` + `sw-secret-access-key` headers) or a standard OAuth2 bearer token. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "mcpPost", + "parameters": [ + { + "name": "mcp-session-id", + "in": "header", + "required": false, + "description": "Session ID returned by the server after `initialize`. Required for all requests except `initialize`.", + "schema": { + "type": "string" + } + }, + { + "name": "sw-access-key", + "in": "header", + "required": false, + "description": "Integration access key for direct credential authentication (alternative to bearer token).", + "schema": { + "type": "string" + } + }, + { + "name": "sw-secret-access-key", + "in": "header", + "required": false, + "description": "Integration secret access key. Required when `sw-access-key` is provided.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "A JSON-RPC 2.0 request or batch.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "jsonrpc", + "method" + ], + "properties": { + "jsonrpc": { + "type": "string", + "enum": [ + "2.0" + ] + }, + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ] + }, + "method": { + "type": "string", + "example": "tools/call" + }, + "params": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "JSON-RPC response or Server-Sent Events stream for long-running operations.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "jsonrpc": { + "type": "string", + "enum": [ + "2.0" + ] + }, + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ] + }, + "result": { + "type": "object", + "additionalProperties": true + }, + "error": { + "type": "object", + "properties": { + "code": { + "type": "integer" + }, + "message": { + "type": "string" + } + } + } + } + } + }, + "text/event-stream": { + "schema": { + "type": "string", + "description": "Server-Sent Events stream for streaming responses." + } + } + } + }, + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "429": { + "description": "Too many requests — rate limit exceeded." + } + } + }, + "get": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "MCP SSE stream", + "description": "Opens a Server-Sent Events stream for receiving server-initiated messages. Used by MCP clients that support the SSE transport variant. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "mcpGet", + "parameters": [ + { + "name": "mcp-session-id", + "in": "header", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Server-Sent Events stream.", + "content": { + "text/event-stream": { + "schema": { + "type": "string" + } + } + } + }, + "401": { + "description": "Unauthorized." + } + } + }, + "delete": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "Close MCP session", + "description": "Terminates an active MCP session identified by the `mcp-session-id` header. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "mcpDelete", + "parameters": [ + { + "name": "mcp-session-id", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Session closed successfully." + }, + "401": { + "description": "Unauthorized." + } + } + }, + "options": { + "tags": [ + "MCP", + "Experimental" + ], + "summary": "MCP CORS preflight", + "description": "Handles CORS preflight requests for the MCP endpoint. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "mcpOptions", + "responses": { + "204": { + "description": "CORS preflight accepted." + } + } + } + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" + }, + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" + }, + { + "$ref": "#/components/schemas/pagination" + } + ] + }, + "data": { + "$ref": "#/components/schemas/data" + }, + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + }, + "type": "object", + "additionalProperties": false + }, + "failure": { + "required": [ + "errors" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true + } + }, + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" + } + }, + "type": "object" + }, + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string" + }, + "attributes": { + "$ref": "#/components/schemas/attributes" + }, + "relationships": { + "$ref": "#/components/schemas/relationships" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object" + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "properties": { + "self": { + "allOf": [ + { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "type": "array", + "items": { + "type": "object" + } + }, + { + "$ref": "#/components/schemas/link" + } + ] + }, + "related": { + "$ref": "#/components/schemas/link" + } + }, + "type": "object", + "additionalProperties": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ + { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + { + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] + }, + { + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" + }, + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] + } + } + } + ], + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ + { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." + }, + { + "$ref": "#/components/schemas/linkage" + } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" + }, + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" + }, + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" + }, + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" + } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "error": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for this particular occurrence of the problem." + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "status": { + "type": "string", + "description": "The HTTP status code applicable to this problem, expressed as a string value." + }, + "code": { + "type": "string", + "description": "An application-specific error code, expressed as a string value." + }, + "title": { + "type": "string", + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem." + }, + "description": { + "type": "string", + "description": "A human-readable description of the problem." + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "type": "string", + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." + }, + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." + } + } + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "AclRoleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "users": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" + } + } + } + } + }, + "type": "object" + }, + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "integrations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "example": "415320131958c70f4f250ca4d7e63bbd" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AclRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + }, + "type": "object" + }, + "AclUserRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "userId", + "aclRoleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + } + }, + "type": "object" + }, + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" + ], + "properties": { + "id": { + "type": "string", + "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": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "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": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "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}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" + }, + "aclRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "250aa1c64b973365fd6fd489eefbdefc" + } + } + } + }, + "type": "object" + }, + "customFieldSets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } + } + } + } + }, + "type": "object" + }, + "actionButtons": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_action_button" + }, + "id": { + "type": "string", + "example": "2c7967427ed432e546ef1c0cb8d5da9e" + } + } + } + } + }, + "type": "object" + }, + "templates": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_template" + }, + "id": { + "type": "string", + "example": "fed36e93a0509e20f2dc96cbbd85b678" + } + } + } + } + }, + "type": "object" + }, + "webhooks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "webhook" + }, + "id": { + "type": "string", + "example": "c10f40999b74c408263f790b30e70efe" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "taxProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } + } + } + } + }, + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } + } + } + } + }, + "type": "object" + }, + "flowActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_action" + }, + "id": { + "type": "string", + "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + } + } + } + } + }, + "type": "object" + }, + "flowEvents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_event" + }, + "id": { + "type": "string", + "example": "045e9ec14eafd26d17854fb4fe7c9cae" + } + } + } + } + }, + "type": "object" + }, + "appShippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" + } + } + } + } + }, + "type": "object" + }, + "mcpTools": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpTools" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_mcp_tool" + }, + "id": { + "type": "string", + "example": "6fd6afdbb8880347183b3fd75e779316" + } + } + } + } + }, + "type": "object" + }, + "mcpPrompts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpPrompts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_mcp_prompt" + }, + "id": { + "type": "string", + "example": "dc6c2e9bc841c62a89cf5b3aa42f83d3" + } + } + } + } + }, + "type": "object" + }, + "mcpResources": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpResources" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_mcp_resource" + }, + "id": { + "type": "string", + "example": "8357adcc66e1f74c8b7f688333874068" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "App": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" + ], + "properties": { + "id": { + "type": "string", + "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": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "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": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { "type": "string" }, - "id": { + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object", - "additionalProperties": false - }, - "pagination": { - "properties": { - "first": { - "description": "The first page of data", + "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", - "format": "uri-reference" + "pattern": "^[0-9a-f]{32}$" }, - "last": { - "description": "The last page of data", + "createdAt": { "type": "string", - "format": "uri-reference" + "format": "date-time", + "readOnly": true }, - "prev": { - "description": "The previous page of data", + "updatedAt": { "type": "string", - "format": "uri-reference" + "format": "date-time", + "readOnly": true }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" - } - }, - "type": "object" - }, - "jsonapi": { - "description": "An object describing the server's implementation", - "properties": { - "version": { - "type": "string" + "translated": { + "type": "object" }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object", - "additionalProperties": false - }, - "error": { - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for this particular occurrence of the problem." + "integration": { + "$ref": "#/components/schemas/Integration" }, - "links": { - "$ref": "#/components/schemas/links" + "aclRole": { + "$ref": "#/components/schemas/AclRole" }, - "status": { - "type": "string", - "description": "The HTTP status code applicable to this problem, expressed as a string value." + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } }, - "code": { - "type": "string", - "description": "An application-specific error code, expressed as a string value." + "actionButtons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } }, - "title": { - "type": "string", - "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem." + "webhooks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } }, - "description": { - "type": "string", - "description": "A human-readable description of the problem." + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } }, - "source": { - "type": "object", - "properties": { - "pointer": { - "type": "string", - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." - }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." - } + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" } }, - "meta": { - "$ref": "#/components/schemas/meta" + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + }, + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + }, + "mcpTools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppMcpTool" + } + }, + "mcpPrompts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppMcpPrompt" + } + }, + "mcpResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppMcpResource" + } } }, - "type": "object", - "additionalProperties": false + "type": "object" }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -6223,31 +11380,41 @@ { "required": [ "id", - "name" + "entity", + "view", + "url", + "action", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the ACL role defined.", + "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, - "description": { - "description": "A short description of the ACL role.", + "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, - "privileges": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" }, - "deletedAt": { - "description": "Time and date when the ACL role was deleted.", + "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", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -6259,39 +11426,11 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "users": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" - } - } - } - } - }, - "type": "object" - }, "app": { "properties": { "links": { @@ -6300,7 +11439,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" + "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" } } }, @@ -6320,37 +11459,6 @@ } }, "type": "object" - }, - "integrations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "example": "415320131958c70f4f250ca4d7e63bbd" - } - } - } - } - }, - "type": "object" } }, "type": "object" @@ -6360,35 +11468,45 @@ } ] }, - "AclRole": { - "description": "Added since version: 6.0.0.0", + "AppActionButton": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "name" + "entity", + "view", + "url", + "action", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the ACL role defined.", + "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, - "description": { - "description": "A short description of the ACL role.", + "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, - "privileges": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" }, - "deletedAt": { - "description": "Time and date when the ACL role was deleted.", + "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", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -6400,40 +11518,228 @@ "format": "date-time", "readOnly": true }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "translated": { + "type": "object" }, "app": { "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } + { + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "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}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" } - }, - "type": "object" + ] }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", "required": [ - "userId", - "aclRoleId" + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Name of app's CMS block.", + "type": "string" }, - "aclRoleId": { + "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}$" }, @@ -6447,17 +11753,17 @@ "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "translated": { + "type": "object" }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "AppJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -6465,11 +11771,9 @@ { "required": [ "id", + "appId", "name", - "path", - "version", - "integrationId", - "aclRoleId", + "url", "label" ], "properties": { @@ -6477,127 +11781,63 @@ "type": "string", "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" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "privacy": { - "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "name": { + "description": "Name of app flow action.", "type": "string" }, - "version": { - "description": "Version of the plugin.", + "badge": { "type": "string" }, - "icon": { - "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { + "parameters": { "type": "object" }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", - "type": "boolean" + "config": { + "type": "object" }, - "baseAppUrl": { - "description": "Root URL for an app.", - "type": "string" + "headers": { + "type": "object" }, - "allowedHosts": { + "requirements": { "type": "array", "items": { "type": "string" } }, - "templateLoadPriority": { - "description": "A numerical value to prioritize one of the templates from the list.", - "type": "integer", - "format": "int64" - }, - "checkoutGatewayUrl": { + "iconRaw": { "type": "string" }, - "contextGatewayUrl": { - "type": "string" + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "inAppPurchasesGatewayUrl": { + "swIcon": { "type": "string" }, - "sourceType": { + "url": { + "description": "An URL to app flow action.", "type": "string" }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { + "delayable": { "type": "boolean" }, - "requestedPrivileges": { - "type": "array", - "items": { - "type": "string" - } - }, "label": { "type": "string" }, "description": { "type": "string" }, - "privacyPolicyExtensions": { + "headline": { "type": "string" }, "customFields": { "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}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -6613,282 +11853,7 @@ }, "relationships": { "properties": { - "integration": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "776ea3bf11df5829827f7afb43c37174" - } - } - } - }, - "type": "object" - }, - "aclRole": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "acl_role" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "250aa1c64b973365fd6fd489eefbdefc" - } - } - } - }, - "type": "object" - }, - "customFieldSets": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" - } - } - } - } - }, - "type": "object" - }, - "actionButtons": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_action_button" - }, - "id": { - "type": "string", - "example": "2c7967427ed432e546ef1c0cb8d5da9e" - } - } - } - } - }, - "type": "object" - }, - "templates": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_template" - }, - "id": { - "type": "string", - "example": "fed36e93a0509e20f2dc96cbbd85b678" - } - } - } - } - }, - "type": "object" - }, - "webhooks": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook" - }, - "id": { - "type": "string", - "example": "c10f40999b74c408263f790b30e70efe" - } - } - } - } - }, - "type": "object" - }, - "paymentMethods": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } - } - } - } - }, - "type": "object" - }, - "taxProviders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax_provider" - }, - "id": { - "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" - } - } - } - } - }, - "type": "object" - }, - "cmsBlocks": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_cms_block" - }, - "id": { - "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" - } - } - } - } - }, - "type": "object" - }, - "flowActions": { + "app": { "properties": { "links": { "type": "object", @@ -6896,61 +11861,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" - } - } - } - } - }, - "type": "object" - }, - "flowEvents": { - "properties": { - "links": { "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_event" - }, - "id": { - "type": "string", - "example": "045e9ec14eafd26d17854fb4fe7c9cae" - } + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "appShippingMethods": { + "flowSequences": { "properties": { "links": { "type": "object", @@ -6958,7 +11890,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" } } }, @@ -6969,11 +11901,11 @@ "properties": { "type": { "type": "string", - "example": "app_shipping_method" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } @@ -6989,15 +11921,13 @@ } ] }, - "App": { - "description": "Added since version: 6.3.1.0", + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", "required": [ "id", + "appId", "name", - "path", - "version", - "integrationId", - "aclRoleId", + "url", "label" ], "properties": { @@ -7005,127 +11935,63 @@ "type": "string", "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" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "privacy": { - "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "name": { + "description": "Name of app flow action.", "type": "string" }, - "version": { - "description": "Version of the plugin.", + "badge": { "type": "string" }, - "icon": { - "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { + "parameters": { "type": "object" }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", - "type": "boolean" + "config": { + "type": "object" }, - "baseAppUrl": { - "description": "Root URL for an app.", - "type": "string" + "headers": { + "type": "object" }, - "allowedHosts": { + "requirements": { "type": "array", "items": { "type": "string" } }, - "templateLoadPriority": { - "description": "A numerical value to prioritize one of the templates from the list.", - "type": "integer", - "format": "int64" - }, - "checkoutGatewayUrl": { + "iconRaw": { "type": "string" }, - "contextGatewayUrl": { - "type": "string" + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "inAppPurchasesGatewayUrl": { + "swIcon": { "type": "string" }, - "sourceType": { + "url": { + "description": "An URL to app flow action.", "type": "string" }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { + "delayable": { "type": "boolean" }, - "requestedPrivileges": { - "type": "array", - "items": { - "type": "string" - } - }, "label": { "type": "string" }, "description": { "type": "string" }, - "privacyPolicyExtensions": { + "headline": { "type": "string" }, "customFields": { "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}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7139,77 +12005,20 @@ "translated": { "type": "object" }, - "integration": { - "$ref": "#/components/schemas/Integration" - }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" - }, - "customFieldSets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - }, - "actionButtons": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } - }, - "templates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - }, - "taxProviders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - }, - "cmsBlocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } - }, - "flowActions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } - }, - "flowEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "app": { + "$ref": "#/components/schemas/App" }, - "appShippingMethods": { + "flowSequences": { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/FlowSequence" } } }, "type": "object" }, - "AppActionButtonJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -7217,42 +12026,33 @@ { "required": [ "id", - "entity", - "view", - "url", - "action", "appId", - "label" + "name", + "aware" ], "properties": { "id": { "type": "string", "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}$" }, + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7263,9 +12063,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { "app": { @@ -7276,7 +12073,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, @@ -7296,6 +12093,37 @@ } }, "type": "object" + }, + "flows": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow" + }, + "id": { + "type": "string", + "example": "0db2dd944f9ee9a131f44b79d331d371" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -7305,46 +12133,37 @@ } ] }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", "required": [ "id", - "entity", - "view", - "url", - "action", "appId", - "label" + "name", + "aware" ], "properties": { "id": { "type": "string", "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}$" }, + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7355,17 +12174,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "app": { "$ref": "#/components/schemas/App" + }, + "flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } } }, "type": "object" }, - "AppAdministrationSnippetJsonApi": { - "description": "Added since version: 6.4.15.0", + "AppMcpPromptJsonApi": { + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -7373,25 +12195,31 @@ { "required": [ "id", - "value", + "name", + "url", "appId", - "localeId" + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { + "name": { + "type": "string" + }, + "url": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "type": "string" + }, + "description": { + "type": "string" }, "createdAt": { "type": "string", @@ -7402,35 +12230,78 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-mcp-prompt/0f7619363286401a53877794cfb6ebbb/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", + "AppMcpPrompt": { + "description": "Added since version: 6.7.11.0", "required": [ "id", - "value", + "name", + "url", "appId", - "localeId" + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { + "name": { + "type": "string" + }, + "url": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "type": "string" + }, + "description": { + "type": "string" }, "createdAt": { "type": "string", @@ -7441,12 +12312,18 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "AppCmsBlockJsonApi": { - "description": "Added since version: 6.4.2.0", + "AppMcpResourceJsonApi": { + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -7455,9 +12332,8 @@ "required": [ "id", "name", - "block", - "template", - "styles", + "uri", + "url", "appId", "label" ], @@ -7467,28 +12343,27 @@ "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.", + "uri": { "type": "string" }, - "styles": { - "description": "Parameter that relates to the styles or formatting within CMS block.", + "url": { "type": "string" }, - "label": { + "mimeType": { "type": "string" }, "appId": { - "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7512,7 +12387,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + "example": "/app-mcp-resource/30e270c9edfb6e58051d304c6e69e7bf/app" } } }, @@ -7541,14 +12416,13 @@ } ] }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", + "AppMcpResource": { + "description": "Added since version: 6.7.11.0", "required": [ "id", "name", - "block", - "template", - "styles", + "uri", + "url", "appId", "label" ], @@ -7558,28 +12432,27 @@ "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.", + "uri": { "type": "string" }, - "styles": { - "description": "Parameter that relates to the styles or formatting within CMS block.", + "url": { "type": "string" }, - "label": { + "mimeType": { "type": "string" }, "appId": { - "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7599,8 +12472,8 @@ }, "type": "object" }, - "AppFlowActionJsonApi": { - "description": "Added since version: 6.4.10.0", + "AppMcpToolJsonApi": { + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -7608,9 +12481,9 @@ { "required": [ "id", - "appId", "name", "url", + "appId", "label" ], "properties": { @@ -7618,50 +12491,21 @@ "type": "string", "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": { + "url": { "type": "string" }, - "parameters": { - "type": "object" - }, - "config": { + "inputSchema": { "type": "object" }, - "headers": { + "requiredPrivileges": { "type": "object" }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "appId": { "type": "string", - "readOnly": true - }, - "swIcon": { - "type": "string" - }, - "url": { - "description": "An URL to app flow action.", - "type": "string" - }, - "delayable": { - "type": "boolean" + "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" @@ -7669,12 +12513,6 @@ "description": { "type": "string" }, - "headline": { - "type": "string" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7698,7 +12536,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + "example": "/app-mcp-tool/0d217ec15d0377a62d13caf5899f0212/app" } } }, @@ -7718,37 +12556,6 @@ } }, "type": "object" - }, - "flowSequences": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" - } - } - } - } - }, - "type": "object" } }, "type": "object" @@ -7758,13 +12565,13 @@ } ] }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", + "AppMcpTool": { + "description": "Added since version: 6.7.11.0", "required": [ "id", - "appId", "name", "url", + "appId", "label" ], "properties": { @@ -7772,50 +12579,21 @@ "type": "string", "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": { + "url": { "type": "string" }, - "parameters": { - "type": "object" - }, - "config": { + "inputSchema": { "type": "object" }, - "headers": { + "requiredPrivileges": { "type": "object" }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "appId": { "type": "string", - "readOnly": true - }, - "swIcon": { - "type": "string" - }, - "url": { - "description": "An URL to app flow action.", - "type": "string" - }, - "delayable": { - "type": "boolean" + "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" @@ -7823,12 +12601,6 @@ "description": { "type": "string" }, - "headline": { - "type": "string" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7844,181 +12616,6 @@ }, "app": { "$ref": "#/components/schemas/App" - }, - "flowSequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - }, - "type": "object" - }, - "AppFlowEventJsonApi": { - "description": "Added since version: 6.5.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appId", - "name", - "aware" - ], - "properties": { - "id": { - "type": "string", - "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": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } - }, - "type": "object" - }, - "flows": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", - "required": [ - "id", - "appId", - "name", - "aware" - ], - "properties": { - "id": { - "type": "string", - "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": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "flows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } } }, "type": "object" @@ -13262,6 +17859,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "group": { @@ -14068,6 +18699,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "group": { "$ref": "#/components/schemas/CustomerGroup", "description": "Customer group determining pricing and permissions" @@ -15678,6 +20343,37 @@ } }, "type": "object" + }, + "documentFiles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentFiles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_file" + }, + "id": { + "type": "string", + "example": "aad3bfae9fe3322b72a0bfbdda842b11" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -15773,6 +20469,12 @@ }, "documentA11yMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentFiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentFile" + } } }, "type": "object" @@ -15824,7 +20526,44 @@ "description": "Unique number associated with every document.", "type": "string" }, - "config": { + "pageSize": { + "description": "The page size of the document.", + "type": "string" + }, + "pageOrientation": { + "description": "The page orientation of the document.", + "type": "string" + }, + "itemsPerPage": { + "description": "The number of items per page.", + "type": "integer", + "format": "int64" + }, + "displayHeader": { + "description": "Whether to display the header.", + "type": "boolean" + }, + "displayFooter": { + "description": "Whether to display the footer.", + "type": "boolean" + }, + "displayPageCount": { + "description": "Whether to display the page count.", + "type": "boolean" + }, + "displayCompanyAddress": { + "description": "Whether to display the company address.", + "type": "boolean" + }, + "displayReturnAddress": { + "description": "Whether to display the return address.", + "type": "boolean" + }, + "displayCustomerVatId": { + "description": "Whether to display the customer VAT ID.", + "type": "boolean" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -15832,8 +20571,9 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" + "config": { + "type": "object", + "deprecated": true }, "updatedAt": { "type": "string", @@ -15982,7 +20722,44 @@ "description": "Unique number associated with every document.", "type": "string" }, - "config": { + "pageSize": { + "description": "The page size of the document.", + "type": "string" + }, + "pageOrientation": { + "description": "The page orientation of the document.", + "type": "string" + }, + "itemsPerPage": { + "description": "The number of items per page.", + "type": "integer", + "format": "int64" + }, + "displayHeader": { + "description": "Whether to display the header.", + "type": "boolean" + }, + "displayFooter": { + "description": "Whether to display the footer.", + "type": "boolean" + }, + "displayPageCount": { + "description": "Whether to display the page count.", + "type": "boolean" + }, + "displayCompanyAddress": { + "description": "Whether to display the company address.", + "type": "boolean" + }, + "displayReturnAddress": { + "description": "Whether to display the return address.", + "type": "boolean" + }, + "displayCustomerVatId": { + "description": "Whether to display the customer VAT ID.", + "type": "boolean" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -15990,8 +20767,9 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" + "config": { + "type": "object", + "deprecated": true }, "updatedAt": { "type": "string", @@ -16200,6 +20978,156 @@ }, "type": "object" }, + "DocumentFileJsonApi": { + "description": "Added since version: 6.7.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentId", + "mediaId", + "documentFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentFormat": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "document": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-file/5580291c9799ddf9960e32b951f5e86b/document" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fdc3bdefb79cec8eb8211d2499e04704" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-file/5580291c9799ddf9960e32b951f5e86b/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DocumentFile": { + "description": "Added since version: 6.7.10.0", + "required": [ + "id", + "documentId", + "mediaId", + "documentFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentFormat": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, "DocumentTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -17644,7 +22572,11 @@ }, "admin": { "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", - "type": "boolean" + "type": "boolean", + "readOnly": true + }, + "mcpAllowlist": { + "type": "object" }, "customFields": { "type": "object" @@ -17833,7 +22765,11 @@ }, "admin": { "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", - "type": "boolean" + "type": "boolean", + "readOnly": true + }, + "mcpAllowlist": { + "type": "object" }, "customFields": { "type": "object" @@ -19332,6 +24268,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -19454,6 +24393,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -19566,7 +24508,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -19648,7 +24591,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -20854,6 +25798,37 @@ }, "type": "object" }, + "productOpenGraphImages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "a067685a73a5308efd6117308e659025" + } + } + } + } + }, + "type": "object" + }, "orderLineItems": { "properties": { "links": { @@ -21101,6 +26076,35 @@ } }, "type": "object" + }, + "documentFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/documentFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_file" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e6fc751fcb387f6f87970b7fed0b489f" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -21394,6 +26398,12 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, + "productOpenGraphImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, "orderLineItems": { "type": "array", "items": { @@ -21441,6 +26451,9 @@ "items": { "$ref": "#/components/schemas/AppShippingMethod" } + }, + "documentFile": { + "$ref": "#/components/schemas/DocumentFile" } }, "type": "object" @@ -24000,6 +29013,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "stateMachineState": { @@ -24811,6 +29858,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current order state (e.g., open, in_progress, completed, cancelled)" @@ -29553,6 +34634,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -29767,6 +34853,11 @@ "description": { "type": "string" }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, "metaTitle": { "type": "string" }, @@ -29789,6 +34880,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -30098,6 +35195,36 @@ }, "type": "object" }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, "featureSet": { "properties": { "links": { @@ -30879,6 +36006,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -31093,6 +36225,11 @@ "description": { "type": "string" }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, "metaTitle": { "type": "string" }, @@ -31115,6 +36252,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -31216,6 +36359,10 @@ "$ref": "#/components/schemas/ProductMedia", "description": "Main product image displayed in listings and detail pages" }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, @@ -32350,6 +37497,14 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, + "feedLabel": { + "description": "Optional feed label for grouping products within the same data source in Google Merchant Center. Uppercase letters (A-Z), numbers (0-9), hyphens (-), and underscores (_) are allowed, with a maximum length of 20 characters.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -32615,6 +37770,14 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, + "feedLabel": { + "description": "Optional feed label for grouping products within the same data source in Google Merchant Center. Uppercase letters (A-Z), numbers (0-9), hyphens (-), and underscores (_) are allowed, with a maximum length of 20 characters.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -33369,6 +38532,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -33379,9 +38545,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -33498,6 +38661,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -33508,9 +38674,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -34078,6 +39241,10 @@ "description": "To configure whether the field can be used for searching.", "type": "boolean" }, + "useExactSubfield": { + "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", + "type": "boolean" + }, "ranking": { "description": "Search ranking.", "type": "integer", @@ -34195,6 +39362,10 @@ "description": "To configure whether the field can be used for searching.", "type": "boolean" }, + "useExactSubfield": { + "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", + "type": "boolean" + }, "ranking": { "description": "Search ranking.", "type": "integer", @@ -35143,7 +40314,12 @@ "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" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -35253,7 +40429,12 @@ "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" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -38594,6 +43775,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -39566,7 +44809,38 @@ }, "id": { "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" + "example": "1fb731fc4139cbb575429e28846f0c39" + } + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" } } } @@ -39574,7 +44848,7 @@ }, "type": "object" }, - "productExports": { + "salesChannelFiles": { "properties": { "links": { "type": "object", @@ -39582,7 +44856,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelFiles" } } }, @@ -39593,11 +44867,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "sales_channel_file" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "98cb8f9be6620dcdb0ab1b3b87f2662e" } } } @@ -39962,6 +45236,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -40158,6 +45494,12 @@ "$ref": "#/components/schemas/ProductExport" } }, + "salesChannelFiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + }, "analytics": { "$ref": "#/components/schemas/SalesChannelAnalytics" }, @@ -40223,6 +45565,10 @@ "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, + "enhancedConversions": { + "description": "When boolean value is `true`, it enables Google Ads Enhanced Conversions by sending SHA256-hashed customer email with the purchase event.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -40307,6 +45653,10 @@ "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, + "enhancedConversions": { + "description": "When boolean value is `true`, it enables Google Ads Enhanced Conversions by sending SHA256-hashed customer email with the purchase event.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -40514,7 +45864,475 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "snippetSet": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "snippet_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "543af5fd1912efc00742534f621046d3" + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultHreflang": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8d7b798a77667d73c422fb222603234c" + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelDomain": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "url", + "salesChannelId", + "languageId", + "currencyId", + "snippetSetId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "url": { + "description": "URL of the sales channel domain.", + "type": "string" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language used.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "description": "Unique identity of currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "snippetSetId": { + "description": "Unique identity of snippet set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, + "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "snippetSet": { + "$ref": "#/components/schemas/SnippetSet" + }, + "salesChannelDefaultHreflang": { + "$ref": "#/components/schemas/SalesChannel" + }, + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + }, + "type": "object" + }, + "SalesChannelFileJsonApi": { + "description": "Added since version: 6.7.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salesChannelId", + "fileFamily", + "fileName", + "enabled" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the configured sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileFamily": { + "description": "File family below Resources/views/files.", + "type": "string" + }, + "fileName": { + "description": "Normalized public file path without a leading slash.", + "type": "string" + }, + "enabled": { + "description": "Controls whether the file is served for this sales channel.", + "type": "boolean" + }, + "templateOverrides": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-file/581416c2ea128b091dcb038453fdefb6/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelFile": { + "description": "Added since version: 6.7.12.0", + "required": [ + "id", + "salesChannelId", + "fileFamily", + "fileName", + "enabled" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the configured sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileFamily": { + "description": "File family below Resources/views/files.", + "type": "string" + }, + "fileName": { + "description": "Normalized public file path without a leading slash.", + "type": "string" + }, + "enabled": { + "description": "Controls whether the file is served for this sales channel.", + "type": "boolean" + }, + "templateOverrides": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelLanguage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "languageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "SalesChannelPaymentMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "type": "object" + }, + "SalesChannelShippingMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "type": "object" + }, + "SalesChannelTrackingCustomerJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" } } }, @@ -40523,19 +46341,19 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "snippetSet": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -40543,7 +46361,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" } } }, @@ -40552,19 +46370,107 @@ "properties": { "type": { "type": "string", - "example": "snippet_set" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "543af5fd1912efc00742534f621046d3" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - }, - "salesChannelDefaultHreflang": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelTrackingOrderJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { "properties": { "links": { "type": "object", @@ -40572,7 +46478,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" } } }, @@ -40581,19 +46487,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8d7b798a77667d73c422fb222603234c" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "productExports": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -40601,23 +46507,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_export" - }, - "id": { - "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -40632,55 +46536,30 @@ } ] }, - "SalesChannelDomain": { - "description": "Added since version: 6.0.0.0", + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", "required": [ "id", - "url", - "salesChannelId", - "languageId", - "currencyId", - "snippetSetId" + "orderId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { - "description": "URL of the sales channel domain.", - "type": "string" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language used.", + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "description": "Unique identity of currency.", + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "snippetSetId": { - "description": "Unique identity of snippet set.", + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "measurementUnits": { - "$ref": "#/components/schemas/MeasurementUnits" - }, - "hreflangUseOnlyLocale": { - "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", - "type": "boolean" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -40691,110 +46570,11 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "snippetSet": { - "$ref": "#/components/schemas/SnippetSet" - }, - "salesChannelDefaultHreflang": { - "$ref": "#/components/schemas/SalesChannel" - }, - "productExports": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - } - }, - "type": "object" - }, - "SalesChannelLanguage": { - "description": "Added since version: 6.0.0.0", - "required": [ - "salesChannelId", - "languageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "language": { - "$ref": "#/components/schemas/Language" - } - }, - "type": "object" - }, - "SalesChannelPaymentMethod": { - "description": "Added since version: 6.0.0.0", - "required": [ - "salesChannelId", - "paymentMethodId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - } - }, - "type": "object" - }, - "SalesChannelShippingMethod": { - "description": "Added since version: 6.0.0.0", - "required": [ - "salesChannelId", - "shippingMethodId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "order": { + "$ref": "#/components/schemas/Order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" } }, "type": "object" @@ -40991,6 +46771,11 @@ "customFields": { "type": "object" }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41195,6 +46980,11 @@ "customFields": { "type": "object" }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -48389,6 +54179,9 @@ "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, + "mcpAllowlist": { + "type": "object" + }, "lastUpdatedPasswordAt": { "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", @@ -48907,6 +54700,9 @@ "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, + "mcpAllowlist": { + "type": "object" + }, "lastUpdatedPasswordAt": { "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", @@ -49307,7 +55103,6 @@ { "required": [ "id", - "hash", "userId" ], "properties": { @@ -49315,10 +55110,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "description": "Password hash for user recovery.", - "type": "string" - }, "userId": { "description": "Unique identity of user.", "type": "string", @@ -49377,7 +55168,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "hash", "userId" ], "properties": { @@ -49385,10 +55175,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "description": "Password hash for user recovery.", - "type": "string" - }, "userId": { "description": "Unique identity of user.", "type": "string", @@ -49628,6 +55414,11 @@ "customFields": { "type": "object" }, + "sequence": { + "type": "integer", + "format": "int64", + "readOnly": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -49712,6 +55503,11 @@ "customFields": { "type": "object" }, + "sequence": { + "type": "integer", + "format": "int64", + "readOnly": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -49725,64 +55521,6 @@ }, "type": "object" }, - "ConsentState": { - "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" - }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" - }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" - } - } - }, "MediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -49816,6 +55554,112 @@ } } }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net prices are linked through the tax configuration.", + "type": "boolean" + }, + "percentage": { + "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", + "type": [ + "object", + "null" + ], + "properties": { + "gross": { + "description": "Discount percentage relative to the gross list price.", + "type": "number" + }, + "net": { + "description": "Discount percentage relative to the net list price.", + "type": "number" + } + }, + "required": [ + "gross", + "net" + ] + }, + "listPrice": { + "description": "Reference list price for displaying discounts.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross list price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net list price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net list prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] + }, + "regulationPrice": { + "description": "Reference price used for legal price disclosures.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross regulation price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net regulation price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net regulation prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] + }, "infoConfigResponse": { "type": "object", "properties": { @@ -50006,6 +55850,10 @@ "disableExtensionManagement": { "type": "boolean", "description": "True if runtime extension management is disabled." + }, + "presignedUploadSupported": { + "type": "boolean", + "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." } }, "required": [ @@ -50034,40 +55882,6 @@ ], "additionalProperties": false }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the event" - }, - "class": { - "type": "string", - "description": "Class name of the event" - }, - "data": { - "type": "object", - "description": "Available data of event" - }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } - } - } - }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -50192,7 +56006,7 @@ } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. To return a DAL extension, list the extension by its name (for example `myExtension`); the `extensions` wrapper is then kept automatically. Listing the keyword `extensions` returns all extensions.", "type": "object", "additionalProperties": { "type": "array", @@ -50202,7 +56016,7 @@ } }, "Excludes": { - "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. Use an extension name to remove a single extension, or the keyword `extensions` to remove all of them.", "type": "object", "additionalProperties": { "type": "array", @@ -50774,6 +56588,40 @@ "field" ] }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" + }, + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" + } + } + } + } + }, "flowBuilderActionsResponse": { "type": "array", "items": { @@ -50968,87 +56816,312 @@ } } }, - "Price": { + "SalesChannelFileConfiguration": { "type": "object", - "description": "Price object", + "required": [ + "id", + "enabled", + "templateOverrides" + ], "properties": { - "currencyId": { + "id": { + "description": "Identifier of the sales_channel_file row.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", + "enabled": { + "description": "Whether this file is served publicly for the sales channel.", "type": "boolean" }, - "listPrice": { - "description": "", + "templateOverrides": { + "description": "Merchant-provided Twig overrides keyed by Twig namespace. The reserved `user_provided_content` key stores plain text for the dedicated append block when supported by the template chain.", "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "additionalProperties": { + "type": "string" + } + } + } + }, + "SalesChannelFileDescriptor": { + "type": "object", + "required": [ + "fileFamily", + "fileName", + "contentType", + "configuration" + ], + "properties": { + "fileFamily": { + "description": "File family below `Resources/views/files`.", + "type": "string", + "maxLength": 64 + }, + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + }, + "contentType": { + "description": "Detected response content type for the public file.", + "type": "string", + "examples": [ + "text/plain; charset=utf-8" + ] + }, + "configuration": { + "description": "Stored sales-channel configuration for this file, or null when it has not been configured yet.", + "oneOf": [ + { + "$ref": "#/components/schemas/SalesChannelFileConfiguration" }, - "linked": { - "description": "", - "type": "boolean" + { + "type": "null" } - }, - "required": [ - "gross", - "net", - "linked" ] + } + } + }, + "SalesChannelFileDetail": { + "type": "object", + "required": [ + "fileFamily", + "fileName", + "templatePath", + "contentType", + "templates", + "supportsUserProvidedContent", + "configuration" + ], + "properties": { + "fileFamily": { + "description": "File family below `Resources/views/files`.", + "type": "string", + "maxLength": 64 }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + }, + "templatePath": { + "description": "Relative Twig template path used for rendering.", + "type": "string", + "examples": [ + "files/agentic/llms.txt.twig" + ] + }, + "contentType": { + "description": "Detected response content type for the public file.", + "type": "string", + "examples": [ + "text/plain; charset=utf-8" + ] + }, + "templates": { + "description": "Contributing Twig templates in resolved inheritance order.", + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFileTemplate" + } + }, + "supportsUserProvidedContent": { + "description": "Whether the template chain exposes the `user_provided_content` block for simple appended merchant notes.", + "type": "boolean" + }, + "configuration": { + "description": "Stored sales-channel configuration for this file, or null when it has not been configured yet.", + "oneOf": [ + { + "$ref": "#/components/schemas/SalesChannelFileConfiguration" }, - "linked": { - "description": "", - "type": "boolean" + { + "type": "null" } - }, - "required": [ - "gross", - "net", - "linked" ] } - }, + } + }, + "SalesChannelFileDetailResponse": { + "type": "object", "required": [ - "currencyId", - "gross", - "net", - "linked" - ] + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFileDetail" + } + } + }, + "SalesChannelFileListResponse": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFileDescriptor" + } + } + } + }, + "SalesChannelFilePreviewRequest": { + "type": "object", + "required": [ + "fileName" + ], + "properties": { + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] + }, + "templateOverrides": { + "description": "Unsaved Twig overrides keyed by Twig namespace. The reserved `user_provided_content` key stores plain text for the dedicated append block when supported by the template chain.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SalesChannelFilePreviewResponse": { + "type": "object", + "required": [ + "fileName", + "contentType", + "content" + ], + "properties": { + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string" + }, + "contentType": { + "description": "Detected content type of the rendered file.", + "type": "string" + }, + "content": { + "description": "Rendered file content.", + "type": "string" + } + } + }, + "SalesChannelFileTemplate": { + "type": "object", + "required": [ + "twigNamespace", + "templateName", + "templateContent", + "role" + ], + "properties": { + "twigNamespace": { + "description": "Twig namespace that contributed the template, for example `Framework` or a plugin name.", + "type": "string" + }, + "templateName": { + "description": "Resolved Twig template name.", + "type": "string", + "examples": [ + "@Framework/files/agentic/llms.txt.twig" + ] + }, + "templateContent": { + "description": "Original source template content. Administration clients can use this as the default text when editing a template override.", + "type": "string" + }, + "role": { + "description": "Whether this source provides the base template or extends another source in the resolved template chain.", + "type": "string", + "enum": [ + "base", + "extension" + ] + } + } + }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + } + } } }, "responses": { @@ -51184,6 +57257,39 @@ } } }, + "429": { + "description": "Too Many Requests", + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "429", + "title": "Too Many Requests", + "description": "Rate limit exceeded. Please wait before retrying." + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "429", + "title": "Too Many Requests", + "description": "Rate limit exceeded. Please wait before retrying." + } + ] + } + } + } + }, "204": { "description": "No Content" }, @@ -51439,6 +57545,18 @@ "name": "App Flow Event", "description": "The endpoint for operations on App Flow Event" }, + { + "name": "App Mcp Prompt", + "description": "The endpoint for operations on App Mcp Prompt" + }, + { + "name": "App Mcp Resource", + "description": "The endpoint for operations on App Mcp Resource" + }, + { + "name": "App Mcp Tool", + "description": "The endpoint for operations on App Mcp Tool" + }, { "name": "App Payment Method", "description": "The endpoint for operations on App Payment Method" @@ -51547,6 +57665,10 @@ "name": "Document Base Config Sales Channel", "description": "The endpoint for operations on Document Base Config Sales Channel" }, + { + "name": "Document File", + "description": "The endpoint for operations on Document File" + }, { "name": "Document Type", "description": "The endpoint for operations on Document Type" @@ -51847,6 +57969,18 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel File", + "description": "The endpoint for operations on Sales Channel File" + }, + { + "name": "Sales Channel Tracking Customer", + "description": "The endpoint for operations on Sales Channel Tracking Customer" + }, + { + "name": "Sales Channel Tracking Order", + "description": "The endpoint for operations on Sales Channel Tracking Order" + }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index e780cc7..960c3bd 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,12 +1,25 @@ { "paths": [ - "/_action/media/{mediaId}/external-thumbnails", - "/_action/system-config", - "/_action/system-config/batch", - "/_action/system-config/check", - "/_action/system-config/schema", - "/_action/user/logout", - "/_action/validation/email", + "/_action/integration/{integrationId}/mcp-allowlist", + "/_action/mail-template/available-variables", + "/_action/mail-template/get-data-and-send", + "/_action/mail-template/preview", + "/_action/mail-template/simulate", + "/_action/mcp/capabilities", + "/_action/mcp/tools", + "/_action/media/presign-upload", + "/_action/media/{mediaId}/finalize-upload", + "/_action/number-range/{numberRangeId}/preview-pattern", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/detail", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/preview", + "/_action/user/{userId}/mcp-allowlist", + "/_mcp", + "/aggregate/app-mcp-prompt", + "/aggregate/app-mcp-resource", + "/aggregate/app-mcp-tool", + "/aggregate/document-file", + "/aggregate/sales-channel-file", "/aggregate/swag-customized-products-template", "/aggregate/swag-customized-products-template-configuration", "/aggregate/swag-customized-products-template-configuration-share", @@ -17,7 +30,21 @@ "/aggregate/swag-customized-products-template-option-price", "/aggregate/swag-customized-products-template-option-value", "/aggregate/swag-customized-products-template-option-value-price", - "/app-system/shop/verify", + "/app-mcp-prompt", + "/app-mcp-prompt/{id}", + "/app-mcp-resource", + "/app-mcp-resource/{id}", + "/app-mcp-tool", + "/app-mcp-tool/{id}", + "/document-file", + "/document-file/{id}", + "/sales-channel-file", + "/sales-channel-file/{id}", + "/search/app-mcp-prompt", + "/search/app-mcp-resource", + "/search/app-mcp-tool", + "/search/document-file", + "/search/sales-channel-file", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", @@ -72,6 +99,12 @@ "AppFlowEvent", "AppFlowEventJsonApi", "AppJsonApi", + "AppMcpPrompt", + "AppMcpPromptJsonApi", + "AppMcpResource", + "AppMcpResourceJsonApi", + "AppMcpTool", + "AppMcpToolJsonApi", "AppPaymentMethod", "AppPaymentMethodJsonApi", "AppScriptCondition", @@ -131,6 +164,8 @@ "DocumentBaseConfigJsonApi", "DocumentBaseConfigSalesChannel", "DocumentBaseConfigSalesChannelJsonApi", + "DocumentFile", + "DocumentFileJsonApi", "DocumentJsonApi", "DocumentType", "DocumentTypeJsonApi", @@ -320,10 +355,24 @@ "SalesChannelCurrency", "SalesChannelDomain", "SalesChannelDomainJsonApi", + "SalesChannelFile", + "SalesChannelFileConfiguration", + "SalesChannelFileDescriptor", + "SalesChannelFileDetail", + "SalesChannelFileDetailResponse", + "SalesChannelFileJsonApi", + "SalesChannelFileListResponse", + "SalesChannelFilePreviewRequest", + "SalesChannelFilePreviewResponse", + "SalesChannelFileTemplate", "SalesChannelJsonApi", "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", + "SalesChannelTrackingCustomer", + "SalesChannelTrackingCustomerJsonApi", + "SalesChannelTrackingOrder", + "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation",