diff --git a/adminapi.json b/adminapi.json index f964ae4..524d2ad 100644 --- a/adminapi.json +++ b/adminapi.json @@ -61148,15 +61148,14 @@ } } }, - "/sales-channel-tracking-customer": { + "/sales-channel-file": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomerList", + "summary": "List with basic information of Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "getSalesChannelFileList", "parameters": [ { "name": "limit", @@ -61185,7 +61184,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Customer resources.", + "description": "List of Sales Channel File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61204,7 +61203,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } ] @@ -61218,16 +61217,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-customer?limit=25" + "example": "/sales-channel-file?limit=25" }, "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" + "example": "/sales-channel-file?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" + "example": "/sales-channel-file?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" + "example": "/sales-channel-file?limit=25&page=2" } } } @@ -61248,7 +61247,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61263,12 +61262,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingCustomer", + "summary": "Create a new Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "createSalesChannelFile", "parameters": [ { "name": "_response", @@ -61287,14 +61285,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -61306,7 +61304,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61321,7 +61319,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61337,15 +61335,14 @@ } } }, - "/search/sales-channel-tracking-customer": { + "/search/sales-channel-file": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "Search for the Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "searchSalesChannelFile", "parameters": [ { "name": "sw-include-search-info", @@ -61373,7 +61370,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -61387,7 +61384,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61405,7 +61402,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61422,20 +61419,19 @@ } } }, - "/sales-channel-tracking-customer/{id}": { + "/sales-channel-file/{id}": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "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 sales_channel_tracking_customer", + "description": "Identifier for the sales_channel_file", "required": true, "schema": { "type": "string", @@ -61445,7 +61441,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -61457,7 +61453,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61472,7 +61468,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61489,17 +61485,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingCustomer", + "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 sales_channel_tracking_customer", + "description": "Identifier for the sales_channel_file", "required": true, "schema": { "type": "string", @@ -61530,17 +61525,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "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 sales_channel_tracking_customer", + "description": "Identifier for the sales_channel_file", "required": true, "schema": { "type": "string", @@ -61558,18 +61552,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Partially update information about a Sales Channel File resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -61581,7 +61575,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61596,7 +61590,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61615,15 +61609,14 @@ } } }, - "/aggregate/sales-channel-tracking-customer": { + "/aggregate/sales-channel-file": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel File" ], - "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingCustomer", + "summary": "Aggregate for the Sales Channel File resources.", + "description": "Available since: 6.7.12.0", + "operationId": "aggregateSalesChannelFile", "requestBody": { "required": true, "content": { @@ -61647,7 +61640,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SalesChannelFile", "content": { "application/vnd.api+json": { "schema": { @@ -61661,7 +61654,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61679,7 +61672,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelFile" } } } @@ -61696,15 +61689,15 @@ } } }, - "/sales-channel-tracking-order": { + "/sales-channel-tracking-customer": { "get": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "operationId": "getSalesChannelTrackingCustomerList", "parameters": [ { "name": "limit", @@ -61733,7 +61726,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order resources.", + "description": "List of Sales Channel Tracking Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61752,7 +61745,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } ] @@ -61766,16 +61759,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-order?limit=25" + "example": "/sales-channel-tracking-customer?limit=25" }, "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" + "example": "/sales-channel-tracking-customer?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" + "example": "/sales-channel-tracking-customer?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" + "example": "/sales-channel-tracking-customer?limit=25&page=2" } } } @@ -61796,7 +61789,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -61811,12 +61804,12 @@ }, "post": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "operationId": "createSalesChannelTrackingCustomer", "parameters": [ { "name": "_response", @@ -61835,14 +61828,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -61854,7 +61847,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -61869,7 +61862,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -61885,15 +61878,15 @@ } } }, - "/search/sales-channel-tracking-order": { + "/search/sales-channel-tracking-customer": { "post": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "operationId": "searchSalesChannelTrackingCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -61921,7 +61914,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -61935,7 +61928,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -61953,7 +61946,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -61970,20 +61963,20 @@ } } }, - "/sales-channel-tracking-order/{id}": { + "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrder", + "operationId": "getSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -61993,7 +61986,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -62005,7 +61998,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -62020,7 +62013,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -62037,17 +62030,17 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "operationId": "deleteSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -62078,17 +62071,17 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingOrder", + "operationId": "updateSalesChannelTrackingCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -62106,18 +62099,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", + "description": "Partially update information about a Sales Channel Tracking Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -62129,7 +62122,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -62144,7 +62137,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -62163,15 +62156,15 @@ } } }, - "/aggregate/sales-channel-tracking-order": { + "/aggregate/sales-channel-tracking-customer": { "post": { "tags": [ - "Sales Channel Tracking Order", + "Sales Channel Tracking Customer", "Experimental" ], - "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingOrder", + "operationId": "aggregateSalesChannelTrackingCustomer", "requestBody": { "required": true, "content": { @@ -62195,7 +62188,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SalesChannelTrackingCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -62209,7 +62202,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -62227,7 +62220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } @@ -62244,14 +62237,15 @@ } } }, - "/sales-channel-type": { + "/sales-channel-tracking-order": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "List with basic information of Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelTypeList", + "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrderList", "parameters": [ { "name": "limit", @@ -62280,7 +62274,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Type resources.", + "description": "List of Sales Channel Tracking Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62299,7 +62293,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } ] @@ -62313,16 +62307,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-type?limit=25" + "example": "/sales-channel-tracking-order?limit=25" }, "last": { - "example": "/sales-channel-type?limit=25&page=11" + "example": "/sales-channel-tracking-order?limit=25&page=11" }, "next": { - "example": "/sales-channel-type?limit=25&page=4" + "example": "/sales-channel-tracking-order?limit=25&page=4" }, "prev": { - "example": "/sales-channel-type?limit=25&page=2" + "example": "/sales-channel-tracking-order?limit=25&page=2" } } } @@ -62343,7 +62337,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62358,11 +62352,12 @@ }, "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Create a new Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", + "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingOrder", "parameters": [ { "name": "_response", @@ -62381,14 +62376,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -62400,7 +62395,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62415,7 +62410,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62431,14 +62426,15 @@ } } }, - "/search/sales-channel-type": { + "/search/sales-channel-tracking-order": { "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Search for the Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelType", + "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { "name": "sw-include-search-info", @@ -62466,7 +62462,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -62480,7 +62476,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62498,7 +62494,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62515,19 +62511,20 @@ } } }, - "/sales-channel-type/{id}": { + "/sales-channel-tracking-order/{id}": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Detailed information about a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelType", + "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -62537,7 +62534,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -62549,7 +62546,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62564,7 +62561,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62581,16 +62578,17 @@ }, "delete": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Delete a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelType", + "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -62621,16 +62619,17 @@ }, "patch": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Partially update information about a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelType", + "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -62648,18 +62647,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Type resource.", + "description": "Partially update information about a Sales Channel Tracking Order resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -62671,7 +62670,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62686,7 +62685,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62705,14 +62704,15 @@ } } }, - "/aggregate/sales-channel-type": { + "/aggregate/sales-channel-tracking-order": { "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Aggregate for the Sales Channel Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelType", + "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "aggregateSalesChannelTrackingOrder", "requestBody": { "required": true, "content": { @@ -62736,7 +62736,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of SalesChannelTrackingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -62750,7 +62750,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62768,7 +62768,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } @@ -62785,14 +62785,14 @@ } } }, - "/salutation": { + "/sales-channel-type": { "get": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "List with basic information of Salutation resources.", + "summary": "List with basic information of Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", + "operationId": "getSalesChannelTypeList", "parameters": [ { "name": "limit", @@ -62821,7 +62821,7 @@ ], "responses": { "200": { - "description": "List of Salutation resources.", + "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62840,7 +62840,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } ] @@ -62854,16 +62854,16 @@ "type": "object", "properties": { "first": { - "example": "/salutation?limit=25" + "example": "/sales-channel-type?limit=25" }, "last": { - "example": "/salutation?limit=25&page=11" + "example": "/sales-channel-type?limit=25&page=11" }, "next": { - "example": "/salutation?limit=25&page=4" + "example": "/sales-channel-type?limit=25&page=4" }, "prev": { - "example": "/salutation?limit=25&page=2" + "example": "/sales-channel-type?limit=25&page=2" } } } @@ -62884,7 +62884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -62899,11 +62899,11 @@ }, "post": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Fetches salutations with a criteria obj.", - "description": "Fetches salutations with a criteria obj.", - "operationId": "createSalutation", + "summary": "Create a new Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelType", "parameters": [ { "name": "_response", @@ -62922,14 +62922,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -62941,7 +62941,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -62956,7 +62956,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -62972,14 +62972,14 @@ } } }, - "/search/salutation": { + "/search/sales-channel-type": { "post": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Search for the Salutation resources.", + "summary": "Search for the Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSalutation", + "operationId": "searchSalesChannelType", "parameters": [ { "name": "sw-include-search-info", @@ -63007,7 +63007,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -63021,7 +63021,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63039,7 +63039,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63056,19 +63056,19 @@ } } }, - "/salutation/{id}": { + "/sales-channel-type/{id}": { "get": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Detailed information about a Salutation resource.", + "summary": "Detailed information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutation", + "operationId": "getSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -63078,7 +63078,7 @@ ], "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -63090,7 +63090,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63105,7 +63105,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63122,16 +63122,16 @@ }, "delete": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Delete a Salutation resource.", + "summary": "Delete a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", + "operationId": "deleteSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -63162,16 +63162,16 @@ }, "patch": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Partially update information about a Salutation resource.", + "summary": "Partially update information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalutation", + "operationId": "updateSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -63189,18 +63189,18 @@ } ], "requestBody": { - "description": "Partially update information about a Salutation resource.", + "description": "Partially update information about a Sales Channel Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -63212,7 +63212,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63227,7 +63227,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63246,14 +63246,14 @@ } } }, - "/aggregate/salutation": { + "/aggregate/sales-channel-type": { "post": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Aggregate for the Salutation resources.", + "summary": "Aggregate for the Sales Channel Type resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalutation", + "operationId": "aggregateSalesChannelType", "requestBody": { "required": true, "content": { @@ -63277,7 +63277,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -63291,7 +63291,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63309,7 +63309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -63326,14 +63326,14 @@ } } }, - "/scheduled-task": { + "/salutation": { "get": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "List with basic information of Scheduled Task resources.", + "summary": "List with basic information of Salutation resources.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTaskList", + "operationId": "getSalutationList", "parameters": [ { "name": "limit", @@ -63362,7 +63362,7 @@ ], "responses": { "200": { - "description": "List of Scheduled Task resources.", + "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63381,7 +63381,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } ] @@ -63395,16 +63395,16 @@ "type": "object", "properties": { "first": { - "example": "/scheduled-task?limit=25" + "example": "/salutation?limit=25" }, "last": { - "example": "/scheduled-task?limit=25&page=11" + "example": "/salutation?limit=25&page=11" }, "next": { - "example": "/scheduled-task?limit=25&page=4" + "example": "/salutation?limit=25&page=4" }, "prev": { - "example": "/scheduled-task?limit=25&page=2" + "example": "/salutation?limit=25&page=2" } } } @@ -63425,7 +63425,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63440,11 +63440,11 @@ }, "post": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Create a new Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createScheduledTask", + "summary": "Fetches salutations with a criteria obj.", + "description": "Fetches salutations with a criteria obj.", + "operationId": "createSalutation", "parameters": [ { "name": "_response", @@ -63463,14 +63463,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -63482,7 +63482,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63497,7 +63497,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63513,14 +63513,14 @@ } } }, - "/search/scheduled-task": { + "/search/salutation": { "post": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Search for the Scheduled Task resources.", + "summary": "Search for the Salutation resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchScheduledTask", + "operationId": "searchSalutation", "parameters": [ { "name": "sw-include-search-info", @@ -63548,7 +63548,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -63562,7 +63562,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63580,7 +63580,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63597,19 +63597,19 @@ } } }, - "/scheduled-task/{id}": { + "/salutation/{id}": { "get": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Detailed information about a Scheduled Task resource.", + "summary": "Detailed information about a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", + "operationId": "getSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -63619,7 +63619,7 @@ ], "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -63631,7 +63631,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63646,7 +63646,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63663,16 +63663,16 @@ }, "delete": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Delete a Scheduled Task resource.", + "summary": "Delete a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteScheduledTask", + "operationId": "deleteSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -63703,16 +63703,16 @@ }, "patch": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Partially update information about a Scheduled Task resource.", + "summary": "Partially update information about a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateScheduledTask", + "operationId": "updateSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -63730,18 +63730,18 @@ } ], "requestBody": { - "description": "Partially update information about a Scheduled Task resource.", + "description": "Partially update information about a Salutation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -63753,7 +63753,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63768,7 +63768,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63787,14 +63787,14 @@ } } }, - "/aggregate/scheduled-task": { + "/aggregate/salutation": { "post": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Aggregate for the Scheduled Task resources.", + "summary": "Aggregate for the Salutation resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateScheduledTask", + "operationId": "aggregateSalutation", "requestBody": { "required": true, "content": { @@ -63818,7 +63818,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -63832,7 +63832,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63850,7 +63850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -63867,14 +63867,14 @@ } } }, - "/script": { + "/scheduled-task": { "get": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "List with basic information of Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getScriptList", + "summary": "List with basic information of Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTaskList", "parameters": [ { "name": "limit", @@ -63903,7 +63903,7 @@ ], "responses": { "200": { - "description": "List of Script resources.", + "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63922,7 +63922,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } ] @@ -63936,16 +63936,16 @@ "type": "object", "properties": { "first": { - "example": "/script?limit=25" + "example": "/scheduled-task?limit=25" }, "last": { - "example": "/script?limit=25&page=11" + "example": "/scheduled-task?limit=25&page=11" }, "next": { - "example": "/script?limit=25&page=4" + "example": "/scheduled-task?limit=25&page=4" }, "prev": { - "example": "/script?limit=25&page=2" + "example": "/scheduled-task?limit=25&page=2" } } } @@ -63966,7 +63966,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -63981,11 +63981,11 @@ }, "post": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Create a new Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createScript", + "summary": "Create a new Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createScheduledTask", "parameters": [ { "name": "_response", @@ -64004,14 +64004,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -64023,7 +64023,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64038,7 +64038,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64054,14 +64054,14 @@ } } }, - "/search/script": { + "/search/scheduled-task": { "post": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Search for the Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "searchScript", + "summary": "Search for the Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchScheduledTask", "parameters": [ { "name": "sw-include-search-info", @@ -64089,7 +64089,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -64103,7 +64103,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64121,7 +64121,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64138,19 +64138,19 @@ } } }, - "/script/{id}": { + "/scheduled-task/{id}": { "get": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Detailed information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getScript", + "summary": "Detailed information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -64160,7 +64160,7 @@ ], "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -64172,7 +64172,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64187,7 +64187,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64204,16 +64204,16 @@ }, "delete": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Delete a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteScript", + "summary": "Delete a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -64244,16 +64244,16 @@ }, "patch": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Partially update information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateScript", + "summary": "Partially update information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -64271,18 +64271,18 @@ } ], "requestBody": { - "description": "Partially update information about a Script resource.", + "description": "Partially update information about a Scheduled Task resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -64294,7 +64294,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64309,7 +64309,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64328,14 +64328,14 @@ } } }, - "/aggregate/script": { + "/aggregate/scheduled-task": { "post": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Aggregate for the Script resources.", + "summary": "Aggregate for the Scheduled Task resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateScript", + "operationId": "aggregateScheduledTask", "requestBody": { "required": true, "content": { @@ -64359,7 +64359,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -64373,7 +64373,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64391,7 +64391,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -64408,14 +64408,14 @@ } } }, - "/seo-url": { + "/script": { "get": { "tags": [ - "Seo Url" + "Script" ], - "summary": "List with basic information of Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlList", + "summary": "List with basic information of Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getScriptList", "parameters": [ { "name": "limit", @@ -64444,7 +64444,7 @@ ], "responses": { "200": { - "description": "List of Seo Url resources.", + "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { @@ -64463,7 +64463,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } ] @@ -64477,16 +64477,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url?limit=25" + "example": "/script?limit=25" }, "last": { - "example": "/seo-url?limit=25&page=11" + "example": "/script?limit=25&page=11" }, "next": { - "example": "/seo-url?limit=25&page=4" + "example": "/script?limit=25&page=4" }, "prev": { - "example": "/seo-url?limit=25&page=2" + "example": "/script?limit=25&page=2" } } } @@ -64507,7 +64507,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64522,11 +64522,11 @@ }, "post": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Create a new Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrl", + "summary": "Create a new Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createScript", "parameters": [ { "name": "_response", @@ -64545,14 +64545,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -64564,7 +64564,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64579,7 +64579,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64595,14 +64595,14 @@ } } }, - "/search/seo-url": { + "/search/script": { "post": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Search for the Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrl", + "summary": "Search for the Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchScript", "parameters": [ { "name": "sw-include-search-info", @@ -64630,7 +64630,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -64644,7 +64644,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64662,7 +64662,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64679,19 +64679,19 @@ } } }, - "/seo-url/{id}": { + "/script/{id}": { "get": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Detailed information about a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrl", + "summary": "Detailed information about a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "getScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -64701,7 +64701,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -64713,7 +64713,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64728,7 +64728,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64745,16 +64745,16 @@ }, "delete": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Delete a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrl", + "summary": "Delete a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -64785,16 +64785,16 @@ }, "patch": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Partially update information about a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrl", + "summary": "Partially update information about a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "updateScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -64812,18 +64812,18 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url resource.", + "description": "Partially update information about a Script resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -64835,7 +64835,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64850,7 +64850,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64869,14 +64869,14 @@ } } }, - "/aggregate/seo-url": { + "/aggregate/script": { "post": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Aggregate for the Seo Url resources.", + "summary": "Aggregate for the Script resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrl", + "operationId": "aggregateScript", "requestBody": { "required": true, "content": { @@ -64900,7 +64900,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -64914,7 +64914,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64932,7 +64932,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -64949,14 +64949,14 @@ } } }, - "/seo-url-template": { + "/seo-url": { "get": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "List with basic information of Seo Url Template resources.", + "summary": "List with basic information of Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplateList", + "operationId": "getSeoUrlList", "parameters": [ { "name": "limit", @@ -64985,7 +64985,7 @@ ], "responses": { "200": { - "description": "List of Seo Url Template resources.", + "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65004,7 +65004,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } ] @@ -65018,16 +65018,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url-template?limit=25" + "example": "/seo-url?limit=25" }, "last": { - "example": "/seo-url-template?limit=25&page=11" + "example": "/seo-url?limit=25&page=11" }, "next": { - "example": "/seo-url-template?limit=25&page=4" + "example": "/seo-url?limit=25&page=4" }, "prev": { - "example": "/seo-url-template?limit=25&page=2" + "example": "/seo-url?limit=25&page=2" } } } @@ -65048,7 +65048,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65063,11 +65063,11 @@ }, "post": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Create a new Seo Url Template resources.", + "summary": "Create a new Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrlTemplate", + "operationId": "createSeoUrl", "parameters": [ { "name": "_response", @@ -65086,14 +65086,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -65105,7 +65105,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65120,7 +65120,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65136,14 +65136,14 @@ } } }, - "/search/seo-url-template": { + "/search/seo-url": { "post": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Search for the Seo Url Template resources.", + "summary": "Search for the Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrlTemplate", + "operationId": "searchSeoUrl", "parameters": [ { "name": "sw-include-search-info", @@ -65171,7 +65171,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -65185,7 +65185,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65203,7 +65203,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65220,19 +65220,19 @@ } } }, - "/seo-url-template/{id}": { + "/seo-url/{id}": { "get": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Detailed information about a Seo Url Template resource.", + "summary": "Detailed information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplate", + "operationId": "getSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -65242,7 +65242,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -65254,7 +65254,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65269,7 +65269,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65286,16 +65286,16 @@ }, "delete": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Delete a Seo Url Template resource.", + "summary": "Delete a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrlTemplate", + "operationId": "deleteSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -65326,16 +65326,16 @@ }, "patch": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Partially update information about a Seo Url Template resource.", + "summary": "Partially update information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrlTemplate", + "operationId": "updateSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -65353,18 +65353,18 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url Template resource.", + "description": "Partially update information about a Seo Url resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -65376,7 +65376,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65391,7 +65391,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65410,14 +65410,14 @@ } } }, - "/aggregate/seo-url-template": { + "/aggregate/seo-url": { "post": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Aggregate for the Seo Url Template resources.", + "summary": "Aggregate for the Seo Url resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrlTemplate", + "operationId": "aggregateSeoUrl", "requestBody": { "required": true, "content": { @@ -65441,7 +65441,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -65455,7 +65455,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65473,7 +65473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -65490,14 +65490,14 @@ } } }, - "/shipping-method": { + "/seo-url-template": { "get": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "List with basic information of Shipping Method resources.", + "summary": "List with basic information of Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodList", + "operationId": "getSeoUrlTemplateList", "parameters": [ { "name": "limit", @@ -65526,7 +65526,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method resources.", + "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65545,7 +65545,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } ] @@ -65559,16 +65559,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method?limit=25" + "example": "/seo-url-template?limit=25" }, "last": { - "example": "/shipping-method?limit=25&page=11" + "example": "/seo-url-template?limit=25&page=11" }, "next": { - "example": "/shipping-method?limit=25&page=4" + "example": "/seo-url-template?limit=25&page=4" }, "prev": { - "example": "/shipping-method?limit=25&page=2" + "example": "/seo-url-template?limit=25&page=2" } } } @@ -65589,7 +65589,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65604,11 +65604,11 @@ }, "post": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Create a new Shipping Method resources.", + "summary": "Create a new Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethod", + "operationId": "createSeoUrlTemplate", "parameters": [ { "name": "_response", @@ -65627,14 +65627,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -65646,7 +65646,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65661,7 +65661,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65677,14 +65677,14 @@ } } }, - "/search/shipping-method": { + "/search/seo-url-template": { "post": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Search for the Shipping Method resources.", + "summary": "Search for the Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethod", + "operationId": "searchSeoUrlTemplate", "parameters": [ { "name": "sw-include-search-info", @@ -65712,7 +65712,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -65726,7 +65726,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65744,7 +65744,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65761,19 +65761,19 @@ } } }, - "/shipping-method/{id}": { + "/seo-url-template/{id}": { "get": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Detailed information about a Shipping Method resource.", + "summary": "Detailed information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethod", + "operationId": "getSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -65783,7 +65783,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -65795,7 +65795,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65810,7 +65810,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65827,16 +65827,16 @@ }, "delete": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Delete a Shipping Method resource.", + "summary": "Delete a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethod", + "operationId": "deleteSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -65867,16 +65867,16 @@ }, "patch": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Partially update information about a Shipping Method resource.", + "summary": "Partially update information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethod", + "operationId": "updateSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -65894,18 +65894,18 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method resource.", + "description": "Partially update information about a Seo Url Template resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -65917,7 +65917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65932,7 +65932,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -65951,14 +65951,14 @@ } } }, - "/aggregate/shipping-method": { + "/aggregate/seo-url-template": { "post": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Aggregate for the Shipping Method resources.", + "summary": "Aggregate for the Seo Url Template resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethod", + "operationId": "aggregateSeoUrlTemplate", "requestBody": { "required": true, "content": { @@ -65982,7 +65982,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -65996,7 +65996,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -66014,7 +66014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -66031,14 +66031,14 @@ } } }, - "/shipping-method-price": { + "/shipping-method": { "get": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "List with basic information of Shipping Method Price resources.", + "summary": "List with basic information of Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPriceList", + "operationId": "getShippingMethodList", "parameters": [ { "name": "limit", @@ -66067,7 +66067,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method Price resources.", + "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66086,7 +66086,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } ] @@ -66100,16 +66100,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method-price?limit=25" + "example": "/shipping-method?limit=25" }, "last": { - "example": "/shipping-method-price?limit=25&page=11" + "example": "/shipping-method?limit=25&page=11" }, "next": { - "example": "/shipping-method-price?limit=25&page=4" + "example": "/shipping-method?limit=25&page=4" }, "prev": { - "example": "/shipping-method-price?limit=25&page=2" + "example": "/shipping-method?limit=25&page=2" } } } @@ -66130,7 +66130,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66145,11 +66145,11 @@ }, "post": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Create a new Shipping Method Price resources.", + "summary": "Create a new Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethodPrice", + "operationId": "createShippingMethod", "parameters": [ { "name": "_response", @@ -66168,14 +66168,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -66187,7 +66187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66202,7 +66202,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66218,14 +66218,14 @@ } } }, - "/search/shipping-method-price": { + "/search/shipping-method": { "post": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Search for the Shipping Method Price resources.", + "summary": "Search for the Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethodPrice", + "operationId": "searchShippingMethod", "parameters": [ { "name": "sw-include-search-info", @@ -66253,7 +66253,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -66267,7 +66267,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66285,7 +66285,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66302,19 +66302,19 @@ } } }, - "/shipping-method-price/{id}": { + "/shipping-method/{id}": { "get": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Detailed information about a Shipping Method Price resource.", + "summary": "Detailed information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPrice", + "operationId": "getShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -66324,7 +66324,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -66336,7 +66336,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66351,7 +66351,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66368,16 +66368,16 @@ }, "delete": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Delete a Shipping Method Price resource.", + "summary": "Delete a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethodPrice", + "operationId": "deleteShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -66408,16 +66408,16 @@ }, "patch": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Partially update information about a Shipping Method Price resource.", + "summary": "Partially update information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethodPrice", + "operationId": "updateShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -66435,18 +66435,18 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method Price resource.", + "description": "Partially update information about a Shipping Method resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -66458,7 +66458,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66473,7 +66473,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66492,14 +66492,14 @@ } } }, - "/aggregate/shipping-method-price": { + "/aggregate/shipping-method": { "post": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Aggregate for the Shipping Method Price resources.", + "summary": "Aggregate for the Shipping Method resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethodPrice", + "operationId": "aggregateShippingMethod", "requestBody": { "required": true, "content": { @@ -66523,7 +66523,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -66537,7 +66537,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66555,7 +66555,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -66572,14 +66572,14 @@ } } }, - "/snippet": { + "/shipping-method-price": { "get": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "List with basic information of Snippet resources.", + "summary": "List with basic information of Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetList", + "operationId": "getShippingMethodPriceList", "parameters": [ { "name": "limit", @@ -66608,7 +66608,7 @@ ], "responses": { "200": { - "description": "List of Snippet resources.", + "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66627,7 +66627,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } ] @@ -66641,16 +66641,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet?limit=25" + "example": "/shipping-method-price?limit=25" }, "last": { - "example": "/snippet?limit=25&page=11" + "example": "/shipping-method-price?limit=25&page=11" }, "next": { - "example": "/snippet?limit=25&page=4" + "example": "/shipping-method-price?limit=25&page=4" }, "prev": { - "example": "/snippet?limit=25&page=2" + "example": "/shipping-method-price?limit=25&page=2" } } } @@ -66671,7 +66671,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66686,11 +66686,11 @@ }, "post": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Create a new Snippet resources.", + "summary": "Create a new Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippet", + "operationId": "createShippingMethodPrice", "parameters": [ { "name": "_response", @@ -66709,14 +66709,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -66728,7 +66728,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66743,7 +66743,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66759,14 +66759,14 @@ } } }, - "/search/snippet": { + "/search/shipping-method-price": { "post": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Search for the Snippet resources.", + "summary": "Search for the Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSnippet", + "operationId": "searchShippingMethodPrice", "parameters": [ { "name": "sw-include-search-info", @@ -66794,7 +66794,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -66808,7 +66808,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66826,7 +66826,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66843,19 +66843,19 @@ } } }, - "/snippet/{id}": { + "/shipping-method-price/{id}": { "get": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Detailed information about a Snippet resource.", + "summary": "Detailed information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", + "operationId": "getShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -66865,7 +66865,7 @@ ], "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -66877,7 +66877,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66892,7 +66892,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -66909,16 +66909,16 @@ }, "delete": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Delete a Snippet resource.", + "summary": "Delete a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", + "operationId": "deleteShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -66949,16 +66949,16 @@ }, "patch": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Partially update information about a Snippet resource.", + "summary": "Partially update information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", + "operationId": "updateShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -66976,18 +66976,18 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet resource.", + "description": "Partially update information about a Shipping Method Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -66999,7 +66999,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -67014,7 +67014,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -67033,14 +67033,14 @@ } } }, - "/aggregate/snippet": { + "/aggregate/shipping-method-price": { "post": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Aggregate for the Snippet resources.", + "summary": "Aggregate for the Shipping Method Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippet", + "operationId": "aggregateShippingMethodPrice", "requestBody": { "required": true, "content": { @@ -67064,7 +67064,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -67078,7 +67078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -67096,7 +67096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -67113,14 +67113,14 @@ } } }, - "/snippet-set": { + "/snippet": { "get": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "List with basic information of Snippet Set resources.", + "summary": "List with basic information of Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSetList", + "operationId": "getSnippetList", "parameters": [ { "name": "limit", @@ -67149,7 +67149,7 @@ ], "responses": { "200": { - "description": "List of Snippet Set resources.", + "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67168,7 +67168,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } ] @@ -67182,16 +67182,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet-set?limit=25" + "example": "/snippet?limit=25" }, "last": { - "example": "/snippet-set?limit=25&page=11" + "example": "/snippet?limit=25&page=11" }, "next": { - "example": "/snippet-set?limit=25&page=4" + "example": "/snippet?limit=25&page=4" }, "prev": { - "example": "/snippet-set?limit=25&page=2" + "example": "/snippet?limit=25&page=2" } } } @@ -67212,7 +67212,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67227,11 +67227,11 @@ }, "post": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Create a new Snippet Set resources.", + "summary": "Create a new Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippetSet", + "operationId": "createSnippet", "parameters": [ { "name": "_response", @@ -67250,14 +67250,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -67269,7 +67269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67284,7 +67284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67300,14 +67300,14 @@ } } }, - "/search/snippet-set": { + "/search/snippet": { "post": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Search for the Snippet Set resources.", + "summary": "Search for the Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSnippetSet", + "operationId": "searchSnippet", "parameters": [ { "name": "sw-include-search-info", @@ -67335,7 +67335,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -67349,7 +67349,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67367,7 +67367,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67384,19 +67384,19 @@ } } }, - "/snippet-set/{id}": { + "/snippet/{id}": { "get": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Detailed information about a Snippet Set resource.", + "summary": "Detailed information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSet", + "operationId": "getSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -67406,7 +67406,7 @@ ], "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -67418,7 +67418,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67433,7 +67433,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67450,16 +67450,16 @@ }, "delete": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Delete a Snippet Set resource.", + "summary": "Delete a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippetSet", + "operationId": "deleteSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -67490,16 +67490,16 @@ }, "patch": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Partially update information about a Snippet Set resource.", + "summary": "Partially update information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippetSet", + "operationId": "updateSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -67517,18 +67517,18 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet Set resource.", + "description": "Partially update information about a Snippet resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -67540,7 +67540,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67555,7 +67555,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67574,14 +67574,14 @@ } } }, - "/aggregate/snippet-set": { + "/aggregate/snippet": { "post": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Aggregate for the Snippet Set resources.", + "summary": "Aggregate for the Snippet resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippetSet", + "operationId": "aggregateSnippet", "requestBody": { "required": true, "content": { @@ -67605,7 +67605,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -67619,7 +67619,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67637,7 +67637,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -67654,14 +67654,14 @@ } } }, - "/state-machine": { + "/snippet-set": { "get": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "List with basic information of State Machine resources.", + "summary": "List with basic information of Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineList", + "operationId": "getSnippetSetList", "parameters": [ { "name": "limit", @@ -67690,7 +67690,7 @@ ], "responses": { "200": { - "description": "List of State Machine resources.", + "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67709,7 +67709,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } ] @@ -67723,16 +67723,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine?limit=25" + "example": "/snippet-set?limit=25" }, "last": { - "example": "/state-machine?limit=25&page=11" + "example": "/snippet-set?limit=25&page=11" }, "next": { - "example": "/state-machine?limit=25&page=4" + "example": "/snippet-set?limit=25&page=4" }, "prev": { - "example": "/state-machine?limit=25&page=2" + "example": "/snippet-set?limit=25&page=2" } } } @@ -67753,7 +67753,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67768,11 +67768,11 @@ }, "post": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Create a new State Machine resources.", + "summary": "Create a new Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachine", + "operationId": "createSnippetSet", "parameters": [ { "name": "_response", @@ -67791,14 +67791,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -67810,7 +67810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67825,7 +67825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67841,14 +67841,14 @@ } } }, - "/search/state-machine": { + "/search/snippet-set": { "post": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Search for the State Machine resources.", + "summary": "Search for the Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachine", + "operationId": "searchSnippetSet", "parameters": [ { "name": "sw-include-search-info", @@ -67876,7 +67876,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -67890,7 +67890,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67908,7 +67908,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67925,19 +67925,19 @@ } } }, - "/state-machine/{id}": { + "/snippet-set/{id}": { "get": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Detailed information about a State Machine resource.", + "summary": "Detailed information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachine", + "operationId": "getSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -67947,7 +67947,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -67959,7 +67959,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67974,7 +67974,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -67991,16 +67991,16 @@ }, "delete": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Delete a State Machine resource.", + "summary": "Delete a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachine", + "operationId": "deleteSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -68031,16 +68031,16 @@ }, "patch": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Partially update information about a State Machine resource.", + "summary": "Partially update information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachine", + "operationId": "updateSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -68058,18 +68058,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine resource.", + "description": "Partially update information about a Snippet Set resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -68081,7 +68081,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -68096,7 +68096,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -68115,14 +68115,14 @@ } } }, - "/aggregate/state-machine": { + "/aggregate/snippet-set": { "post": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Aggregate for the State Machine resources.", + "summary": "Aggregate for the Snippet Set resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachine", + "operationId": "aggregateSnippetSet", "requestBody": { "required": true, "content": { @@ -68146,7 +68146,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -68160,7 +68160,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -68178,7 +68178,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -68195,14 +68195,14 @@ } } }, - "/state-machine-history": { + "/state-machine": { "get": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "List with basic information of State Machine History resources.", + "summary": "List with basic information of State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistoryList", + "operationId": "getStateMachineList", "parameters": [ { "name": "limit", @@ -68231,7 +68231,7 @@ ], "responses": { "200": { - "description": "List of State Machine History resources.", + "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68250,7 +68250,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } ] @@ -68264,16 +68264,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-history?limit=25" + "example": "/state-machine?limit=25" }, "last": { - "example": "/state-machine-history?limit=25&page=11" + "example": "/state-machine?limit=25&page=11" }, "next": { - "example": "/state-machine-history?limit=25&page=4" + "example": "/state-machine?limit=25&page=4" }, "prev": { - "example": "/state-machine-history?limit=25&page=2" + "example": "/state-machine?limit=25&page=2" } } } @@ -68294,7 +68294,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68309,11 +68309,11 @@ }, "post": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Create a new State Machine History resources.", + "summary": "Create a new State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineHistory", + "operationId": "createStateMachine", "parameters": [ { "name": "_response", @@ -68332,14 +68332,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -68351,7 +68351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68366,7 +68366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68382,14 +68382,14 @@ } } }, - "/search/state-machine-history": { + "/search/state-machine": { "post": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Search for the State Machine History resources.", + "summary": "Search for the State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineHistory", + "operationId": "searchStateMachine", "parameters": [ { "name": "sw-include-search-info", @@ -68417,7 +68417,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -68431,7 +68431,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68449,7 +68449,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68466,19 +68466,19 @@ } } }, - "/state-machine-history/{id}": { + "/state-machine/{id}": { "get": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Detailed information about a State Machine History resource.", + "summary": "Detailed information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", + "operationId": "getStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -68488,7 +68488,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -68500,7 +68500,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68515,7 +68515,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68532,16 +68532,16 @@ }, "delete": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Delete a State Machine History resource.", + "summary": "Delete a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", + "operationId": "deleteStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -68572,16 +68572,16 @@ }, "patch": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Partially update information about a State Machine History resource.", + "summary": "Partially update information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", + "operationId": "updateStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -68599,18 +68599,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine History resource.", + "description": "Partially update information about a State Machine resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -68622,7 +68622,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68637,7 +68637,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68656,14 +68656,14 @@ } } }, - "/aggregate/state-machine-history": { + "/aggregate/state-machine": { "post": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Aggregate for the State Machine History resources.", + "summary": "Aggregate for the State Machine resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineHistory", + "operationId": "aggregateStateMachine", "requestBody": { "required": true, "content": { @@ -68687,7 +68687,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -68701,7 +68701,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68719,7 +68719,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -68736,14 +68736,14 @@ } } }, - "/state-machine-state": { + "/state-machine-history": { "get": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "List with basic information of State Machine State resources.", + "summary": "List with basic information of State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineStateList", + "operationId": "getStateMachineHistoryList", "parameters": [ { "name": "limit", @@ -68772,7 +68772,7 @@ ], "responses": { "200": { - "description": "List of State Machine State resources.", + "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68791,7 +68791,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } ] @@ -68805,16 +68805,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-state?limit=25" + "example": "/state-machine-history?limit=25" }, "last": { - "example": "/state-machine-state?limit=25&page=11" + "example": "/state-machine-history?limit=25&page=11" }, "next": { - "example": "/state-machine-state?limit=25&page=4" + "example": "/state-machine-history?limit=25&page=4" }, "prev": { - "example": "/state-machine-state?limit=25&page=2" + "example": "/state-machine-history?limit=25&page=2" } } } @@ -68835,7 +68835,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -68850,11 +68850,11 @@ }, "post": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Create a new State Machine State resources.", + "summary": "Create a new State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineState", + "operationId": "createStateMachineHistory", "parameters": [ { "name": "_response", @@ -68873,14 +68873,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -68892,7 +68892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -68907,7 +68907,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -68923,14 +68923,14 @@ } } }, - "/search/state-machine-state": { + "/search/state-machine-history": { "post": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Search for the State Machine State resources.", + "summary": "Search for the State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineState", + "operationId": "searchStateMachineHistory", "parameters": [ { "name": "sw-include-search-info", @@ -68958,7 +68958,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -68972,7 +68972,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -68990,7 +68990,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69007,19 +69007,19 @@ } } }, - "/state-machine-state/{id}": { + "/state-machine-history/{id}": { "get": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Detailed information about a State Machine State resource.", + "summary": "Detailed information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineState", + "operationId": "getStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -69029,7 +69029,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -69041,7 +69041,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69056,7 +69056,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69073,16 +69073,16 @@ }, "delete": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Delete a State Machine State resource.", + "summary": "Delete a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineState", + "operationId": "deleteStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -69113,16 +69113,16 @@ }, "patch": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Partially update information about a State Machine State resource.", + "summary": "Partially update information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineState", + "operationId": "updateStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -69140,18 +69140,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine State resource.", + "description": "Partially update information about a State Machine History resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -69163,7 +69163,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69178,7 +69178,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69197,14 +69197,14 @@ } } }, - "/aggregate/state-machine-state": { + "/aggregate/state-machine-history": { "post": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Aggregate for the State Machine State resources.", + "summary": "Aggregate for the State Machine History resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineState", + "operationId": "aggregateStateMachineHistory", "requestBody": { "required": true, "content": { @@ -69228,7 +69228,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -69242,7 +69242,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69260,7 +69260,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -69277,14 +69277,14 @@ } } }, - "/state-machine-transition": { + "/state-machine-state": { "get": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "List with basic information of State Machine Transition resources.", + "summary": "List with basic information of State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransitionList", + "operationId": "getStateMachineStateList", "parameters": [ { "name": "limit", @@ -69313,7 +69313,7 @@ ], "responses": { "200": { - "description": "List of State Machine Transition resources.", + "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69332,7 +69332,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } ] @@ -69346,16 +69346,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-transition?limit=25" + "example": "/state-machine-state?limit=25" }, "last": { - "example": "/state-machine-transition?limit=25&page=11" + "example": "/state-machine-state?limit=25&page=11" }, "next": { - "example": "/state-machine-transition?limit=25&page=4" + "example": "/state-machine-state?limit=25&page=4" }, "prev": { - "example": "/state-machine-transition?limit=25&page=2" + "example": "/state-machine-state?limit=25&page=2" } } } @@ -69376,7 +69376,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69391,11 +69391,11 @@ }, "post": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Create a new State Machine Transition resources.", + "summary": "Create a new State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineTransition", + "operationId": "createStateMachineState", "parameters": [ { "name": "_response", @@ -69414,14 +69414,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -69433,7 +69433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69448,7 +69448,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69464,14 +69464,14 @@ } } }, - "/search/state-machine-transition": { + "/search/state-machine-state": { "post": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Search for the State Machine Transition resources.", + "summary": "Search for the State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineTransition", + "operationId": "searchStateMachineState", "parameters": [ { "name": "sw-include-search-info", @@ -69499,7 +69499,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -69513,7 +69513,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69531,7 +69531,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69548,19 +69548,19 @@ } } }, - "/state-machine-transition/{id}": { + "/state-machine-state/{id}": { "get": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Detailed information about a State Machine Transition resource.", + "summary": "Detailed information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransition", + "operationId": "getStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -69570,7 +69570,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -69582,7 +69582,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69597,7 +69597,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69614,16 +69614,16 @@ }, "delete": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Delete a State Machine Transition resource.", + "summary": "Delete a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineTransition", + "operationId": "deleteStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -69654,16 +69654,16 @@ }, "patch": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Partially update information about a State Machine Transition resource.", + "summary": "Partially update information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineTransition", + "operationId": "updateStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -69681,18 +69681,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine Transition resource.", + "description": "Partially update information about a State Machine State resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -69704,7 +69704,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69719,7 +69719,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69738,14 +69738,14 @@ } } }, - "/aggregate/state-machine-transition": { + "/aggregate/state-machine-state": { "post": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Aggregate for the State Machine Transition resources.", + "summary": "Aggregate for the State Machine State resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineTransition", + "operationId": "aggregateStateMachineState", "requestBody": { "required": true, "content": { @@ -69769,7 +69769,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -69783,7 +69783,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69801,7 +69801,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -69818,14 +69818,14 @@ } } }, - "/system-config": { + "/state-machine-transition": { "get": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "List with basic information of System Config resources.", + "summary": "List with basic information of State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfigList", + "operationId": "getStateMachineTransitionList", "parameters": [ { "name": "limit", @@ -69854,7 +69854,7 @@ ], "responses": { "200": { - "description": "List of System Config resources.", + "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69873,7 +69873,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } ] @@ -69887,16 +69887,16 @@ "type": "object", "properties": { "first": { - "example": "/system-config?limit=25" + "example": "/state-machine-transition?limit=25" }, "last": { - "example": "/system-config?limit=25&page=11" + "example": "/state-machine-transition?limit=25&page=11" }, "next": { - "example": "/system-config?limit=25&page=4" + "example": "/state-machine-transition?limit=25&page=4" }, "prev": { - "example": "/system-config?limit=25&page=2" + "example": "/state-machine-transition?limit=25&page=2" } } } @@ -69917,7 +69917,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -69932,11 +69932,11 @@ }, "post": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Create a new System Config resources.", + "summary": "Create a new State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSystemConfig", + "operationId": "createStateMachineTransition", "parameters": [ { "name": "_response", @@ -69955,14 +69955,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -69974,7 +69974,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -69989,7 +69989,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70005,14 +70005,14 @@ } } }, - "/search/system-config": { + "/search/state-machine-transition": { "post": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Search for the System Config resources.", + "summary": "Search for the State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSystemConfig", + "operationId": "searchStateMachineTransition", "parameters": [ { "name": "sw-include-search-info", @@ -70040,7 +70040,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -70054,7 +70054,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70072,7 +70072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70089,19 +70089,19 @@ } } }, - "/system-config/{id}": { + "/state-machine-transition/{id}": { "get": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Detailed information about a System Config resource.", + "summary": "Detailed information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", + "operationId": "getStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -70111,7 +70111,7 @@ ], "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -70123,7 +70123,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70138,7 +70138,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70155,16 +70155,16 @@ }, "delete": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Delete a System Config resource.", + "summary": "Delete a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", + "operationId": "deleteStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -70195,16 +70195,16 @@ }, "patch": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Partially update information about a System Config resource.", + "summary": "Partially update information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", + "operationId": "updateStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -70222,18 +70222,18 @@ } ], "requestBody": { - "description": "Partially update information about a System Config resource.", + "description": "Partially update information about a State Machine Transition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -70245,7 +70245,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70260,7 +70260,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70279,14 +70279,14 @@ } } }, - "/aggregate/system-config": { + "/aggregate/state-machine-transition": { "post": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Aggregate for the System Config resources.", + "summary": "Aggregate for the State Machine Transition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSystemConfig", + "operationId": "aggregateStateMachineTransition", "requestBody": { "required": true, "content": { @@ -70310,7 +70310,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -70324,7 +70324,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70342,7 +70342,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -70359,14 +70359,14 @@ } } }, - "/tag": { + "/system-config": { "get": { "tags": [ - "Tag" + "System Config" ], - "summary": "List with basic information of Tag resources.", + "summary": "List with basic information of System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTagList", + "operationId": "getSystemConfigList", "parameters": [ { "name": "limit", @@ -70395,7 +70395,7 @@ ], "responses": { "200": { - "description": "List of Tag resources.", + "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70414,7 +70414,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } ] @@ -70428,16 +70428,16 @@ "type": "object", "properties": { "first": { - "example": "/tag?limit=25" + "example": "/system-config?limit=25" }, "last": { - "example": "/tag?limit=25&page=11" + "example": "/system-config?limit=25&page=11" }, "next": { - "example": "/tag?limit=25&page=4" + "example": "/system-config?limit=25&page=4" }, "prev": { - "example": "/tag?limit=25&page=2" + "example": "/system-config?limit=25&page=2" } } } @@ -70458,7 +70458,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70473,11 +70473,11 @@ }, "post": { "tags": [ - "Tag" + "System Config" ], - "summary": "Create a new Tag resources.", + "summary": "Create a new System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTag", + "operationId": "createSystemConfig", "parameters": [ { "name": "_response", @@ -70496,14 +70496,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70515,7 +70515,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70530,7 +70530,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70546,14 +70546,14 @@ } } }, - "/search/tag": { + "/search/system-config": { "post": { "tags": [ - "Tag" + "System Config" ], - "summary": "Search for the Tag resources.", + "summary": "Search for the System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchTag", + "operationId": "searchSystemConfig", "parameters": [ { "name": "sw-include-search-info", @@ -70581,7 +70581,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70595,7 +70595,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70613,7 +70613,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70630,19 +70630,19 @@ } } }, - "/tag/{id}": { + "/system-config/{id}": { "get": { "tags": [ - "Tag" + "System Config" ], - "summary": "Detailed information about a Tag resource.", + "summary": "Detailed information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTag", + "operationId": "getSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -70652,7 +70652,7 @@ ], "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70664,7 +70664,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70679,7 +70679,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70696,16 +70696,16 @@ }, "delete": { "tags": [ - "Tag" + "System Config" ], - "summary": "Delete a Tag resource.", + "summary": "Delete a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTag", + "operationId": "deleteSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -70736,16 +70736,16 @@ }, "patch": { "tags": [ - "Tag" + "System Config" ], - "summary": "Partially update information about a Tag resource.", + "summary": "Partially update information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTag", + "operationId": "updateSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -70763,18 +70763,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tag resource.", + "description": "Partially update information about a System Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70786,7 +70786,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70801,7 +70801,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70820,14 +70820,14 @@ } } }, - "/aggregate/tag": { + "/aggregate/system-config": { "post": { "tags": [ - "Tag" + "System Config" ], - "summary": "Aggregate for the Tag resources.", + "summary": "Aggregate for the System Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTag", + "operationId": "aggregateSystemConfig", "requestBody": { "required": true, "content": { @@ -70851,7 +70851,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70865,7 +70865,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70883,7 +70883,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -70900,14 +70900,14 @@ } } }, - "/tax": { + "/tag": { "get": { "tags": [ - "Tax" + "Tag" ], - "summary": "List with basic information of Tax resources.", + "summary": "List with basic information of Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTaxList", + "operationId": "getTagList", "parameters": [ { "name": "limit", @@ -70936,7 +70936,7 @@ ], "responses": { "200": { - "description": "List of Tax resources.", + "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70955,7 +70955,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } ] @@ -70969,16 +70969,16 @@ "type": "object", "properties": { "first": { - "example": "/tax?limit=25" + "example": "/tag?limit=25" }, "last": { - "example": "/tax?limit=25&page=11" + "example": "/tag?limit=25&page=11" }, "next": { - "example": "/tax?limit=25&page=4" + "example": "/tag?limit=25&page=4" }, "prev": { - "example": "/tax?limit=25&page=2" + "example": "/tag?limit=25&page=2" } } } @@ -70999,7 +70999,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71014,11 +71014,11 @@ }, "post": { "tags": [ - "Tax" + "Tag" ], - "summary": "Create a new Tax resources.", + "summary": "Create a new Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTax", + "operationId": "createTag", "parameters": [ { "name": "_response", @@ -71037,14 +71037,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -71056,7 +71056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71071,7 +71071,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71087,14 +71087,14 @@ } } }, - "/search/tax": { + "/search/tag": { "post": { "tags": [ - "Tax" + "Tag" ], - "summary": "Search for the Tax resources.", + "summary": "Search for the Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchTax", + "operationId": "searchTag", "parameters": [ { "name": "sw-include-search-info", @@ -71122,7 +71122,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -71136,7 +71136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71154,7 +71154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71171,19 +71171,19 @@ } } }, - "/tax/{id}": { + "/tag/{id}": { "get": { "tags": [ - "Tax" + "Tag" ], - "summary": "Detailed information about a Tax resource.", + "summary": "Detailed information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTax", + "operationId": "getTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -71193,7 +71193,7 @@ ], "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -71205,7 +71205,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71220,7 +71220,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71237,16 +71237,16 @@ }, "delete": { "tags": [ - "Tax" + "Tag" ], - "summary": "Delete a Tax resource.", + "summary": "Delete a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTax", + "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -71277,16 +71277,16 @@ }, "patch": { "tags": [ - "Tax" + "Tag" ], - "summary": "Partially update information about a Tax resource.", + "summary": "Partially update information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTax", + "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -71304,18 +71304,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax resource.", + "description": "Partially update information about a Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -71327,7 +71327,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71342,7 +71342,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71361,14 +71361,14 @@ } } }, - "/aggregate/tax": { + "/aggregate/tag": { "post": { "tags": [ - "Tax" + "Tag" ], - "summary": "Aggregate for the Tax resources.", + "summary": "Aggregate for the Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTax", + "operationId": "aggregateTag", "requestBody": { "required": true, "content": { @@ -71392,7 +71392,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -71406,7 +71406,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71424,7 +71424,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -71441,14 +71441,14 @@ } } }, - "/tax-provider": { + "/tax": { "get": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "List with basic information of Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProviderList", + "summary": "List with basic information of Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getTaxList", "parameters": [ { "name": "limit", @@ -71477,7 +71477,7 @@ ], "responses": { "200": { - "description": "List of Tax Provider resources.", + "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { @@ -71496,7 +71496,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } ] @@ -71510,16 +71510,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-provider?limit=25" + "example": "/tax?limit=25" }, "last": { - "example": "/tax-provider?limit=25&page=11" + "example": "/tax?limit=25&page=11" }, "next": { - "example": "/tax-provider?limit=25&page=4" + "example": "/tax?limit=25&page=4" }, "prev": { - "example": "/tax-provider?limit=25&page=2" + "example": "/tax?limit=25&page=2" } } } @@ -71540,7 +71540,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71555,11 +71555,11 @@ }, "post": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Create a new Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "createTaxProvider", + "summary": "Create a new Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTax", "parameters": [ { "name": "_response", @@ -71578,14 +71578,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -71597,7 +71597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71612,7 +71612,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71628,14 +71628,14 @@ } } }, - "/search/tax-provider": { + "/search/tax": { "post": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Search for the Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "searchTaxProvider", + "summary": "Search for the Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTax", "parameters": [ { "name": "sw-include-search-info", @@ -71663,7 +71663,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -71677,7 +71677,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71695,7 +71695,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71712,19 +71712,19 @@ } } }, - "/tax-provider/{id}": { + "/tax/{id}": { "get": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Detailed information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProvider", + "summary": "Detailed information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -71734,7 +71734,7 @@ ], "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -71746,7 +71746,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71761,7 +71761,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71778,16 +71778,16 @@ }, "delete": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", + "summary": "Delete a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -71818,16 +71818,16 @@ }, "patch": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Partially update information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "updateTaxProvider", + "summary": "Partially update information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -71845,18 +71845,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Provider resource.", + "description": "Partially update information about a Tax resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -71868,7 +71868,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71883,7 +71883,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71902,14 +71902,14 @@ } } }, - "/aggregate/tax-provider": { + "/aggregate/tax": { "post": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Aggregate for the Tax Provider resources.", + "summary": "Aggregate for the Tax resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxProvider", + "operationId": "aggregateTax", "requestBody": { "required": true, "content": { @@ -71933,7 +71933,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -71947,7 +71947,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71965,7 +71965,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -71982,14 +71982,14 @@ } } }, - "/tax-rule": { + "/tax-provider": { "get": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "List with basic information of Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleList", + "summary": "List with basic information of Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProviderList", "parameters": [ { "name": "limit", @@ -72018,7 +72018,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule resources.", + "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -72037,7 +72037,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } ] @@ -72051,16 +72051,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule?limit=25" + "example": "/tax-provider?limit=25" }, "last": { - "example": "/tax-rule?limit=25&page=11" + "example": "/tax-provider?limit=25&page=11" }, "next": { - "example": "/tax-rule?limit=25&page=4" + "example": "/tax-provider?limit=25&page=4" }, "prev": { - "example": "/tax-rule?limit=25&page=2" + "example": "/tax-provider?limit=25&page=2" } } } @@ -72081,7 +72081,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72096,11 +72096,11 @@ }, "post": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Create a new Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRule", + "summary": "Create a new Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "createTaxProvider", "parameters": [ { "name": "_response", @@ -72119,14 +72119,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -72138,7 +72138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72153,7 +72153,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72169,14 +72169,14 @@ } } }, - "/search/tax-rule": { + "/search/tax-provider": { "post": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Search for the Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRule", + "summary": "Search for the Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "searchTaxProvider", "parameters": [ { "name": "sw-include-search-info", @@ -72204,7 +72204,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -72218,7 +72218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72236,7 +72236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72253,19 +72253,19 @@ } } }, - "/tax-rule/{id}": { + "/tax-provider/{id}": { "get": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Detailed information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRule", + "summary": "Detailed information about a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -72275,7 +72275,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -72287,7 +72287,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72302,7 +72302,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72319,16 +72319,16 @@ }, "delete": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Delete a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRule", + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -72359,16 +72359,16 @@ }, "patch": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Partially update information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRule", + "summary": "Partially update information about a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "updateTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -72386,18 +72386,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule resource.", + "description": "Partially update information about a Tax Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -72409,7 +72409,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72424,7 +72424,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72443,14 +72443,14 @@ } } }, - "/aggregate/tax-rule": { + "/aggregate/tax-provider": { "post": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Aggregate for the Tax Rule resources.", + "summary": "Aggregate for the Tax Provider resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRule", + "operationId": "aggregateTaxProvider", "requestBody": { "required": true, "content": { @@ -72474,7 +72474,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -72488,7 +72488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72506,7 +72506,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -72523,14 +72523,14 @@ } } }, - "/tax-rule-type": { + "/tax-rule": { "get": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "List with basic information of Tax Rule Type resources.", + "summary": "List with basic information of Tax Rule resources.", "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleTypeList", + "operationId": "getTaxRuleList", "parameters": [ { "name": "limit", @@ -72559,7 +72559,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule Type resources.", + "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -72578,7 +72578,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } ] @@ -72592,16 +72592,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule-type?limit=25" + "example": "/tax-rule?limit=25" }, "last": { - "example": "/tax-rule-type?limit=25&page=11" + "example": "/tax-rule?limit=25&page=11" }, "next": { - "example": "/tax-rule-type?limit=25&page=4" + "example": "/tax-rule?limit=25&page=4" }, "prev": { - "example": "/tax-rule-type?limit=25&page=2" + "example": "/tax-rule?limit=25&page=2" } } } @@ -72622,7 +72622,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72637,11 +72637,11 @@ }, "post": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Create a new Tax Rule Type resources.", + "summary": "Create a new Tax Rule resources.", "description": "Available since: 6.1.0.0", - "operationId": "createTaxRuleType", + "operationId": "createTaxRule", "parameters": [ { "name": "_response", @@ -72660,14 +72660,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -72679,7 +72679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72694,7 +72694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72710,14 +72710,14 @@ } } }, - "/search/tax-rule-type": { + "/search/tax-rule": { "post": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Search for the Tax Rule Type resources.", + "summary": "Search for the Tax Rule resources.", "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRuleType", + "operationId": "searchTaxRule", "parameters": [ { "name": "sw-include-search-info", @@ -72745,7 +72745,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -72759,7 +72759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72777,7 +72777,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72794,19 +72794,19 @@ } } }, - "/tax-rule-type/{id}": { + "/tax-rule/{id}": { "get": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Detailed information about a Tax Rule Type resource.", + "summary": "Detailed information about a Tax Rule resource.", "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleType", + "operationId": "getTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -72816,7 +72816,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -72828,7 +72828,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72843,7 +72843,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72860,16 +72860,16 @@ }, "delete": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Delete a Tax Rule Type resource.", + "summary": "Delete a Tax Rule resource.", "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRuleType", + "operationId": "deleteTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -72900,16 +72900,16 @@ }, "patch": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Partially update information about a Tax Rule Type resource.", + "summary": "Partially update information about a Tax Rule resource.", "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRuleType", + "operationId": "updateTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -72927,18 +72927,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule Type resource.", + "description": "Partially update information about a Tax Rule resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -72950,7 +72950,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72965,7 +72965,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -72984,14 +72984,14 @@ } } }, - "/aggregate/tax-rule-type": { + "/aggregate/tax-rule": { "post": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Aggregate for the Tax Rule Type resources.", + "summary": "Aggregate for the Tax Rule resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRuleType", + "operationId": "aggregateTaxRule", "requestBody": { "required": true, "content": { @@ -73015,7 +73015,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -73029,7 +73029,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -73047,7 +73047,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -73064,14 +73064,14 @@ } } }, - "/theme": { + "/tax-rule-type": { "get": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "List with basic information of Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getThemeList", + "summary": "List with basic information of Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleTypeList", "parameters": [ { "name": "limit", @@ -73100,7 +73100,7 @@ ], "responses": { "200": { - "description": "List of Theme resources.", + "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -73119,7 +73119,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } ] @@ -73133,16 +73133,16 @@ "type": "object", "properties": { "first": { - "example": "/theme?limit=25" + "example": "/tax-rule-type?limit=25" }, "last": { - "example": "/theme?limit=25&page=11" + "example": "/tax-rule-type?limit=25&page=11" }, "next": { - "example": "/theme?limit=25&page=4" + "example": "/tax-rule-type?limit=25&page=4" }, "prev": { - "example": "/theme?limit=25&page=2" + "example": "/tax-rule-type?limit=25&page=2" } } } @@ -73163,7 +73163,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73178,11 +73178,11 @@ }, "post": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Create a new Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTheme", + "summary": "Create a new Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRuleType", "parameters": [ { "name": "_response", @@ -73201,14 +73201,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -73220,7 +73220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73235,7 +73235,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73251,14 +73251,14 @@ } } }, - "/search/theme": { + "/search/tax-rule-type": { "post": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Search for the Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTheme", + "summary": "Search for the Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRuleType", "parameters": [ { "name": "sw-include-search-info", @@ -73286,7 +73286,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -73300,7 +73300,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73318,7 +73318,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73335,19 +73335,19 @@ } } }, - "/theme/{id}": { + "/tax-rule-type/{id}": { "get": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Detailed information about a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTheme", + "summary": "Detailed information about a Tax Rule Type resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -73357,7 +73357,7 @@ ], "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -73369,7 +73369,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73384,7 +73384,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73401,16 +73401,16 @@ }, "delete": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Delete a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", + "summary": "Delete a Tax Rule Type resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -73441,16 +73441,16 @@ }, "patch": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Partially update information about a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTheme", + "summary": "Partially update information about a Tax Rule Type resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -73468,18 +73468,18 @@ } ], "requestBody": { - "description": "Partially update information about a Theme resource.", + "description": "Partially update information about a Tax Rule Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -73491,7 +73491,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73506,7 +73506,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73525,14 +73525,14 @@ } } }, - "/aggregate/theme": { + "/aggregate/tax-rule-type": { "post": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Aggregate for the Theme resources.", + "summary": "Aggregate for the Tax Rule Type resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTheme", + "operationId": "aggregateTaxRuleType", "requestBody": { "required": true, "content": { @@ -73556,7 +73556,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -73570,7 +73570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73588,7 +73588,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -73605,14 +73605,14 @@ } } }, - "/unit": { + "/theme": { "get": { "tags": [ - "Unit" + "Theme" ], - "summary": "List with basic information of Unit resources.", + "summary": "List with basic information of Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUnitList", + "operationId": "getThemeList", "parameters": [ { "name": "limit", @@ -73641,7 +73641,7 @@ ], "responses": { "200": { - "description": "List of Unit resources.", + "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { @@ -73660,7 +73660,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } ] @@ -73674,16 +73674,16 @@ "type": "object", "properties": { "first": { - "example": "/unit?limit=25" + "example": "/theme?limit=25" }, "last": { - "example": "/unit?limit=25&page=11" + "example": "/theme?limit=25&page=11" }, "next": { - "example": "/unit?limit=25&page=4" + "example": "/theme?limit=25&page=4" }, "prev": { - "example": "/unit?limit=25&page=2" + "example": "/theme?limit=25&page=2" } } } @@ -73704,7 +73704,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73719,11 +73719,11 @@ }, "post": { "tags": [ - "Unit" + "Theme" ], - "summary": "Create a new Unit resources.", + "summary": "Create a new Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUnit", + "operationId": "createTheme", "parameters": [ { "name": "_response", @@ -73742,14 +73742,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -73761,7 +73761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73776,7 +73776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73792,14 +73792,14 @@ } } }, - "/search/unit": { + "/search/theme": { "post": { "tags": [ - "Unit" + "Theme" ], - "summary": "Search for the Unit resources.", + "summary": "Search for the Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUnit", + "operationId": "searchTheme", "parameters": [ { "name": "sw-include-search-info", @@ -73827,7 +73827,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -73841,7 +73841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73859,7 +73859,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73876,19 +73876,19 @@ } } }, - "/unit/{id}": { + "/theme/{id}": { "get": { "tags": [ - "Unit" + "Theme" ], - "summary": "Detailed information about a Unit resource.", + "summary": "Detailed information about a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUnit", + "operationId": "getTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -73898,7 +73898,7 @@ ], "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -73910,7 +73910,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73925,7 +73925,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -73942,16 +73942,16 @@ }, "delete": { "tags": [ - "Unit" + "Theme" ], - "summary": "Delete a Unit resource.", + "summary": "Delete a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUnit", + "operationId": "deleteTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -73982,16 +73982,16 @@ }, "patch": { "tags": [ - "Unit" + "Theme" ], - "summary": "Partially update information about a Unit resource.", + "summary": "Partially update information about a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUnit", + "operationId": "updateTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -74009,18 +74009,18 @@ } ], "requestBody": { - "description": "Partially update information about a Unit resource.", + "description": "Partially update information about a Theme resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -74032,7 +74032,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -74047,7 +74047,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -74066,14 +74066,14 @@ } } }, - "/aggregate/unit": { + "/aggregate/theme": { "post": { "tags": [ - "Unit" + "Theme" ], - "summary": "Aggregate for the Unit resources.", + "summary": "Aggregate for the Theme resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUnit", + "operationId": "aggregateTheme", "requestBody": { "required": true, "content": { @@ -74097,7 +74097,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -74111,7 +74111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -74129,7 +74129,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -74146,14 +74146,14 @@ } } }, - "/user": { + "/unit": { "get": { "tags": [ - "User" + "Unit" ], - "summary": "List with basic information of User resources.", + "summary": "List with basic information of Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserList", + "operationId": "getUnitList", "parameters": [ { "name": "limit", @@ -74182,7 +74182,7 @@ ], "responses": { "200": { - "description": "List of User resources.", + "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -74201,7 +74201,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } ] @@ -74215,16 +74215,16 @@ "type": "object", "properties": { "first": { - "example": "/user?limit=25" + "example": "/unit?limit=25" }, "last": { - "example": "/user?limit=25&page=11" + "example": "/unit?limit=25&page=11" }, "next": { - "example": "/user?limit=25&page=4" + "example": "/unit?limit=25&page=4" }, "prev": { - "example": "/user?limit=25&page=2" + "example": "/unit?limit=25&page=2" } } } @@ -74245,7 +74245,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74260,11 +74260,11 @@ }, "post": { "tags": [ - "User" + "Unit" ], - "summary": "Create a new User resources.", + "summary": "Create a new Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUser", + "operationId": "createUnit", "parameters": [ { "name": "_response", @@ -74283,14 +74283,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -74302,7 +74302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74317,7 +74317,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74333,14 +74333,14 @@ } } }, - "/search/user": { + "/search/unit": { "post": { "tags": [ - "User" + "Unit" ], - "summary": "Search for the User resources.", + "summary": "Search for the Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUser", + "operationId": "searchUnit", "parameters": [ { "name": "sw-include-search-info", @@ -74368,7 +74368,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -74382,7 +74382,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74400,7 +74400,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74417,19 +74417,19 @@ } } }, - "/user/{id}": { + "/unit/{id}": { "get": { "tags": [ - "User" + "Unit" ], - "summary": "Detailed information about a User resource.", + "summary": "Detailed information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUser", + "operationId": "getUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -74439,7 +74439,7 @@ ], "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -74451,7 +74451,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74466,7 +74466,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74483,16 +74483,16 @@ }, "delete": { "tags": [ - "User" + "Unit" ], - "summary": "Delete a User resource.", + "summary": "Delete a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUser", + "operationId": "deleteUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -74523,16 +74523,16 @@ }, "patch": { "tags": [ - "User" + "Unit" ], - "summary": "Partially update information about a User resource.", + "summary": "Partially update information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUser", + "operationId": "updateUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -74550,18 +74550,18 @@ } ], "requestBody": { - "description": "Partially update information about a User resource.", + "description": "Partially update information about a Unit resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -74573,7 +74573,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74588,7 +74588,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74607,14 +74607,14 @@ } } }, - "/aggregate/user": { + "/aggregate/unit": { "post": { "tags": [ - "User" + "Unit" ], - "summary": "Aggregate for the User resources.", + "summary": "Aggregate for the Unit resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUser", + "operationId": "aggregateUnit", "requestBody": { "required": true, "content": { @@ -74638,7 +74638,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -74652,7 +74652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74670,7 +74670,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -74687,14 +74687,14 @@ } } }, - "/user-access-key": { + "/user": { "get": { "tags": [ - "User Access Key" + "User" ], - "summary": "List with basic information of User Access Key resources.", + "summary": "List with basic information of User resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKeyList", + "operationId": "getUserList", "parameters": [ { "name": "limit", @@ -74723,7 +74723,7 @@ ], "responses": { "200": { - "description": "List of User Access Key resources.", + "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { @@ -74742,7 +74742,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } ] @@ -74756,16 +74756,16 @@ "type": "object", "properties": { "first": { - "example": "/user-access-key?limit=25" + "example": "/user?limit=25" }, "last": { - "example": "/user-access-key?limit=25&page=11" + "example": "/user?limit=25&page=11" }, "next": { - "example": "/user-access-key?limit=25&page=4" + "example": "/user?limit=25&page=4" }, "prev": { - "example": "/user-access-key?limit=25&page=2" + "example": "/user?limit=25&page=2" } } } @@ -74786,7 +74786,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -74801,11 +74801,11 @@ }, "post": { "tags": [ - "User Access Key" + "User" ], - "summary": "Create a new User Access Key resources.", + "summary": "Create a new User resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUserAccessKey", + "operationId": "createUser", "parameters": [ { "name": "_response", @@ -74824,14 +74824,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -74843,7 +74843,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -74858,7 +74858,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -74874,14 +74874,14 @@ } } }, - "/search/user-access-key": { + "/search/user": { "post": { "tags": [ - "User Access Key" + "User" ], - "summary": "Search for the User Access Key resources.", + "summary": "Search for the User resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUserAccessKey", + "operationId": "searchUser", "parameters": [ { "name": "sw-include-search-info", @@ -74909,7 +74909,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -74923,7 +74923,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -74941,7 +74941,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -74958,19 +74958,19 @@ } } }, - "/user-access-key/{id}": { + "/user/{id}": { "get": { "tags": [ - "User Access Key" + "User" ], - "summary": "Detailed information about a User Access Key resource.", + "summary": "Detailed information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", + "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -74980,7 +74980,7 @@ ], "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -74992,7 +74992,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -75007,7 +75007,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -75024,16 +75024,16 @@ }, "delete": { "tags": [ - "User Access Key" + "User" ], - "summary": "Delete a User Access Key resource.", + "summary": "Delete a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", + "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -75064,16 +75064,16 @@ }, "patch": { "tags": [ - "User Access Key" + "User" ], - "summary": "Partially update information about a User Access Key resource.", + "summary": "Partially update information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", + "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -75091,18 +75091,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Access Key resource.", + "description": "Partially update information about a User resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -75114,7 +75114,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -75129,7 +75129,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -75148,14 +75148,14 @@ } } }, - "/aggregate/user-access-key": { + "/aggregate/user": { "post": { "tags": [ - "User Access Key" + "User" ], - "summary": "Aggregate for the User Access Key resources.", + "summary": "Aggregate for the User resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserAccessKey", + "operationId": "aggregateUser", "requestBody": { "required": true, "content": { @@ -75179,7 +75179,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -75193,7 +75193,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -75211,7 +75211,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -75228,14 +75228,14 @@ } } }, - "/user-config": { + "/user-access-key": { "get": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "List with basic information of User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfigList", + "summary": "List with basic information of User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKeyList", "parameters": [ { "name": "limit", @@ -75264,7 +75264,7 @@ ], "responses": { "200": { - "description": "List of User Config resources.", + "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { @@ -75283,7 +75283,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } ] @@ -75297,16 +75297,16 @@ "type": "object", "properties": { "first": { - "example": "/user-config?limit=25" + "example": "/user-access-key?limit=25" }, "last": { - "example": "/user-config?limit=25&page=11" + "example": "/user-access-key?limit=25&page=11" }, "next": { - "example": "/user-config?limit=25&page=4" + "example": "/user-access-key?limit=25&page=4" }, "prev": { - "example": "/user-config?limit=25&page=2" + "example": "/user-access-key?limit=25&page=2" } } } @@ -75327,7 +75327,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75342,11 +75342,11 @@ }, "post": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Create a new User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createUserConfig", + "summary": "Create a new User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserAccessKey", "parameters": [ { "name": "_response", @@ -75365,14 +75365,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -75384,7 +75384,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75399,7 +75399,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75415,14 +75415,14 @@ } } }, - "/search/user-config": { + "/search/user-access-key": { "post": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Search for the User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchUserConfig", + "summary": "Search for the User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserAccessKey", "parameters": [ { "name": "sw-include-search-info", @@ -75450,7 +75450,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -75464,7 +75464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75482,7 +75482,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75499,19 +75499,19 @@ } } }, - "/user-config/{id}": { + "/user-access-key/{id}": { "get": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Detailed information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfig", + "summary": "Detailed information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -75521,7 +75521,7 @@ ], "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -75533,7 +75533,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75548,7 +75548,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75565,16 +75565,16 @@ }, "delete": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Delete a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteUserConfig", + "summary": "Delete a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -75605,16 +75605,16 @@ }, "patch": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Partially update information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateUserConfig", + "summary": "Partially update information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -75632,18 +75632,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Config resource.", + "description": "Partially update information about a User Access Key resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -75655,7 +75655,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75670,7 +75670,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75689,14 +75689,14 @@ } } }, - "/aggregate/user-config": { + "/aggregate/user-access-key": { "post": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Aggregate for the User Config resources.", + "summary": "Aggregate for the User Access Key resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserConfig", + "operationId": "aggregateUserAccessKey", "requestBody": { "required": true, "content": { @@ -75720,7 +75720,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -75734,7 +75734,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75752,7 +75752,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -75769,14 +75769,14 @@ } } }, - "/user-recovery": { + "/user-config": { "get": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "List with basic information of User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecoveryList", + "summary": "List with basic information of User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfigList", "parameters": [ { "name": "limit", @@ -75805,7 +75805,7 @@ ], "responses": { "200": { - "description": "List of User Recovery resources.", + "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -75824,7 +75824,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } ] @@ -75838,16 +75838,16 @@ "type": "object", "properties": { "first": { - "example": "/user-recovery?limit=25" + "example": "/user-config?limit=25" }, "last": { - "example": "/user-recovery?limit=25&page=11" + "example": "/user-config?limit=25&page=11" }, "next": { - "example": "/user-recovery?limit=25&page=4" + "example": "/user-config?limit=25&page=4" }, "prev": { - "example": "/user-recovery?limit=25&page=2" + "example": "/user-config?limit=25&page=2" } } } @@ -75868,7 +75868,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -75883,11 +75883,11 @@ }, "post": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Create a new User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserRecovery", + "summary": "Create a new User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createUserConfig", "parameters": [ { "name": "_response", @@ -75906,14 +75906,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -75925,7 +75925,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -75940,7 +75940,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -75956,14 +75956,14 @@ } } }, - "/search/user-recovery": { + "/search/user-config": { "post": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Search for the User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUserRecovery", + "summary": "Search for the User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchUserConfig", "parameters": [ { "name": "sw-include-search-info", @@ -75991,7 +75991,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -76005,7 +76005,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76023,7 +76023,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76040,19 +76040,19 @@ } } }, - "/user-recovery/{id}": { + "/user-config/{id}": { "get": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Detailed information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecovery", + "summary": "Detailed information about a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -76062,7 +76062,7 @@ ], "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -76074,7 +76074,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76089,7 +76089,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76106,16 +76106,16 @@ }, "delete": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Delete a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserRecovery", + "summary": "Delete a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -76146,16 +76146,16 @@ }, "patch": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Partially update information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserRecovery", + "summary": "Partially update information about a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -76173,18 +76173,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Recovery resource.", + "description": "Partially update information about a User Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -76196,7 +76196,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76211,7 +76211,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76230,14 +76230,14 @@ } } }, - "/aggregate/user-recovery": { + "/aggregate/user-config": { "post": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Aggregate for the User Recovery resources.", + "summary": "Aggregate for the User Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserRecovery", + "operationId": "aggregateUserConfig", "requestBody": { "required": true, "content": { @@ -76261,7 +76261,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -76275,7 +76275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76293,7 +76293,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -76310,14 +76310,14 @@ } } }, - "/webhook": { + "/user-recovery": { "get": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "List with basic information of Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhookList", + "summary": "List with basic information of User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecoveryList", "parameters": [ { "name": "limit", @@ -76346,7 +76346,7 @@ ], "responses": { "200": { - "description": "List of Webhook resources.", + "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -76365,7 +76365,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } ] @@ -76379,16 +76379,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook?limit=25" + "example": "/user-recovery?limit=25" }, "last": { - "example": "/webhook?limit=25&page=11" + "example": "/user-recovery?limit=25&page=11" }, "next": { - "example": "/webhook?limit=25&page=4" + "example": "/user-recovery?limit=25&page=4" }, "prev": { - "example": "/webhook?limit=25&page=2" + "example": "/user-recovery?limit=25&page=2" } } } @@ -76409,7 +76409,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76424,11 +76424,11 @@ }, "post": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Create a new Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createWebhook", + "summary": "Create a new User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserRecovery", "parameters": [ { "name": "_response", @@ -76447,14 +76447,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -76466,7 +76466,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76481,7 +76481,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76497,14 +76497,14 @@ } } }, - "/search/webhook": { + "/search/user-recovery": { "post": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Search for the Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchWebhook", + "summary": "Search for the User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserRecovery", "parameters": [ { "name": "sw-include-search-info", @@ -76532,7 +76532,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -76546,7 +76546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76564,7 +76564,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76581,19 +76581,19 @@ } } }, - "/webhook/{id}": { + "/user-recovery/{id}": { "get": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Detailed information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhook", + "summary": "Detailed information about a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -76603,7 +76603,7 @@ ], "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -76615,7 +76615,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76630,7 +76630,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76647,16 +76647,16 @@ }, "delete": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Delete a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteWebhook", + "summary": "Delete a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -76687,16 +76687,16 @@ }, "patch": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Partially update information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateWebhook", + "summary": "Partially update information about a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -76714,18 +76714,18 @@ } ], "requestBody": { - "description": "Partially update information about a Webhook resource.", + "description": "Partially update information about a User Recovery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -76737,7 +76737,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76752,7 +76752,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76771,14 +76771,14 @@ } } }, - "/aggregate/webhook": { + "/aggregate/user-recovery": { "post": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Aggregate for the Webhook resources.", + "summary": "Aggregate for the User Recovery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhook", + "operationId": "aggregateUserRecovery", "requestBody": { "required": true, "content": { @@ -76802,7 +76802,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -76816,7 +76816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76834,7 +76834,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -76851,14 +76851,14 @@ } } }, - "/webhook-event-log": { + "/webhook": { "get": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "List with basic information of Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLogList", + "summary": "List with basic information of Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhookList", "parameters": [ { "name": "limit", @@ -76887,7 +76887,7 @@ ], "responses": { "200": { - "description": "List of Webhook Event Log resources.", + "description": "List of Webhook resources.", "content": { "application/vnd.api+json": { "schema": { @@ -76906,7 +76906,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } ] @@ -76920,16 +76920,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook-event-log?limit=25" + "example": "/webhook?limit=25" }, "last": { - "example": "/webhook-event-log?limit=25&page=11" + "example": "/webhook?limit=25&page=11" }, "next": { - "example": "/webhook-event-log?limit=25&page=4" + "example": "/webhook?limit=25&page=4" }, "prev": { - "example": "/webhook-event-log?limit=25&page=2" + "example": "/webhook?limit=25&page=2" } } } @@ -76950,7 +76950,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -76965,11 +76965,11 @@ }, "post": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Create a new Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "createWebhookEventLog", + "summary": "Create a new Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createWebhook", "parameters": [ { "name": "_response", @@ -76988,14 +76988,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -77007,7 +77007,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77022,7 +77022,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77038,14 +77038,14 @@ } } }, - "/search/webhook-event-log": { + "/search/webhook": { "post": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Search for the Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "searchWebhookEventLog", + "summary": "Search for the Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchWebhook", "parameters": [ { "name": "sw-include-search-info", @@ -77073,7 +77073,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -77087,7 +77087,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77105,7 +77105,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77122,19 +77122,19 @@ } } }, - "/webhook-event-log/{id}": { + "/webhook/{id}": { "get": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Detailed information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLog", + "summary": "Detailed information about a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -77144,7 +77144,7 @@ ], "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -77156,7 +77156,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77171,7 +77171,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77188,16 +77188,16 @@ }, "delete": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Delete a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "deleteWebhookEventLog", + "summary": "Delete a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -77228,16 +77228,16 @@ }, "patch": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Partially update information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "updateWebhookEventLog", + "summary": "Partially update information about a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -77255,18 +77255,18 @@ } ], "requestBody": { - "description": "Partially update information about a Webhook Event Log resource.", + "description": "Partially update information about a Webhook resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -77278,7 +77278,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77293,7 +77293,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77312,14 +77312,14 @@ } } }, - "/aggregate/webhook-event-log": { + "/aggregate/webhook": { "post": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Aggregate for the Webhook Event Log resources.", + "summary": "Aggregate for the Webhook resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhookEventLog", + "operationId": "aggregateWebhook", "requestBody": { "required": true, "content": { @@ -77343,7 +77343,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -77357,7 +77357,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77375,7 +77375,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -77392,384 +77392,576 @@ } } }, - "/_info/flow-actions.json": { + "/webhook-event-log": { "get": { "tags": [ - "System Info & Health Check" + "Webhook Event Log" + ], + "summary": "List with basic information of Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "getWebhookEventLogList", + "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" + } + } ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", "responses": { "200": { - "description": "Returns a list of action for flow builder.", + "description": "List of Webhook Event Log 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/WebhookEventLog" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/webhook-event-log?limit=25" + }, + "last": { + "example": "/webhook-event-log?limit=25&page=11" + }, + "next": { + "example": "/webhook-event-log?limit=25&page=4" + }, + "prev": { + "example": "/webhook-event-log?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/oauth/token": { + }, "post": { "tags": [ - "Authorization & Authentication" + "Webhook Event Log" + ], + "summary": "Create a new Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "createWebhookEventLog", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" - } - ] + "$ref": "#/components/schemas/WebhookEventLog" } } } }, "responses": { "200": { - "description": "Authorized successfully.", + "description": "Detail of WebhookEventLog", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + ] + } + }, "application/json": { "schema": { + "type": "object", "required": [ - "token_type", - "expires_in", - "access_token" + "data" ], "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" + "data": { + "$ref": "#/components/schemas/WebhookEventLog" } - }, - "type": "object" + } } } } }, "400": { "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/oauth/sso/config": { - "get": { + "/search/webhook-event-log": { + "post": { "tags": [ - "Experimental", - "SSO Login configuration" + "Webhook Event Log" + ], + "summary": "Search for the Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "searchWebhookEventLog", + "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" + } + } ], - "summary": "Experimental: Loads SSO login configuration.", - "description": "Experimental: Loads the SSO login configuration to configure the forward to the Shopware SSO login page.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, "responses": { "200": { - "description": "Experimental: Returns the configuration for the SSO login page forward.", + "description": "List of WebhookEventLog", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { - "useDefault": { - "description": "Experimental: Indicates which login is used. Default or SSO.", - "type": "boolean" + "total": { + "type": "integer" }, - "url": { - "description": "Experimental: Contains the return url for the Shopware SSO login.", - "type": "string" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "operationId": "loadSsoLoginConfig" + } } }, - "/oauth/sso/code": { + "/webhook-event-log/{id}": { "get": { "tags": [ - "Experimental", - "SSO Login callback" + "Webhook Event Log" + ], + "summary": "Detailed information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "getWebhookEventLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the webhook_event_log", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Experimental: Callback for SSO login", - "description": "Experimental: Logs in the user into the Shopware shop and forwards to the admin", "responses": { "200": { - "description": "Authorisation process continues", + "description": "Detail of WebhookEventLog", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + ] + } + }, "application/json": { "schema": { - "type": "object" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } } } } }, - "302": { - "description": "Experimental: Forwards to the Shopware admin" + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "operationId": "callBackWithCode" - } - }, - "/_info/health-check": { - "get": { + } + }, + "delete": { "tags": [ - "System Info & Health Check" + "Webhook Event Log" + ], + "summary": "Delete a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "deleteWebhookEventLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the webhook_event_log", + "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" + } + } ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", "responses": { - "200": { - "description": "Returns empty response" + "204": { + "$ref": "#/components/responses/204" }, - "500": { - "description": "Application is not working properly" + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_info/system-health-check": { - "get": { + }, + "patch": { "tags": [ - "System Info & Health Check" + "Webhook Event Log" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Partially update information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "updateWebhookEventLog", "parameters": [ { - "name": "verbose", + "name": "id", + "in": "path", + "description": "Identifier for the webhook_event_log", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", "in": "query", - "required": false, + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" + "type": "string" + } } ], + "requestBody": { + "description": "Partially update information about a Webhook Event Log resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + }, "responses": { "200": { - "description": "Returns the system health check results", + "description": "Detail of WebhookEventLog", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } + "data": { + "$ref": "#/components/schemas/WebhookEventLog" } } } } } }, - "500": { - "description": "Application is not working properly" + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/integration/{integrationId}/mcp-allowlist": { + "/aggregate/webhook-event-log": { "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" - ] - } + "Webhook Event Log" ], + "summary": "Aggregate for the Webhook Event Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhookEventLog", "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." - } - ] + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of WebhookEventLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" } } - }, - { - "type": "null", - "description": "Null = all capabilities unrestricted." } - ] + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } } } } } - } - }, - "responses": { - "204": { - "description": "Allowlist saved successfully." }, "400": { - "description": "Bad request — missing or invalid `allowlist` field." + "$ref": "#/components/responses/400" }, "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration_mcp.editor` privilege." - }, - "404": { - "description": "Integration not found." + "$ref": "#/components/responses/401" } } } }, - "/_action/user/{userId}/mcp-allowlist": { + "/_action/sync": { "post": { "tags": [ - "MCP", - "Experimental" + "Bulk Operations" ], - "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", + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", "parameters": [ { - "name": "userId", - "in": "path", - "required": true, - "description": "The user UUID.", + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "boolean", + "default": true } - } - ], - "security": [ + }, { - "oAuth": [ - "write" - ] + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "schema": { + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] + } } ], "requestBody": { @@ -77777,1073 +77969,1092 @@ "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." - } - ] + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "criteria": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "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." - } - ] + { + "$ref": "#/components/schemas/EqualsFilter" }, - "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." - } - ] + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - } - }, - { - "type": "null", - "description": "Null = all capabilities unrestricted." + ] } - ] - } + } + }, + "type": "object" } } } } }, - "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.", + "description": "Returns a sync result containing information about the updated entities", "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." - } + "properties": { + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" } - } + }, + "type": "object" } } } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration.editor` privilege." } } } }, - "/_action/mcp/capabilities": { - "get": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "post": { "tags": [ - "MCP", - "Experimental" + "Order Management" ], - "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": [ + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", + "parameters": [ { - "oAuth": [ - "write" - ] + "name": "orderTransactionId", + "in": "path", + "description": "Identifier of the order transaction.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + }, + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "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." + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/_mcp": { + "/_action/mail-template/send": { "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" - } - } + "Mail Operations" ], + "summary": "Send a mail", + "description": "Generates a mail and sends it to the customer. The mail content is rendered with data passed through the request.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", "requestBody": { "required": true, - "description": "A JSON-RPC 2.0 request or batch.", "content": { "application/json": { "schema": { - "type": "object", "required": [ - "jsonrpc", - "method" + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject" ], "properties": { - "jsonrpc": { + "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", - "enum": [ - "2.0" + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "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" + ] + } + } ] }, - "id": { + "recipientsCc": { + "description": "A mail address or a map of recipients with name and mail address to be set in CC.", "oneOf": [ { - "type": "string" + "type": "string", + "format": "email" }, { - "type": "integer" + "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": "null" + "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" + ] + } } ] }, - "method": { + "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" + ] + } + } + ] + }, + "mailTemplateId": { + "description": "Identifier of the mail template that should be used for attachments and sender defaults.", "type": "string", - "example": "tools/call" + "pattern": "^[0-9a-f]{32}$" }, - "params": { + "mailTemplateData": { + "description": "A map of available data that is used to fill the mail template. Values in this map override generated or entity-derived template data with the same top-level keys.", "type": "object", - "additionalProperties": true + "additionalProperties": true, + "example": { + "salesChannel": { + "name": "Storefront" + } + } + }, + "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": "JSON-RPC response or Server-Sent Events stream for long-running operations.", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "size" + ], "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" - } - } + "size": { + "description": "Length of the email message", + "type": "integer" } - } - } - }, - "text/event-stream": { - "schema": { - "type": "string", - "description": "Server-Sent Events stream for streaming responses." + }, + "type": "object" } } } }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "429": { - "description": "Too many requests — rate limit exceeded." + "400": { + "description": "Invalid request data", + "$ref": "#/components/responses/400" } } - }, - "get": { + } + }, + "/_action/mail-template/validate": { + "post": { "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" - } - } + "Mail Operations" ], - "responses": { - "200": { - "description": "Server-Sent Events stream.", - "content": { - "text/event-stream": { - "schema": { - "type": "string" - } + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "contentHtml", + "contentPlain" + ], + "properties": { + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + } + }, + "type": "object" } } - }, - "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." + "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, - "/_info/version": { - "get": { + "/_action/mail-template/build": { + "post": { "tags": [ - "System Info & Health Check" + "Mail Operations" ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/consents": { - "get": { - "tags": [ - "Consent Management", - "Experimental" - ], - "summary": "List all consents for current user", - "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "fetchConsents", - "responses": { - "200": { - "description": "List of consents with their status", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ConsentState" - }, - "example": { - "product_analytics": { - "name": "product_analytics", - "scopeName": "admin_user", - "identifier": "userId-12345", - "status": "accepted", - "actor": "userId-12345", - "updatedAt": "2024-01-15T10:20:30Z", - "acceptedUntil": "2024-01-15T10:20:30Z", - "acceptedRevision": "2026-02-01", - "latestRevision": "2026-02-01" - }, - "backend_data": { - "name": "backend_data", - "scopeName": "system", - "identifier": "system", - "status": "unset", - "actor": null, - "updatedAt": null, - "acceptedUntil": null, - "acceptedRevision": null, - "latestRevision": null - } - } - } - } - } - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" - } - } - } - }, - "/consents/accept": { - "post": { - "tags": [ - "Consent Management", - "Experimental" - ], - "summary": "Accept a consent", - "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "acceptConsent", + "summary": "Build up a mail template", + "description": "Generates a preview of a mail template when all the required data is passed through the request.", + "operationId": "build", + "deprecated": true, "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "mailTemplateType", + "mailTemplate" + ], "properties": { - "consent": { - "type": "string", - "description": "The name of the consent to accept" + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" }, - "revision": { - "type": [ - "string", - "null" - ], - "description": "Optional accepted revision. Only the consent definition's latest revision is accepted. When omitted, the latest revision is used automatically." + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of the mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" } }, - "required": [ - "consent" - ], - "example": { - "consent": "product_analytics", - "revision": "2026-02-01" - } + "type": "object" } } } }, "responses": { "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", + "description": "The rendered simulation result of the mail template parts.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConsentState" + "type": "string" } } } - }, - "400": { - "description": "Bad request - Consent revision is invalid for current acceptance" - }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/consents/revoke": { + "/_action/mail-template/simulate": { "post": { "tags": [ - "Consent Management", - "Experimental" + "Mail Operations" ], - "summary": "Revoke a consent", - "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "revokeConsent", + "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": { - "type": "object", + "required": [ + "templateParts", + "eventName" + ], "properties": { - "consent": { + "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", - "description": "The name of the consent to accept" + "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 } }, - "required": [ - "consent" - ], - "example": { - "consent": "product_analytics" - } + "type": "object" } } } }, "responses": { "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConsentState" + "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" + } + } + } } } } }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", - "parameters": [ - { - "name": "refreshOpenSearch", - "in": "query", - "required": false, - "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "400": { + "description": "Invalid request data or invalid eventName", + "$ref": "#/components/responses/400" } } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/mail-template/preview": { "post": { "tags": [ - "Customer impersonation" + "Mail Operations" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", + "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": [ - "customerId", - "salesChannelId" + "mailTemplateId" ], "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" + "mailTemplateId": { + "description": "Identifier of the mail template which should be rendered.", + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b3c4d5e6f7a8b90a1b2c3d4e5f678906" }, "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "The generated customer impersonation token.", - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" + "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" } }, - "type": "object" - } - } - } - } - } - } - }, - "/_info/queue.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get message queue statistics (deprecated)", - "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", - "operationId": "queue", - "deprecated": true, - "responses": { - "200": { - "description": "Message queue statistics returned.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { + "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", - "properties": { - "name": { - "type": "string", - "description": "Fully qualified class name of the message." + "additionalProperties": true, + "example": { + "salesChannel": { + "name": "Storefront" }, - "size": { - "type": "integer", - "description": "Number of pending messages of this type." + "order": { + "orderNumber": "SW10042" } - }, - "required": [ - "name", - "size" - ] + } } }, - "example": [ - { - "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", - "size": 150 - }, - { - "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", - "size": 25 - } - ] + "type": "object" } } } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." - } - } - } - }, - "/_info/message-stats.json": { - "get": { - "summary": "Get statistics message queue", - "description": "Get statistics for recently processed messages in the message queue", - "operationId": "getMessageStats", - "tags": [ - "System Info & Health Check" - ], + }, "responses": { "200": { - "description": "Statistics received", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { "type": "object", "required": [ - "enabled" + "subject", + "senderName", + "contentHtml", + "contentPlain" ], "properties": { - "enabled": { - "type": "boolean", - "description": "Whether message queue statistics are enabled in configuration" - }, - "stats": { - "type": [ - "object", - "null" + "subject": { + "type": "object", + "required": [ + "type", + "content" ], "properties": { - "totalMessagesProcessed": { - "type": "integer" - }, - "processedSince": { + "type": { + "description": "The type of the render result (either `success` or `error`)", "type": "string", - "format": "date-time" + "enum": [ + "success", + "error" + ], + "example": "success" }, - "averageTimeInQueue": { - "type": "number", - "format": "float" + "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" }, - "messageTypeStats": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "count": { - "type": "integer" - } - } - } + "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" } } - } - } - } - } - } - } - } - } - }, - "/_action/user/logout": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "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." + }, + "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." + } + } + } + } + } + } + } }, - "403": { - "description": "The authenticated source does not have a user ID associated." + "400": { + "description": "Invalid request data or invalid mailTemplateId", + "$ref": "#/components/responses/400" } } } }, - "/_action/scheduled-task/run": { + "/_action/mail-template/get-data-and-send": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", - "responses": { - "200": { - "description": "Returns a success message indicating a successful run.", - "content": { - "application/json": { - "schema": { - "properties": { - "message": { - "description": "Success message", - "type": "string" + "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" + ] } }, - "type": "object" - } + "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" } } } - } - } - }, - "/_action/scheduled-task/min-run-interval": { - "get": { - "tags": [ - "System Operations" - ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + }, "responses": { "200": { - "description": "Returns the minimum interval.", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { + "required": [ + "size" + ], "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" + "size": { + "description": "Length of the email message", + "type": "integer" } }, "type": "object" } } } + }, + "400": { + "description": "Invalid request data or invalid mailTemplateId", + "$ref": "#/components/responses/400" } } } }, - "/_action/message-queue/consume": { + "/_action/mail-template/available-variables": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", + "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": [ - "receiver" + "eventName" ], "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" + "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" @@ -78853,14 +79064,65 @@ }, "responses": { "200": { - "description": "Returns information about handled messages", + "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" + } + } + } + }, + "/oauth/sso/config": { + "get": { + "tags": [ + "Authorization & Authentication", + "SSO Login configuration" + ], + "summary": "Loads configuration for the admin login", + "description": "Loads the configuration for the admin login. This configuration is used to load and configure the default or Single Sign On (SSO) login for the admin.", + "operationId": "loadSsoLoginConfig", + "responses": { + "200": { + "description": "Config loaded successfully.", "content": { "application/json": { "schema": { "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" + "useDefault": { + "description": "Experimental: Indicates which login is used. Default or SSO.", + "type": "boolean" + }, + "url": { + "description": "Experimental: Contains the return url for the Shopware SSO login.", + "type": "string" } }, "type": "object" @@ -78871,147 +79133,153 @@ } } }, - "/_action/container_cache": { - "delete": { + "/oauth/sso/code": { + "get": { "tags": [ - "System Operations" + "Authorization & Authentication", + "SSO Login callback" ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", + "summary": "Callback function. Fetch an authorization code", + "description": "Fetch an authorization code log in the user.", + "operationId": "callBackWithCode", "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." + "302": { + "description": "Experimental: Forwards to the Shopware admin" + }, + "200": { + "description": "Authorisation process continues", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } } } } }, - "/_action/state-machine/{entityName}/{entityId}/state": { + "/oauth/sso/auth": { "get": { "tags": [ - "State Machine" + "Experimental", + "SSO Login forward" ], - "summary": "Get available transitions for an entity", - "description": "Retrieves the available state transitions for the specified entity.", - "operationId": "getEntityState", + "summary": "Experimental: Redirect to SSO login", + "description": "Experimental: Creates a redirection to the SSO login page", + "operationId": "ssoAuth", + "responses": { + "302": { + "description": "Experimental: Forwards to SSO login Page" + } + } + } + }, + "/_info/is-sso": { + "get": { + "tags": [ + "Experimental", + "Is SSO environment" + ], + "summary": "Experimental: Is SSO environment", + "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", + "operationId": "isSso", + "responses": { + "200": { + "description": "Experimental: Returns if it is a SSO environment or not" + } + } + } + }, + "/_action/sso/invite-user": { + "post": { + "tags": [ + "Experimental", + "Invite a new SSO user" + ], + "summary": "Experimental: Invite a new SSO user", + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", + "operationId": "inviteUser", + "responses": { + "200": { + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" + } + } + } + }, + "/_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": "entityName", + "name": "fileFamily", "in": "path", - "description": "Name of the entity.", + "description": "File family below `Resources/views/files`, for example `agentic`.", "required": true, "schema": { - "type": "string" + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" } }, { - "name": "entityId", + "name": "salesChannelId", "in": "path", - "description": "Identifier of the entity.", + "description": "Identifier of the sales channel for which stored configuration should be loaded.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "stateFieldName", - "in": "query", - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "required": false, - "schema": { - "type": "string", - "default": "stateId" - } } ], "responses": { "200": { - "description": "Available transitions for the current state.", + "description": "Discovered sales channel files for the given file family.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "transitions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the transition." - }, - "technicalName": { - "type": "string", - "description": "The technical name of the transition." - }, - "actionName": { - "type": "string", - "description": "The action name of the transition." - }, - "fromStateName": { - "type": "string", - "description": "The technical name of the state the transition starts from." - }, - "toStateName": { - "type": "string", - "description": "The technical name of the state the transition goes to." - }, - "url": { - "type": "string", - "description": "The URL to trigger the transition." - } - }, - "required": [ - "name", - "technicalName", - "actionName", - "fromStateName", - "toStateName", - "url" - ] - } - } - }, - "required": [ - "transitions" - ] + "$ref": "#/components/schemas/SalesChannelFileListResponse" } } } }, "400": { - "description": "Unable to read the entity or entity field." - }, - "403": { - "description": "Forbidden. Missing privileges to access the entity." + "description": "Invalid file family.", + "$ref": "#/components/responses/400" } } } }, - "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { - "post": { + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/detail": { + "get": { "tags": [ - "State Machine" + "Sales Channel Files" ], - "summary": "Transition an entity to a new state", - "description": "Changes the entity state by applying the given transition.", - "operationId": "transitionEntityState", + "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": "entityName", + "name": "fileFamily", "in": "path", - "description": "Name of the entity.", + "description": "File family below `Resources/views/files`, for example `agentic`.", "required": true, "schema": { - "type": "string" + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" } }, { - "name": "entityId", + "name": "salesChannelId", "in": "path", - "description": "Identifier of the entity.", + "description": "Identifier of the sales channel for which stored configuration should be loaded.", "required": true, "schema": { "type": "string", @@ -79019,79 +79287,127 @@ } }, { - "name": "transition", + "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": "The `action_name` of the `state_machine_transition`.", + "description": "File family below `Resources/views/files`, for example `agentic`.", "required": true, "schema": { - "type": "string" + "type": "string", + "maxLength": 64, + "pattern": "^[A-Za-z0-9_-]+$" } }, { - "name": "stateFieldName", - "in": "query", - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "required": false, + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel used to build the rendering context.", + "required": true, "schema": { "type": "string", - "default": "stateId" + "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { - "description": "Optional internal comment for the state transition.", + "description": "Preview input containing the public file name and optional Twig overrides keyed by Twig namespace.", + "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "internalComment": { - "type": "string", - "description": "An optional internal comment that will be saved with the state transition." - } - } + "$ref": "#/components/schemas/SalesChannelFilePreviewRequest" } } } }, "responses": { "200": { - "description": "State transition applied successfully." + "description": "Rendered preview content.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelFilePreviewResponse" + } + } + } }, "400": { - "description": "Unable to read the entity or entity field, or invalid transition." + "description": "Invalid request payload, file family, or file name.", + "$ref": "#/components/responses/400" }, - "403": { - "description": "Forbidden. Missing privileges to access the entity." + "404": { + "description": "The requested sales channel file was not discovered.", + "$ref": "#/components/responses/404" } } } }, - "/_action/order/document/download": { - "post": { + "/_action/media/{mediaId}/download": { + "get": { "tags": [ - "Document Management" + "Asset Management" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", - "requestBody": { - "description": "documentIds", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "summary": "Download a media file", + "description": "Downloads a media file by its identifier.", + "operationId": "downloadMedia", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "Identifier of the media entity.", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" } } - }, + ], "responses": { "200": { - "description": "The documents.", + "description": "The media file.", "content": { "application/octet-stream": { "schema": { @@ -79100,108 +79416,101 @@ } } } + }, + "302": { + "description": "Redirects to the resolved media download URL.", + "headers": { + "Location": { + "description": "Contains the resolved media download URL.", + "schema": { + "type": "string" + } + } + } } } } }, - "/_action/order/document/{documentTypeName}/create": { - "post": { + "/_action/media/{mediaId}/download/prepare": { + "get": { "tags": [ - "Document Management" + "Asset Management" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Prepare a media download", + "description": "Resolves the browser download URL for a media file by its identifier.", + "operationId": "prepareMediaDownload", "parameters": [ { - "name": "documentTypeName", + "name": "mediaId", "in": "path", - "description": "The type of document to create", + "description": "Identifier of the media entity.", "required": true, "schema": { - "type": "string" + "$ref": "#/components/schemas/MediaId" } } ], - "requestBody": { - "description": "test", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { + "responses": { + "200": { + "description": "The resolved browser download strategy.", + "content": { + "application/json": { + "schema": { "type": "object", "required": [ - "orderId", "type" ], "properties": { - "orderId": { - "description": "Identifier of the order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "type": { - "description": "Type of the document to be generated.", - "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false + "enum": [ + "external", + "blob" + ], + "description": "Whether the frontend should trigger an external URL directly or fall back to an authenticated blob download." }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", + "url": { "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" + "description": "External URL that should be used by the browser to start the download." } } } } } } - }, - "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." - } } } }, - "/_action/order/{orderId}/state/{transition}": { + "/_action/media/{mediaId}/upload": { "post": { "tags": [ - "Order Management" + "Asset Management" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", "parameters": [ { - "name": "orderId", + "name": "mediaId", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier of the media entity.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/MediaId" } }, { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `png`", "required": true, "schema": { "type": "string" @@ -79209,37 +79518,21 @@ } ], "requestBody": { - "required": false, "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { + "required": [ + "url" + ], "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - }, - "internalComment": { - "description": "An optional internal comment that will be saved with the state transition.", + "url": { + "description": "The url of the media file that will be downloaded.", "type": "string" } }, @@ -79249,153 +79542,87 @@ } }, "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" - } - } - } - }, - "/_info/openapi3.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] + "204": { + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", + "schema": { + "type": "string" + } + } } } - ], - "responses": { - "200": { - "$ref": "#/components/responses/OpenApi3" - } } } }, - "/_action/sync": { + "/_action/media/upload": { "post": { "tags": [ - "Bulk Operations" - ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", - "parameters": [ - { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", - "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] - } - } + "Asset Management" ], + "summary": "Upload a new media file", + "description": "Creates a new media entity and uploads a file to it using form-data file upload.", + "operationId": "uploadV2", "requestBody": { - "required": true, "content": { - "application/json": { + "multipart/form-data": { "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], - "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", - "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } - }, - "criteria": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - } + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The file to upload" }, - "type": "object" - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the uploaded file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" + } + }, + "required": [ + "file" + ] } } } }, "responses": { "200": { - "description": "Returns a sync result containing information about the updated entities", + "description": "Media file uploaded successfully", "content": { - "application/json": { + "application\\/json": { "schema": { + "type": "object", "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" - }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" - }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" } - }, - "type": "object" + } } } } @@ -79403,355 +79630,153 @@ } } }, - "/_action/mail-template/send": { + "/_action/media/upload_by_url": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "summary": "Send a mail", - "description": "Generates a mail and sends it to the customer. The mail content is rendered with data passed through the request.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", + "summary": "Upload a media file from URL", + "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", + "operationId": "uploadByUrl", "requestBody": { - "required": true, "content": { - "application/json": { + "application\\/json": { "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject" - ], + "type": "object", "properties": { - "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.", + "url": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" + "description": "URL of the file to download and upload" }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "id": { "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" - ] - } - } - ] + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" }, - "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" - ] - } - } - ] + "fileName": { + "type": "string", + "description": "Name of the uploaded file" }, - "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" - ] - } - } - ] + "private": { + "type": "boolean", + "description": "Whether the media should be private" }, - "mailTemplateId": { - "description": "Identifier of the mail template that should be used for attachments and sender defaults.", + "mediaFolderId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" }, - "mailTemplateData": { - "description": "A map of available data that is used to fill the mail template. 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" - } - } + "mimeType": { + "type": "string", + "description": "MIME type of the file" }, - "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" + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" } }, - "type": "object" + "required": [ + "url" + ] } } } }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "Media file uploaded successfully", "content": { - "application/json": { + "application\\/json": { "schema": { - "required": [ - "size" - ], + "type": "object", "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" } - }, - "type": "object" + } } } } - }, - "400": { - "description": "Invalid request data", - "$ref": "#/components/responses/400" } } } }, - "/_action/mail-template/validate": { + "/_action/media/external-link": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "deprecated": true, + "summary": "Create external media link", + "description": "Creates a new media entity that links to an external URL without downloading the file.", + "operationId": "externalLink", "requestBody": { - "required": true, "content": { - "application/json": { + "application\\/json": { "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], + "type": "object", "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" + "url": { + "type": "string", + "description": "URL of the external media file" }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." - } - } - } - }, - "/_action/mail-template/build": { - "post": { - "tags": [ - "Mail Operations" - ], - "summary": "Build up a mail template", - "description": "Generates a preview of a mail template when all the required data is passed through the request.", - "operationId": "build", - "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], - "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of the mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" + "fileName": { + "type": "string", + "description": "Name of the file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on path" + }, + "thumbnails": { + "type": "array", + "description": "Optional list of external thumbnail URLs for the media entity. Used 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.", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } } }, - "type": "object" + "required": [ + "url", + "mimeType" + ] } } } }, "responses": { "200": { - "description": "The rendered simulation result of the mail template parts.", + "description": "External media link created successfully", "content": { - "application/json": { + "application\\/json": { "schema": { - "type": "string" + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } } } } @@ -79759,88 +79784,94 @@ } } }, - "/_action/mail-template/simulate": { + "/_action/media/presign-upload": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "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", + "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": [ - "templateParts", - "eventName" + "fileName", + "extension", + "mimeType" ], "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 }}" - } + "fileName": { + "type": "string", + "description": "Name of the file without extension" }, - "eventName": { - "description": "The business event name used to generate simulated mail template data.", + "extension": { "type": "string", - "example": "checkout.order.placed" + "description": "File extension, e.g. `jpg`, `png`, `pdf`" }, - "salesChannelId": { - "description": "Identifier of the sales channel that should be used for the simulate request.", + "mimeType": { + "type": "string", + "description": "MIME type of the file, e.g. `image/jpeg`" + }, + "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + "description": "ID of the media folder to place the new media in" }, - "strictRendering": { - "description": "Enables strict variable rendering and surfaces errors for unknown variables. Defaults to `true`.", + "private": { "type": "boolean", - "default": true + "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." } - }, - "type": "object" + } } } } }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "Presigned upload prepared successfully", "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" - } + "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" } } } @@ -79848,187 +79879,102 @@ } }, "400": { - "description": "Invalid request data or invalid eventName", + "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/mail-template/preview": { + "/_action/media/{mediaId}/finalize-upload": { "post": { "tags": [ - "Mail Operations" + "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" + } + } ], - "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": { + "type": "object", "required": [ - "mailTemplateId" - ], - "properties": { - "mailTemplateId": { - "description": "Identifier of the mail template which should be rendered.", + "fileName", + "extension", + "mimeType", + "path" + ], + "properties": { + "fileName": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b3c4d5e6f7a8b90a1b2c3d4e5f678906" + "description": "Name of the file without extension" }, - "salesChannelId": { - "description": "Identifier of the sales channel that should be used for the preview request.", + "extension": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b3c4d5e6f7a8b90a1b2c3d4e5f67890a" + "description": "File extension, e.g. `jpg`, `png`, `pdf`" }, - "includeHeaderFooter": { - "description": "Includes the sales channel mail header and footer in `contentHtml` and `contentPlain`. Defaults to `false`.", - "type": "boolean", - "default": false + "mimeType": { + "type": "string", + "description": "MIME type of the file" }, - "strictRendering": { - "description": "Enables strict variable rendering and enables errors on e.g. unknown variables. Defaults to `false`.", - "type": "boolean", - "default": false + "path": { + "type": "string", + "description": "Storage path returned by the presign-upload endpoint" }, - "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" - } + "width": { + "type": "integer", + "description": "Image width in pixels (optional, for images only)" }, - "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" - } - } + "height": { + "type": "integer", + "description": "Image height in pixels (optional, for images only)" } - }, - "type": "object" + } } } } }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "Upload finalized successfully", "content": { "application/json": { "schema": { "type": "object", "required": [ - "subject", - "senderName", - "contentHtml", - "contentPlain" + "mediaId" ], "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." - } - } + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the finalized media entity" } } } @@ -80036,300 +79982,1044 @@ } }, "400": { - "description": "Invalid request data or invalid mailTemplateId", + "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/mail-template/get-data-and-send": { + "/_action/media/{mediaId}/external-thumbnails": { "post": { "tags": [ - "Mail Operations" + "Asset Management" + ], + "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", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be attached to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } ], - "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" - ], + "type": "object", "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.", + "thumbnails": { "type": "array", + "description": "List of external thumbnails to attach", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/ExternalThumbnail" } - }, - "documentIds": { - "description": "List of document identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Thumbnails attached successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" + }, + "thumbnailsCreated": { + "type": "integer" + } + } + } + } + } + }, + "400": { + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" + } + } + }, + "delete": { + "tags": [ + "Asset Management" + ], + "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", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be deleted from..", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } + ], + "responses": { + "200": { + "description": "Thumbnails deleted successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" + } + } + } + } + } + }, + "400": { + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" + } + } + } + }, + "/_action/media/{mediaId}/video-cover": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Assign or remove a video cover image", + "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", + "operationId": "assignVideoCover", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "required": true, + "description": "ID of the video media entity", + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "coverMediaId": { + "type": [ + "string", + "null" + ], + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the image media entity to use as cover. Set to null to remove the cover." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Video cover assigned or removed successfully" + }, + "400": { + "description": "Invalid request" + } + } + } + }, + "/_info/openapi3.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/OpenApi3" + } + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", + "responses": { + "200": { + "description": "Information about the cache state.", + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" } }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", + "type": "object" + } + } + } + } + } + } + }, + "/_action/index": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "skip": { + "description": "Array of indexers/updaters to be skipped.", "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" + "type": "string" } - }, - "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" - ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." + } + } + } + }, + "/_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", + "in": "query", + "description": "The configuration domain.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "salesChannelId", + "in": "query", + "description": "The sales channel ID to scope the configuration to.", + "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." + } + } + }, + "post": { + "tags": [ + "System Config" + ], + "summary": "Save configuration values", + "description": "Saves the given configuration key-value pairs for the given sales channel.", + "operationId": "saveConfiguration", + "parameters": [ + { + "name": "salesChannelId", + "in": "query", + "description": "The sales channel ID to scope the configuration to.", + "schema": { + "type": "string" + } + }, + { + "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.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "requestBody": { + "description": "Key-value pairs of configuration values to save.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + } + } + } + }, + "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" + } + } + ], + "responses": { + "200": { + "description": "Returns the configuration schema." + } + } + } + }, + "/_action/system-config/batch": { + "post": { + "tags": [ + "System Config" + ], + "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", + "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.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "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 + } + } + } + } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } + } + } + }, + "/app-system/privileges/requested": { + "get": { + "tags": [ + "App System" + ], + "summary": "Get requested privileges for all apps", + "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", + "operationId": "getRequestedPrivileges", + "security": [ + { + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing requested privileges.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" } } + } + } + }, + "example": { + "privileges": { + "SwagAnalytics": [ + "customer:read", + "order:read" + ], + "SwagExample": [ + "product:write" ] - }, - "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" - ] - } + } + } + } + } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + } + } + } + }, + "/app-system/{appName}/privileges/accepted": { + "get": { + "tags": [ + "App System" + ], + "summary": "Get accepted privileges for an app", + "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", + "operationId": "getAcceptedPrivileges", + "parameters": [ + { + "name": "appName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "security": [ + { + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing accepted privileges.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "boolean" } - ] + } + } + }, + "example": { + "privileges": { + "customer:read": true, + "order:read": true + } + } + } + } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + } + } + }, + "/app-system/{appName}/privileges": { + "patch": { + "tags": [ + "App System" + ], + "summary": "Accept or revoke privileges for an app", + "description": "Accepts or revokes specified privileges for the given app.", + "operationId": "managePrivileges", + "parameters": [ + { + "name": "appName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "accept": { + "type": "array", + "items": { + "type": "string" + } }, - "replyTo": { - "description": "A mail address or a map of mail addresses with name to be set in reply-to.", - "oneOf": [ - { + "revoke": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "example": { + "accept": [ + "customer:read", + "order:read" + ], + "revoke": [ + "product:write" + ] + } + } + } + }, + "responses": { + "204": { + "description": "Returns no content if privileges were managed successfully." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/_action/app-system/secret/rotate": { + "post": { + "tags": [ + "App System" + ], + "summary": "Initiate secret rotation for the calling app", + "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", + "operationId": "appSecretRotation", + "responses": { + "202": { + "description": "Returns \"Accepted\" when secret rotation was scheduled." + }, + "400": { + "description": "Malformed request, e.g. when requested with non app integration source." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/app-system/shop/verify": { + "get": { + "tags": [ + "App System", + "Public" + ], + "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", + "parameters": [ + { + "name": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "token", + "in": "query", + "description": "A unique identifier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "An empty response signalling successful verification." + }, + "400": { + "description": "Malformed request or unsuccessful verification." + } + } + } + }, + "/_info/queue.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get message queue statistics (deprecated)", + "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", + "operationId": "queue", + "deprecated": true, + "responses": { + "200": { + "description": "Message queue statistics returned.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { "type": "string", - "format": "email" + "description": "Fully qualified class name of the message." }, - { - "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" - ] - } + "size": { + "type": "integer", + "description": "Number of pending messages of this type." } + }, + "required": [ + "name", + "size" ] + } + }, + "example": [ + { + "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", + "size": 150 }, - "returnPath": { - "description": "A mail address or a map of mail addresses with name to be set in return-path.", - "oneOf": [ - { - "type": "string", - "format": "email" - }, - { + { + "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", + "size": 25 + } + ] + } + } + } + } + } + }, + "/_action/translation/list": { + "get": { + "tags": [ + "Translation Management" + ], + "summary": "List configured translation locales", + "description": "Lists every locale configured for translation download together with its locally installed metadata.", + "operationId": "translationList", + "responses": { + "200": { + "description": "The configured locales and their installed metadata.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "description": "Number of configured locales.", + "type": "integer" + }, + "items": { + "type": "array", + "items": { "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" - ] + "properties": { + "locale": { + "description": "The locale code, for example `de-DE`.", + "type": "string" + }, + "name": { + "description": "The configured language name.", + "type": "string" + }, + "lastUpdate": { + "description": "ISO-8601 timestamp of the last installation, or null if not installed.", + "type": "string", + "format": "date-time" + }, + "progress": { + "description": "Translation completeness in percent, or null if not installed.", + "type": "integer" + } } } - ] - }, - "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" - } + } + } + } + } + } + } + } + }, + "/_action/translation/install": { + "post": { + "tags": [ + "Translation Management" + ], + "summary": "Install translations for locales", + "description": "Downloads and installs translations for the given locales, or for all configured locales when `all` is set. Created languages are activated unless `activate` is set to `false`.", + "operationId": "translationInstall", + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "locales": { + "description": "Locale codes to install, for example `[\"de-DE\", \"fr-FR\"]`. Required unless `all` is true.", + "type": "array", + "items": { + "type": "string" } }, - "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.", + "all": { + "description": "Install all configured locales instead of the `locales` list.", + "type": "boolean" + }, + "activate": { + "description": "Whether created languages are activated. Defaults to true.", "type": "boolean" } - }, - "type": "object" + } } } } }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "The locales that were updated and the ones skipped as already up to date.", "content": { "application/json": { "schema": { - "required": [ - "size" - ], + "type": "object", "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "updated": { + "description": "Locale codes that were downloaded and installed.", + "type": "array", + "items": { + "type": "string" + } + }, + "skipped": { + "description": "Locale codes that were already up to date.", + "type": "array", + "items": { + "type": "string" + } + }, + "unavailable": { + "description": "Requested locale codes that have no translation available and were not installed.", + "type": "array", + "items": { + "type": "string" + } } - }, - "type": "object" + } + } + } + } + } + } + } + }, + "/_action/translation/update": { + "post": { + "tags": [ + "Translation Management" + ], + "summary": "Update all installed translations", + "description": "Updates all installed translations.", + "operationId": "translationUpdate", + "responses": { + "200": { + "description": "The locales that were updated and the ones skipped as already up to date.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "updated": { + "description": "Locale codes that were downloaded and installed.", + "type": "array", + "items": { + "type": "string" + } + }, + "skipped": { + "description": "Locale codes that were already up to date.", + "type": "array", + "items": { + "type": "string" + } + }, + "unavailable": { + "description": "Requested locale codes that have no translation available and were not installed.", + "type": "array", + "items": { + "type": "string" + } + } + } } } } + } + } + } + }, + "/_action/translation/{locale}": { + "delete": { + "tags": [ + "Translation Management" + ], + "summary": "Uninstall a translation", + "description": "Removes the downloaded translation files and the metadata entry for the given locale. The associated language, locale and snippet set records are left untouched and can be managed through their regular admin API endpoints.", + "operationId": "translationDelete", + "parameters": [ + { + "name": "locale", + "in": "path", + "description": "The locale code to uninstall, for example `de-DE`.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The translation files and metadata entry were removed." + } + } + } + }, + "/_action/user/logout": { + "post": { + "tags": [ + "Authorization & Authentication" + ], + "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." }, - "400": { - "description": "Invalid request data or invalid mailTemplateId", - "$ref": "#/components/responses/400" + "401": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." } } } }, - "/_action/mail-template/available-variables": { + "/_action/index-products": { "post": { "tags": [ - "Mail Operations" + "System 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", + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "eventName" + "customerId", + "salesChannelId" ], "properties": { - "eventName": { - "description": "The business event name that provides the available variables.", - "type": "string", - "example": "checkout.order.placed" + "customerId": { + "description": "ID of the customer", + "type": "string" }, - "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" + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" } }, "type": "object" @@ -80339,235 +81029,432 @@ }, "responses": { "200": { - "description": "The available variables got fetched successfully.", + "description": "The generated customer impersonation token.", "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 - } + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" } }, - "type": "array", - "description": "A collection of the available variables which also show if behind the variables are more nested variables." + "type": "object" } } } - }, - "400": { - "description": "Invalid request data or invalid eventName", - "$ref": "#/components/responses/400" } } } }, - "/_action/system-config": { + "/_info/config": { "get": { "tags": [ - "System Config" + "System Info & Health Check" ], - "summary": "Get configuration values", - "description": "Returns the configuration values for the given domain and optional sales channel.", - "operationId": "getConfigurationValues", - "parameters": [ - { - "name": "domain", - "in": "query", - "description": "The configuration domain.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "salesChannelId", - "in": "query", - "description": "The sales channel ID to scope the configuration to.", - "schema": { - "type": "string" - } - }, - { - "name": "inherit", - "in": "query", - "description": "Whether to include inherited (global) values.", - "schema": { - "type": "boolean", - "default": false + "summary": "Get public runtime config & feature metadata", + "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", + "operationId": "config", + "responses": { + "200": { + "description": "Public runtime configuration & feature metadata returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/infoConfigResponse" + }, + "example": { + "version": "6.7.2.0", + "shopId": "NoiU8PfJtu7NBY8M", + "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", + "adminWorker": { + "enableAdminWorker": true, + "enableNotificationWorker": true, + "transports": [ + "webhook", + "async", + "low_priority" + ] + }, + "bundles": { + "Administration": { + "css": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" + ], + "js": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" + ], + "baseUrl": null, + "type": "plugin" + }, + "Storefront": { + "css": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" + ], + "js": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" + ], + "baseUrl": null, + "type": "plugin" + } + }, + "settings": { + "enableUrlFeature": true, + "appUrlReachable": true, + "appsRequireAppUrl": false, + "firstMigrationDate": "2025-01-01T12:00:00.000Z", + "private_allowed_extensions": [ + "jpg", + "jpeg", + "png", + "webp", + "avif", + "gif", + "svg", + "bmp", + "tiff", + "tif", + "eps", + "webm", + "mkv", + "flv", + "ogv", + "ogg", + "mov", + "mp4", + "avi", + "wmv", + "pdf", + "aac", + "mp3", + "wav", + "flac", + "oga", + "wma", + "txt", + "doc", + "docx", + "ico", + "glb", + "zip", + "rar", + "csv", + "xls", + "xlsx", + "html", + "xml", + "epub" + ], + "private_allowed_mime_types_by_extension": { + "pdf": [ + "application/pdf" + ], + "epub": [ + "application/epub+zip" + ] + }, + "enableHtmlSanitizer": true, + "enableStagingMode": false, + "disableExtensionManagement": false + }, + "inAppPurchases": [] + } + } } } + } + } + }, + "/consents": { + "get": { + "tags": [ + "Consent Management", + "Experimental" ], + "summary": "List all consents for current user", + "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "fetchConsents", "responses": { "200": { - "description": "Returns the configuration values as a key-value object." + "description": "List of consents with their status", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ConsentState" + }, + "example": { + "product_analytics": { + "name": "product_analytics", + "scopeName": "admin_user", + "identifier": "userId-12345", + "status": "accepted", + "actor": "userId-12345", + "updatedAt": "2024-01-15T10:20:30Z", + "acceptedUntil": "2024-01-15T10:20:30Z", + "acceptedRevision": "2026-02-01", + "latestRevision": "2026-02-01" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "unset", + "actor": null, + "updatedAt": null, + "acceptedUntil": null, + "acceptedRevision": null, + "latestRevision": null + } + } + } + } + } + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } - }, + } + }, + "/consents/accept": { "post": { "tags": [ - "System Config" + "Consent Management", + "Experimental" ], - "summary": "Save configuration values", - "description": "Saves the given configuration key-value pairs for the given sales channel.", - "operationId": "saveConfiguration", - "parameters": [ - { - "name": "salesChannelId", - "in": "query", - "description": "The sales channel ID to scope the configuration to.", - "schema": { - "type": "string" + "summary": "Accept a consent", + "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "acceptConsent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + }, + "revision": { + "type": [ + "string", + "null" + ], + "description": "Optional accepted revision. Only the consent definition's latest revision is accepted. When omitted, the latest revision is used automatically." + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics", + "revision": "2026-02-01" + } + } } - }, - { - "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.", - "schema": { - "type": "boolean", - "default": false + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } } + }, + "400": { + "description": "Bad request - Consent revision is invalid for current acceptance" + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } + } + } + }, + "/consents/revoke": { + "post": { + "tags": [ + "Consent Management", + "Experimental" ], + "summary": "Revoke a consent", + "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "revokeConsent", "requestBody": { - "description": "Key-value pairs of configuration values to save.", - "required": true, "content": { "application/json": { "schema": { "type": "object", - "additionalProperties": true + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } } } } }, "responses": { - "204": { - "description": "Configuration saved successfully." + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } + } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/system-config/check": { + "/_action/state-machine/{entityName}/{entityId}/state": { "get": { "tags": [ - "System Config" + "State Machine" ], - "summary": "Check configuration", - "description": "Checks if a configuration domain exists.", - "operationId": "checkConfiguration", + "summary": "Get available transitions for an entity", + "description": "Retrieves the available state transitions for the specified entity.", + "operationId": "getEntityState", "parameters": [ { - "name": "domain", - "in": "query", - "description": "The configuration domain to check.", + "name": "entityName", + "in": "path", + "description": "Name of the entity.", "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.", + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - } - ], - "responses": { - "200": { - "description": "Returns the configuration schema." - } - } - } - }, - "/_action/system-config/batch": { - "post": { - "tags": [ - "System Config" - ], - "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", - "parameters": [ + }, { - "name": "silent", + "name": "stateFieldName", "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": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, "schema": { - "type": "boolean", - "default": false + "type": "string", + "default": "stateId" } } ], - "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": { + "responses": { + "200": { + "description": "Available transitions for the current state.", + "content": { + "application/json": { + "schema": { "type": "object", - "additionalProperties": true + "properties": { + "transitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the transition." + }, + "technicalName": { + "type": "string", + "description": "The technical name of the transition." + }, + "actionName": { + "type": "string", + "description": "The action name of the transition." + }, + "fromStateName": { + "type": "string", + "description": "The technical name of the state the transition starts from." + }, + "toStateName": { + "type": "string", + "description": "The technical name of the state the transition goes to." + }, + "url": { + "type": "string", + "description": "The URL to trigger the transition." + } + }, + "required": [ + "name", + "technicalName", + "actionName", + "fromStateName", + "toStateName", + "url" + ] + } + } + }, + "required": [ + "transitions" + ] } } } - } - }, - "responses": { - "204": { - "description": "Configuration saved successfully." + }, + "400": { + "description": "Unable to read the entity or entity field." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." } } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { "post": { "tags": [ - "Order Management" + "State Machine" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Transition an entity to a new state", + "description": "Changes the entity state by applying the given transition.", + "operationId": "transitionEntityState", "parameters": [ { - "name": "orderDeliveryId", + "name": "entityName", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", "required": true, "schema": { "type": "string", @@ -80577,393 +81464,562 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "description": "The `action_name` of the `state_machine_transition`.", "required": true, "schema": { "type": "string" } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } } ], "requestBody": { - "required": false, + "description": "Optional internal comment for the state transition.", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be send to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - }, "internalComment": { - "description": "An optional internal comment that will be saved with the state transition.", - "type": "string" + "type": "string", + "description": "An optional internal comment that will be saved with the state transition." } - }, - "type": "object" + } } } } }, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "description": "State transition applied successfully." + }, + "400": { + "description": "Unable to read the entity or entity field, or invalid transition." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." } } } }, - "/_action/validation/email": { + "/_action/increment/{pool}": { "post": { "tags": [ - "Email support validation" + "Increment Storage" + ], + "summary": "Increment a value in the specified pool", + "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", + "operationId": "incrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the increment operation.", + "required": false, + "schema": { + "type": "string" + } + } ], - "summary": "Email support.", - "description": "Checks a given email string.", - "operationId": "supportsEmail", "requestBody": { "required": true, "content": { "application/json": { "schema": { + "type": "object", "required": [ - "email" + "key" ], "properties": { - "email": { - "description": "The email to be verified.", - "type": "string" + "key": { + "type": "string", + "description": "The key to increment in the pool." } - }, - "type": "object" + } } } } }, "responses": { - "204": { - "description": "Email is supported" - }, - "400": { - "description": "Invalid request payload. The argument 'email' may be missing.", + "200": { + "description": "Successfully incremented the value", "content": { "application/json": { "schema": { + "type": "object", "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." + "success": { + "type": "boolean", + "example": true } - ] + } } } } }, - "422": { - "description": "Email address is not supported.", + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" + } + } + }, + "get": { + "tags": [ + "Increment Storage" + ], + "summary": "List increment values from pool", + "description": "Retrieves a list of increment values from the specified pool with pagination support.", + "operationId": "getIncrementValues", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to list values from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the increment operation.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum number of items to return.", + "required": false, + "schema": { + "type": "integer", + "default": 5, + "minimum": 1 + } + }, + { + "name": "offset", + "in": "query", + "description": "Number of items to skip for pagination.", + "required": false, + "schema": { + "type": "integer", + "default": 0, + "minimum": 0 + } + } + ], + "responses": { + "200": { + "description": "List of increment values", "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." + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The increment key" + }, + "count": { + "type": "integer", + "description": "The current count value" + } } - ] + } } } } + }, + "400": { + "description": "Bad request - cluster parameter missing" } } } }, - "/_action/index": { + "/_action/decrement/{pool}": { "post": { "tags": [ - "System Operations" + "Increment Storage" + ], + "summary": "Decrement a value in the specified pool", + "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", + "operationId": "decrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the decrement operation.", + "required": false, + "schema": { + "type": "string" + } + } ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "object", + "required": [ + "key" + ], "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } + "key": { + "type": "string", + "description": "The key to decrement in the pool." } - }, - "type": "object" + } } } } }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." - } - } - } - }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", - "tags": [ - "System Info & Health Check" - ], "responses": { "200": { - "description": "Successful operation", + "description": "Successfully decremented the value", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "endpoints" - ], "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } + "success": { + "type": "boolean", + "example": true } } } } } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { + "/_action/reset-increment/{pool}": { + "post": { "tags": [ - "Number Range Management" + "Increment Storage" ], - "summary": "Reserve or preview a number-range / document number.", - "description": "Reserves or previews the next value for a number range type, for example `order`, `customer`, `product`, or `document_invoice`. This route resolves the applicable number range by type and sales channel.\n\nThe generated number will be reserved and the number pointer will be incremented with every call. For preview purposes, add the `?preview=1` parameter to the request. In that case, the number will not be incremented.\n\nWhen editing an existing persisted number range and previewing its concrete state or unsaved pattern/start changes, use `/_action/number-range/{numberRangeId}/preview-pattern` instead.", - "operationId": "numberRangeReserve", + "summary": "Reset increment values in pool", + "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", + "operationId": "resetIncrementValues", "parameters": [ { - "name": "type", + "name": "pool", "in": "path", - "description": "Technical name of the number range type, for example `order`, `customer`, `product`, or `document_invoice`.", + "description": "The name of the increment pool to reset.", "required": true, "schema": { "type": "string" } }, { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the reset operation.", "required": true, "schema": { "type": "string" } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." + } + } + } + } + } + }, "responses": { "200": { - "description": "The generated number", + "description": "Successfully reset the increment values", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "number": { - "description": "The generated or previewed number range value.", - "type": "string" + "success": { + "type": "boolean", + "example": true } - }, - "type": "object" + } } } } }, "400": { - "description": "Number range not found" + "description": "Bad request - cluster parameter missing" } } } }, - "/_action/number-range/{numberRangeId}/preview-pattern": { - "get": { + "/_action/delete-increment/{pool}": { + "delete": { "tags": [ - "Number Range Management" + "Increment Storage" ], - "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", + "summary": "Delete increment keys from pool", + "description": "Deletes specific increment keys from the specified pool.", + "operationId": "deleteIncrementKeys", "parameters": [ { - "name": "numberRangeId", + "name": "pool", "in": "path", - "description": "Identifier of the number range to preview.", + "description": "The name of the increment pool to delete keys from.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "pattern", + "name": "cluster", "in": "query", - "description": "Optional pattern override for the preview.", - "required": false, + "description": "Cluster identifier for the delete operation.", + "required": true, "schema": { "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "keys" + ], + "properties": { + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of keys to delete from the pool." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully deleted the increment keys" }, + "400": { + "description": "Bad request - invalid keys parameter or cluster parameter missing" + } + } + } + }, + "/_action/indexing": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", + "parameters": [ { - "name": "start", - "in": "query", - "description": "Optional start value override for the preview.", - "required": false, + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { - "description": "The previewed number", + "description": "Returns information about the iteration.", "content": { "application/json": { "schema": { "properties": { - "number": { - "description": "The previewed number.", - "type": "string" + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" } }, "type": "object" } } } - }, - "404": { - "description": "Number range not found" } } } }, - "/_action/order_transaction_capture_refund/{refundId}": { + "/_info/events.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", + "responses": { + "200": { + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } + } + } + } + }, + "/_action/scheduled-task/run": { "post": { "tags": [ - "Order Management" + "System Operations" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", - "parameters": [ - { - "name": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", + "responses": { + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" + } + }, + "type": "object" + } + } } } + } + } + }, + "/_action/scheduled-task/min-run-interval": { + "get": { + "tags": [ + "System Operations" ], + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" + "200": { + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", "parameters": [ { - "name": "orderTransactionId", + "name": "orderDeliveryId", "in": "path", - "description": "Identifier of the order transaction.", + "description": "Identifier of the order delivery.", "required": true, "schema": { "type": "string", @@ -80973,7 +82029,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", "required": true, "schema": { "type": "string" @@ -80987,7 +82043,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be sent to the customer." + "description": "Controls if a mail should be send to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -81006,7 +82062,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, @@ -81022,349 +82078,274 @@ }, "responses": { "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" + "description": "Todo: Use ref of `state_machine_transition` here" } } } }, - "/_info/config": { - "get": { + "/_action/cache": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get public runtime config & feature metadata", - "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", - "operationId": "config", + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Public runtime configuration & feature metadata returned.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/infoConfigResponse" - }, - "example": { - "version": "6.7.2.0", - "shopId": "NoiU8PfJtu7NBY8M", - "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", - "adminWorker": { - "enableAdminWorker": true, - "enableNotificationWorker": true, - "transports": [ - "webhook", - "async", - "low_priority" - ] - }, - "bundles": { - "Administration": { - "css": [ - "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" - ], - "js": [ - "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" - ], - "baseUrl": null, - "type": "plugin" - }, - "Storefront": { - "css": [ - "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" - ], - "js": [ - "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" - ], - "baseUrl": null, - "type": "plugin" - } - }, - "settings": { - "enableUrlFeature": true, - "appUrlReachable": true, - "appsRequireAppUrl": false, - "firstMigrationDate": "2025-01-01T12:00:00.000Z", - "private_allowed_extensions": [ - "jpg", - "jpeg", - "png", - "webp", - "avif", - "gif", - "svg", - "bmp", - "tiff", - "tif", - "eps", - "webm", - "mkv", - "flv", - "ogv", - "ogg", - "mov", - "mp4", - "avi", - "wmv", - "pdf", - "aac", - "mp3", - "wav", - "flac", - "oga", - "wma", - "txt", - "doc", - "docx", - "ico", - "glb", - "zip", - "rar", - "csv", - "xls", - "xlsx", - "html", - "xml" - ], - "enableHtmlSanitizer": true, - "enableStagingMode": false, - "disableExtensionManagement": false - }, - "inAppPurchases": [] - } - } - } + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_action/cleanup": { + "/_action/cache-delayed": { "delete": { "tags": [ "System Operations" ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "parameters": [ + { + "name": "refreshOpenSearch", + "in": "query", + "required": false, + "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", + "schema": { + "type": "boolean", + "default": false + } + } + ], "responses": { "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_action/indexing": { + "/_action/customer-convert/{customerId}": { "post": { "tags": [ - "System Operations" + "Customer convert" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", + "summary": "Convert guest customer to registered customer", + "description": "Converts an existing guest customer into a registered customer. If a password is provided, the customer can immediately log in using that password. If no password is provided, a password recovery email will be sent to the customer so they can set their password.", + "parameters": [ + { + "name": "customerId", + "in": "path", + "description": "The id of the customer that should be converted.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "description": "Optional data for the conversion process.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "password": { + "type": "string", + "description": "Optional password for the customer. If provided, the customer can log in immediately using this password. If omitted, a password recovery email will be sent." + } + } + } + } + } + }, "responses": { - "200": { - "description": "Returns an empty response indicating that the indexing process started." + "204": { + "description": "Customer successfully converted to a registered customer." + }, + "401": { + "description": "The customer with the specified ID could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } + }, + "400": { + "description": "The customer is not a guest, or the sales channel domain could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + } + } + } } } } }, - "/_action/indexing/{indexer}": { - "post": { + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { "tags": [ - "System Operations" + "Number Range Management" ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", + "summary": "Reserve or preview a number-range / document number.", + "description": "Reserves or previews the next value for a number range type, for example `order`, `customer`, `product`, or `document_invoice`. This route resolves the applicable number range by type and sales channel.\n\nThe generated number will be reserved and the number pointer will be incremented with every call. For preview purposes, add the `?preview=1` parameter to the request. In that case, the number will not be incremented.\n\nWhen editing an existing persisted number range and previewing its concrete state or unsaved pattern/start changes, use `/_action/number-range/{numberRangeId}/preview-pattern` instead.", + "operationId": "numberRangeReserve", "parameters": [ { - "name": "indexer", + "name": "type", "in": "path", - "description": "Name of the indexer to iterate.", + "description": "Technical name of the number range type, for example `order`, `customer`, `product`, or `document_invoice`.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "Returns information about the iteration.", + "description": "The generated number", "content": { "application/json": { "schema": { "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" + "number": { + "description": "The generated or previewed number range value.", + "type": "string" } }, "type": "object" } } } + }, + "400": { + "description": "Number range not found" } } } }, - "/_action/media/{mediaId}/upload": { - "post": { + "/_action/number-range/{numberRangeId}/preview-pattern": { + "get": { "tags": [ - "Asset Management" + "Number Range Management" ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", + "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": "mediaId", + "name": "numberRangeId", "in": "path", - "description": "Identifier of the media entity.", + "description": "Identifier of the number range to preview.", "required": true, "schema": { - "$ref": "#/components/schemas/MediaId" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "fileName", + "name": "pattern", "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "description": "Optional pattern override for the preview.", + "required": false, "schema": { "type": "string" } }, { - "name": "extension", + "name": "start", "in": "query", - "description": "Extension of the uploaded file. For example `png`", - "required": true, + "description": "Optional start value override for the preview.", + "required": false, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, "responses": { - "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", + "200": { + "description": "The previewed number", + "content": { + "application/json": { "schema": { - "type": "string" + "properties": { + "number": { + "description": "The previewed number.", + "type": "string" + } + }, + "type": "object" } } } + }, + "404": { + "description": "Number range not found" } } } }, - "/_action/media/upload": { - "post": { + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", "tags": [ - "Asset Management" + "System Info & Health Check" ], - "summary": "Upload a new media file", - "description": "Creates a new media entity and uploads a file to it using form-data file upload.", - "operationId": "uploadV2", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The file to upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" - } - }, - "required": [ - "file" - ] - } - } - } - }, "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "Successful operation", "content": { - "application\\/json": { + "application/json": { "schema": { "type": "object", + "required": [ + "endpoints" + ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } } } } @@ -81374,70 +82355,154 @@ } } }, - "/_action/media/upload_by_url": { + "/_action/order/{orderId}/order-address": { "post": { "tags": [ - "Asset Management" + "Order address" + ], + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Upload a media file from URL", - "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", - "operationId": "uploadByUrl", "requestBody": { "content": { - "application\\/json": { + "application/json": { "schema": { "type": "object", "properties": { - "url": { - "type": "string", - "description": "URL of the file to download and upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "description": "The ID of the delivery (optional)", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" } - }, - "required": [ - "url" - ] + } } } - } + }, + "required": true }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/_info/flow-actions.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "Returns a list of action for flow builder.", "content": { - "application\\/json": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flowBuilderActionsResponse" + } + } + } + } + } + } + }, + "/_info/message-stats.json": { + "get": { + "summary": "Get statistics message queue", + "description": "Get statistics for recently processed messages in the message queue", + "operationId": "getMessageStats", + "tags": [ + "System Info & Health Check" + ], + "responses": { + "200": { + "description": "Statistics received", + "content": { + "application/json": { "schema": { "type": "object", + "required": [ + "enabled" + ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "enabled": { + "type": "boolean", + "description": "Whether message queue statistics are enabled in configuration" + }, + "stats": { + "type": [ + "object", + "null" + ], + "properties": { + "totalMessagesProcessed": { + "type": "integer" + }, + "processedSince": { + "type": "string", + "format": "date-time" + }, + "averageTimeInQueue": { + "type": "number", + "format": "float" + }, + "messageTypeStats": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "count": { + "type": "integer" + } + } + } + } + } } } } @@ -81447,195 +82512,263 @@ } } }, - "/_action/media/external-link": { + "/_action/cleanup": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cleanup finished." + } + } + } + }, + "/_action/order/document/download": { "post": { "tags": [ - "Asset Management" + "Document Management" ], - "summary": "Create external media link", - "description": "Creates a new media entity that links to an external URL without downloading the file.", - "operationId": "externalLink", + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", "requestBody": { + "description": "documentIds", "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "URL of the external media file" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on path" - }, - "thumbnails": { - "type": "array", - "description": "Optional list of external thumbnail URLs for the media entity. Used 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.", - "items": { - "$ref": "#/components/schemas/ExternalThumbnail" - } - } - }, - "required": [ - "url", - "mimeType" - ] + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } } } }, "responses": { "200": { - "description": "External media link created successfully", + "description": "The documents.", "content": { - "application\\/json": { + "application/octet-stream": { "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/order/document/{documentTypeName}/create": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", + "parameters": [ + { + "name": "documentTypeName", + "in": "path", + "description": "The type of document to create", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "test", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "type": "object", + "required": [ + "orderId", + "type" + ], "properties": { - "id": { + "orderId": { + "description": "Identifier of the order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Type of the document to be generated.", + "type": "string" + }, + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" + }, + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" } } } } } } + }, + "responses": { + "200": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + } } } }, - "/_action/media/presign-upload": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ - "Asset Management" + "Order Management" + ], + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } + } ], - "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, + "required": false, "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "fileName", - "extension", - "mimeType" - ], "properties": { - "fileName": { - "type": "string", - "description": "Name of the file without extension" + "sendMail": { + "description": "Controls if a mail should be sent to the customer." }, - "extension": { - "type": "string", - "description": "File extension, e.g. `jpg`, `png`, `pdf`" + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "mimeType": { - "type": "string", - "description": "MIME type of the file, e.g. `image/jpeg`" + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "mediaFolderId": { + "stateFieldName": { + "description": "This is the state column within the order database table. There should be no need to change it from the default.", "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" + "default": "stateId" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of an existing media entity to replace. If omitted, a new entity is created." + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" } - } + }, + "type": "object" } } } }, "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" - } - } - } - } + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", + "parameters": [ + { + "name": "refundId", + "in": "path", + "description": "Identifier of the order transaction capture refund.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } + } + ], + "responses": { + "204": { + "description": "Refund was successful" }, "400": { - "description": "Bad request. The file extension is not supported or the file name is invalid.", - "$ref": "#/components/responses/400" + "description": "Something went wrong, while processing the refund" }, "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.", + "description": "Refund with id not found" + } + } + } + }, + "/_info/version": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", + "responses": { + "200": { + "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/failure" + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" } } } @@ -81643,353 +82776,308 @@ } } }, - "/_action/media/{mediaId}/finalize-upload": { + "/oauth/token": { "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" - } - } + "Authorization & Authentication" ], + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", "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" + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" }, - "width": { - "type": "integer", - "description": "Image width in pixels (optional, for images only)" + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" }, - "height": { - "type": "integer", - "description": "Image height in pixels (optional, for images only)" + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" } - } + ] } } } }, "responses": { "200": { - "description": "Upload finalized successfully", + "description": "Authorized successfully.", "content": { "application/json": { "schema": { - "type": "object", "required": [ - "mediaId" + "token_type", + "expires_in", + "access_token" ], "properties": { - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the finalized media entity" + "token_type": { + "description": "Type of the token.", + "type": "string" + }, + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "type": "string" } - } + }, + "type": "object" } } } }, "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/media/{mediaId}/external-thumbnails": { + "/_action/validation/email": { "post": { "tags": [ - "Asset Management" - ], - "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", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "description": "ID of the external media entity the thumbnails will be attached to.", - "required": true, - "schema": { - "$ref": "#/components/schemas/MediaId" - } - } + "Email support validation" ], + "summary": "Email support.", + "description": "Checks a given email string.", + "operationId": "supportsEmail", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "email" + ], "properties": { - "thumbnails": { - "type": "array", - "description": "List of external thumbnails to attach", - "items": { - "$ref": "#/components/schemas/ExternalThumbnail" - } + "email": { + "description": "The email to be verified.", + "type": "string" } - } + }, + "type": "object" } } } }, "responses": { - "201": { - "description": "Thumbnails attached successfully", + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "mediaId": { - "description": "ID of the media entity the thumbnails were attached to.", - "$ref": "#/components/schemas/MediaId" - }, - "thumbnailsCreated": { - "type": "integer" + "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." + } + ] } } } }, - "400": { - "description": "Media is not an external media entity or path is missing" - }, - "404": { - "description": "Media entity not found" - } - } - }, - "delete": { - "tags": [ - "Asset Management" - ], - "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", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "description": "ID of the external media entity the thumbnails will be deleted from..", - "required": true, - "schema": { - "$ref": "#/components/schemas/MediaId" - } - } - ], - "responses": { - "200": { - "description": "Thumbnails deleted successfully", + "422": { + "description": "Email address is not supported.", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "mediaId": { - "description": "ID of the media entity the thumbnails were deleted from.", - "$ref": "#/components/schemas/MediaId" + "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." + } + ] } } } - }, - "400": { - "description": "Media is not an external media entity or path is missing" - }, - "404": { - "description": "Media entity not found" } } } }, - "/_action/media/{mediaId}/video-cover": { - "post": { + "/_action/container_cache": { + "delete": { "tags": [ - "Asset Management" + "System Operations" ], - "summary": "Assign or remove a video cover image", - "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", - "operationId": "assignVideoCover", + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." + } + } + } + }, + "/_action/document/{documentId}/{deepLinkCode}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", "parameters": [ { - "name": "mediaId", + "name": "documentId", "in": "path", + "description": "Identifier of the document to be downloaded.", "required": true, - "description": "ID of the video media entity", "schema": { - "$ref": "#/components/schemas/MediaId" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "coverMediaId": { - "type": [ - "string", - "null" - ], - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the image media entity to use as cover. Set to null to remove the cover." - } + "responses": { + "200": { + "description": "The document.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" } } } } - }, - "responses": { - "204": { - "description": "Video cover assigned or removed successfully" - }, - "400": { - "description": "Invalid request" - } } } }, - "/_action/order/{orderId}/order-address": { + "/_action/document/{documentId}/upload": { "post": { "tags": [ - "Order address" - ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "Document Management" + ], + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", "parameters": [ { - "name": "orderId", + "name": "documentId", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier of the document the new file should be added to.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { - "type": "object", + "required": [ + "url" + ], "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "description": "The ID of the delivery (optional)", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" } - } + }, + "type": "object" } } - }, - "required": true - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." } - } - } - }, - "/_info/events.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + }, "responses": { "200": { - "description": "Returns a list of about the business events.", + "description": "Document uploaded successful", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/businessEventsResponse" + "properties": { + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", + "type": "string" + } + }, + "type": "object" } } } @@ -81997,343 +83085,282 @@ } } }, - "/app-system/privileges/requested": { - "get": { + "/_action/message-queue/consume": { + "post": { "tags": [ - "App System" + "System Operations" ], - "summary": "Get requested privileges for all apps", - "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", - "operationId": "getRequestedPrivileges", - "security": [ - { - "oAuth": [ - "admin" - ] + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "receiver" + ], + "properties": { + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" + } + }, + "type": "object" + } + } } - ], + }, "responses": { "200": { - "description": "A JSON object containing requested privileges.", + "description": "Returns information about handled messages", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } + "handledMessages": { + "description": "The number of messages processed.", + "type": "integer" } - } - }, - "example": { - "privileges": { - "SwagAnalytics": [ - "customer:read", - "order:read" - ], - "SwagExample": [ - "product:write" - ] - } + }, + "type": "object" } } } + } + } + } + }, + "/_info/health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Check that the Application is running", + "operationId": "healthCheck", + "responses": { + "200": { + "description": "Returns empty response" }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." + "500": { + "description": "Application is not working properly" } } } }, - "/app-system/{appName}/privileges/accepted": { + "/_info/system-health-check": { "get": { "tags": [ - "App System" + "System Info & Health Check" ], - "summary": "Get accepted privileges for an app", - "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", - "operationId": "getAcceptedPrivileges", + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", "parameters": [ { - "name": "appName", - "in": "path", - "required": true, + "name": "verbose", + "in": "query", + "required": false, "schema": { - "type": "string" - } - } - ], - "security": [ - { - "oAuth": [ - "admin" - ] + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" } ], "responses": { "200": { - "description": "A JSON object containing accepted privileges.", + "description": "Returns the system health check results", "content": { "application/json": { "schema": { "type": "object", "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "boolean" + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } } } } - }, - "example": { - "privileges": { - "customer:read": true, - "order:read": true - } } } } }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." + "500": { + "description": "Application is not working properly" } } } }, - "/app-system/{appName}/privileges": { - "patch": { + "/_action/integration/{integrationId}/mcp-allowlist": { + "post": { "tags": [ - "App System" + "MCP", + "Experimental" ], - "summary": "Accept or revoke privileges for an app", - "description": "Accepts or revokes specified privileges for the given app.", - "operationId": "managePrivileges", + "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": "appName", + "name": "integrationId", "in": "path", "required": true, + "description": "The integration UUID.", "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], + "security": [ + { + "oAuth": [ + "write" + ] + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", - "properties": { - "accept": { - "type": "array", - "items": { - "type": "string" - } - }, - "revoke": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "example": { - "accept": [ - "customer:read", - "order:read" + "required": [ + "allowlist" ], - "revoke": [ - "product:write" - ] - } - } - } - }, - "responses": { - "204": { - "description": "Returns no content if privileges were managed successfully." - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] - } - ] - } - }, - "/_action/app-system/secret/rotate": { - "post": { - "tags": [ - "App System" - ], - "summary": "Initiate secret rotation for the calling app", - "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", - "operationId": "appSecretRotation", - "responses": { - "202": { - "description": "Returns \"Accepted\" when secret rotation was scheduled." - }, - "400": { - "description": "Malformed request, e.g. when requested with non app integration source." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] - } - ] - } - }, - "/app-system/shop/verify": { - "get": { - "tags": [ - "App System", - "Public" - ], - "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", - "parameters": [ - { - "name": "runId", - "in": "query", - "description": "A unique identifier used to look up the token", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "in": "query", - "description": "A unique identifier", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "An empty response signalling successful verification." - }, - "400": { - "description": "Malformed request or unsuccessful verification." - } - } - } - }, - "/_action/cache_info": { - "get": { - "tags": [ - "System Operations" - ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", - "responses": { - "200": { - "description": "Information about the cache state.", - "content": { - "application/json": { - "schema": { - "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" - }, - "cacheAdapter": { - "description": "The active cache adapter.", - "type": "string" - } - }, - "type": "object" + "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/increment/{pool}": { + "/_action/user/{userId}/mcp-allowlist": { "post": { "tags": [ - "Increment Storage" + "MCP", + "Experimental" ], - "summary": "Increment a value in the specified pool", - "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", - "operationId": "incrementValue", + "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": "pool", + "name": "userId", "in": "path", - "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", "required": true, + "description": "The user UUID.", "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "security": [ { - "name": "cluster", - "in": "query", - "description": "Optional cluster identifier for the increment operation.", - "required": false, - "schema": { - "type": "string" - } + "oAuth": [ + "write" + ] } ], "requestBody": { @@ -82343,12 +83370,67 @@ "schema": { "type": "object", "required": [ - "key" + "allowlist" ], "properties": { - "key": { - "type": "string", - "description": "The key to increment in the pool." + "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." + } + ] } } } @@ -82356,93 +83438,103 @@ } }, "responses": { - "200": { - "description": "Successfully incremented the value", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } + "204": { + "description": "Allowlist saved successfully." }, "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" + "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": [ - "Increment Storage" + "MCP", + "Experimental" ], - "summary": "List increment values from pool", - "description": "Retrieves a list of increment values from the specified pool with pagination support.", - "operationId": "getIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to list values from.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the increment operation.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of items to return.", - "required": false, - "schema": { - "type": "integer", - "default": 5, - "minimum": 1 - } - }, + "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": [ { - "name": "offset", - "in": "query", - "description": "Number of items to skip for pagination.", - "required": false, - "schema": { - "type": "integer", - "default": 0, - "minimum": 0 - } + "oAuth": [ + "write" + ] } ], "responses": { "200": { - "description": "List of increment values", + "description": "Array of registered MCP tools.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", + "required": [ + "name" + ], "properties": { - "key": { + "name": { "type": "string", - "description": "The increment key" + "description": "Unique tool identifier used in `tools/call` requests.", + "example": "shopware-entity-search" }, - "count": { - "type": "integer", - "description": "The current count value" + "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." } } } @@ -82450,172 +83542,201 @@ } } }, - "400": { - "description": "Bad request - cluster parameter missing" - } - } - } - }, - "/_action/decrement/{pool}": { - "post": { - "tags": [ - "Increment Storage" - ], - "summary": "Decrement a value in the specified pool", - "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", - "operationId": "decrementValue", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Optional cluster identifier for the decrement operation.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to decrement in the pool." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successfully decremented the value", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } + "401": { + "description": "Unauthorized — missing or invalid credentials." }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" + "403": { + "description": "Forbidden — caller lacks `integration.editor` privilege." } } } }, - "/_action/reset-increment/{pool}": { - "post": { + "/_action/mcp/capabilities": { + "get": { "tags": [ - "Increment Storage" + "MCP", + "Experimental" ], - "summary": "Reset increment values in pool", - "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", - "operationId": "resetIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to reset.", - "required": true, - "schema": { - "type": "string" - } - }, + "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": [ { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the reset operation.", - "required": true, - "schema": { - "type": "string" - } + "oAuth": [ + "write" + ] } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." - } - } - } - } - } - }, "responses": { "200": { - "description": "Successfully reset the increment values", + "description": "Object containing all registered MCP capabilities.", "content": { "application/json": { "schema": { "type": "object", + "required": [ + "tools", + "resources", + "prompts" + ], "properties": { - "success": { - "type": "boolean", - "example": true + "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" + ] + } + } + } } } } } } }, - "400": { - "description": "Bad request - cluster parameter missing" + "401": { + "description": "Unauthorized — missing or invalid credentials." + }, + "403": { + "description": "Forbidden — caller lacks `integration.editor` privilege." } } } }, - "/_action/delete-increment/{pool}": { - "delete": { + "/_mcp": { + "post": { "tags": [ - "Increment Storage" + "MCP", + "Experimental" ], - "summary": "Delete increment keys from pool", - "description": "Deletes specific increment keys from the specified pool.", - "operationId": "deleteIncrementKeys", + "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": "pool", - "in": "path", - "description": "The name of the increment pool to delete keys from.", - "required": true, + "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": "cluster", - "in": "query", - "description": "Cluster identifier for the delete operation.", - "required": true, + "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" } @@ -82623,220 +83744,181 @@ ], "requestBody": { "required": true, + "description": "A JSON-RPC 2.0 request or batch.", "content": { "application/json": { "schema": { "type": "object", "required": [ - "keys" + "jsonrpc", + "method" ], "properties": { - "keys": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of keys to delete from the pool." + "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": { - "204": { - "description": "Successfully deleted the increment keys" - }, - "400": { - "description": "Bad request - invalid keys parameter or cluster parameter missing" - } - } - } - }, - "/oauth/sso/auth": { - "get": { - "tags": [ - "Experimental", - "SSO Login forward" - ], - "summary": "Experimental: Redirect to SSO login", - "description": "Experimental: Creates a redirection to the SSO login page", - "operationId": "ssoAuth", - "responses": { - "302": { - "description": "Experimental: Forwards to SSO login Page" - } - } - } - }, - "/_info/is-sso": { - "get": { - "tags": [ - "Experimental", - "Is SSO environment" - ], - "summary": "Experimental: Is SSO environment", - "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", - "operationId": "isSso", - "responses": { - "200": { - "description": "Experimental: Returns if it is a SSO environment or not" - } - } - } - }, - "/_action/sso/invite-user": { - "post": { - "tags": [ - "Experimental", - "Invite a new SSO user" - ], - "summary": "Experimental: Invite a new SSO user", - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", - "operationId": "inviteUser", "responses": { "200": { - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" + "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." } } - } - }, - "/_action/document/{documentId}/{deepLinkCode}": { + }, "get": { "tags": [ - "Document Management" + "MCP", + "Experimental" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "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": "documentId", - "in": "path", - "description": "Identifier of the document to be downloaded.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, + "name": "mcp-session-id", + "in": "header", + "required": false, "schema": { "type": "string" } - }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } } ], "responses": { "200": { - "description": "The document.", + "description": "Server-Sent Events stream.", "content": { - "application/octet-stream": { + "text/event-stream": { "schema": { - "type": "string", - "format": "binary" + "type": "string" } } } + }, + "401": { + "description": "Unauthorized." } } - } - }, - "/_action/document/{documentId}/upload": { - "post": { + }, + "delete": { "tags": [ - "Document Management" + "MCP", + "Experimental" ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", + "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": "documentId", - "in": "path", - "description": "Identifier of the document the new file should be added to.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", + "name": "mcp-session-id", + "in": "header", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } + "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": { - "200": { - "description": "Document uploaded successful", - "content": { - "application/json": { - "schema": { - "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "CORS preflight accepted." } } } @@ -90912,6 +91994,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "extensionName": { + "description": "Name of the plugin or app that owns this custom field set.", + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -91092,6 +92178,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "extensionName": { + "description": "Name of the plugin or app that owns this custom field set.", + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -108858,6 +109948,11 @@ "description": { "type": "string" }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, "metaTitle": { "type": "string" }, @@ -110215,6 +111310,11 @@ "type": "string", "description": "Description of the product." }, + "descriptionTeaser": { + "description": "Read-only, HTML-stripped excerpt of the description, derived on write.", + "type": "string", + "readOnly": true + }, "metaTitle": { "type": "string", "description": "A page title indexed by search engines and appears in search results listings." @@ -113755,6 +114855,10 @@ "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", "type": "boolean" }, + "displayAsGroup": { + "description": "When enabled, matching variants are grouped according to the product presentation setting. Disable to show them individually.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -113972,6 +115076,10 @@ "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", "type": "boolean" }, + "displayAsGroup": { + "description": "When enabled, matching variants are grouped according to the product presentation setting. Disable to show them individually.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -117664,6 +118772,10 @@ "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, + "businessTimeZone": { + "description": "Business timezone used for sales-channel-specific rendering. Added since version: 6.7.13.0.", + "type": "string" + }, "name": { "type": "string" }, @@ -117694,13 +118806,19 @@ "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, - "maintenanceIpWhitelist": { + "maintenanceIpAllowlist": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, + "maintenanceIpWhitelist": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "customFields": { "type": "object" }, @@ -118827,6 +119945,37 @@ }, "type": "object" }, + "salesChannelFiles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelFiles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_file" + }, + "id": { + "type": "string", + "example": "98cb8f9be6620dcdb0ab1b3b87f2662e" + } + } + } + } + }, + "type": "object" + }, "analytics": { "properties": { "links": { @@ -119098,6 +120247,10 @@ "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, + "businessTimeZone": { + "description": "Business timezone used for sales-channel-specific rendering. Added since version: 6.7.13.0.", + "type": "string" + }, "name": { "type": "string", "description": "Name of the sales channel." @@ -119130,12 +120283,18 @@ "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, + "maintenanceIpAllowlist": { + "type": "array", + "items": { + "type": "string" + } + }, "maintenanceIpWhitelist": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" }, + "deprecated": true, "description": "List of IP addresseS used when the maintenance mode is active." }, "customFields": { @@ -119459,6 +120618,12 @@ "$ref": "#/components/schemas/ProductExport" } }, + "salesChannelFiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFile" + } + }, "analytics": { "$ref": "#/components/schemas/SalesChannelAnalytics" }, @@ -120033,6 +121198,144 @@ }, "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": [ @@ -127139,121 +128442,376 @@ }, "type": "object" }, - "ConsentState": { + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" + "url", + "width", + "height" ], "properties": { - "name": { + "url": { "type": "string", - "description": "The name of the consent" + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 }, - "identifier": { + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", - "description": "The resolved identifier of the consent" + "pattern": "^[0-9a-f]{32}$" }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "net": { + "description": "Net price for the associated currency.", + "type": "number" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "linked": { + "description": "Whether gross and net prices are linked through the tax configuration.", + "type": "boolean" }, - "acceptedUntil": { + "percentage": { + "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", "type": [ - "string", + "object", "null" ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" + "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" + ] }, - "acceptedRevision": { - "type": [ - "string", - "null" - ], - "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + "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" + ] }, - "latestRevision": { - "type": [ - "string", - "null" - ], - "description": "The current latest revision defined for the consent. null when the consent does not use revisions." + "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" + ] }, - "MeasurementUnits": { + "infoConfigResponse": { "type": "object", - "description": "Configuration of the measurement system", "properties": { - "system": { + "version": { "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + "description": "Shopware version." }, - "units": { + "shopId": { + "type": "string", + "description": "Unique shop identifier." + }, + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." + }, + "adminWorker": { "type": "object", - "description": "Units used in the measurement system.", + "description": "Admin worker feature flags and transport configuration.", "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", + "deprecated": true + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." + }, + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { + "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." + }, + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." + }, + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." + }, + "firstMigrationDate": { + "type": [ + "string", + "null" ], - "default": "kg", - "description": "Unit of weight." + "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Allowed file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "private_allowed_mime_types_by_extension": { + "type": "object", + "description": "Known MIME types for each allowed private filesystem upload extension.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + }, + "presignedUploadSupported": { + "type": "boolean", + "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." } + }, + "required": [ + "firstMigrationDate" + ], + "additionalProperties": false + }, + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true } } - } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false }, "Criteria": { "type": "object", @@ -127975,227 +129533,65 @@ "field" ] }, - "infoConfigResponse": { - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Shopware version." - }, - "shopId": { - "type": "string", - "description": "Unique shop identifier." - }, - "versionRevision": { - "type": "string", - "description": "Shopware version revision (build hash/revision)." - }, - "adminWorker": { - "type": "object", - "description": "Admin worker feature flags and transport configuration.", - "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "Whether the admin background worker is enabled." - }, - "enableQueueStatsWorker": { - "type": "boolean", - "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", - "deprecated": true - }, - "enableNotificationWorker": { - "type": "boolean", - "description": "Whether the notification worker is enabled." - }, - "transports": { - "type": "array", - "description": "Configured Symfony Messenger transports used by the admin workers.", - "items": { - "type": "string" - } + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Unique name of the businessEventsResponse." + }, + "class": { + "type": "string", + "description": "Class name of business event." + }, + "data": { + "type": "object", + "description": "Internal field." + }, + "aware": { + "type": "array", + "description": "Parameter that indicates the areas in which the business event is supported.", + "items": { + "type": "string" } }, - "additionalProperties": false - }, - "bundles": { - "type": "object", - "description": "Active extension assets (plugins & apps) keyed by technical name.", - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "description": "Plugin bundle asset descriptor.", - "properties": { - "type": { - "type": "string", - "enum": [ - "plugin" - ] - }, - "css": { - "type": "array", - "items": { - "type": "string", - "description": "URL to a CSS asset." - } - }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "URL to a JS asset." - } - }, - "baseUrl": { - "type": [ - "string", - "null" - ], - "description": "Base URL to a (micro frontend) admin entry point, if provided." - } - }, - "required": [ - "type" - ], - "additionalProperties": false - }, - { - "type": "object", - "description": "App bundle descriptor.", - "properties": { - "type": { - "type": "string", - "enum": [ - "app" - ] - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "integrationId": { - "type": "string", - "description": "Lowercase hex integration id." - }, - "baseUrl": { - "type": "string" - }, - "version": { - "type": "string" - }, - "permissions": { - "type": "object", - "description": "Grouped privileges: key = privilege scope, value = list of entities.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "css": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional CSS assets if provided." - }, - "js": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional JS assets if provided." - } - }, - "required": [ - "type", - "name", - "active", - "integrationId", - "baseUrl", - "version", - "permissions" - ], - "additionalProperties": false - } - ] + "extensions": { + "type": "array", + "description": "Internal field.", + "items": { + "type": "string" + } } - }, - "settings": { - "type": "object", - "description": "Selected environment and feature settings consumed by the administration.", - "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the URL upload feature." - }, - "appUrlReachable": { - "type": "boolean", - "description": "Whether configured APP_URL is externally reachable." - }, - "appsRequireAppUrl": { - "type": "boolean", - "description": "True if at least one installed app requires a reachable APP_URL." - }, - "firstMigrationDate": { - "type": [ - "string", - "null" - ], - "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." - }, - "private_allowed_extensions": { - "type": "array", - "description": "Whitelisted file extensions for private filesystem uploads.", - "items": { - "type": "string" - } - }, - "enableHtmlSanitizer": { - "type": "boolean", - "description": "Whether HTML sanitizer is enabled." - }, - "enableStagingMode": { - "type": "boolean", - "description": "Whether staging mode banner is enabled." - }, - "disableExtensionManagement": { - "type": "boolean", - "description": "True if runtime extension management is disabled." - }, - "presignedUploadSupported": { - "type": "boolean", - "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." + } + } + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" } }, - "required": [ - "firstMigrationDate" - ], - "additionalProperties": false - }, - "inAppPurchases": { - "type": "array", - "description": "In-app purchase meta data (structure may vary).", - "items": { - "type": "object", - "description": "Purchase entry.", - "additionalProperties": true + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" } } - }, - "required": [ - "version", - "shopId", - "versionRevision", - "adminWorker", - "bundles", - "settings", - "inAppPurchases" - ], - "additionalProperties": false + } }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", @@ -128321,202 +129717,354 @@ } ] }, - "Price": { + "MeasurementUnits": { "type": "object", - "description": "Price object", + "description": "Configuration of the measurement system", "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, + "SalesChannelFileConfiguration": { + "type": "object", + "required": [ + "id", + "enabled", + "templateOverrides" + ], + "properties": { + "id": { + "description": "Identifier of the sales_channel_file row.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "gross": { - "description": "Gross price for the associated currency.", - "type": "number" + "enabled": { + "description": "Whether this file is served publicly for the sales channel.", + "type": "boolean" }, - "net": { - "description": "Net price for the associated currency.", - "type": "number" + "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", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SalesChannelFileDescriptor": { + "type": "object", + "required": [ + "fileFamily", + "fileName", + "contentType", + "configuration" + ], + "properties": { + "fileFamily": { + "description": "File family below `Resources/views/files`.", + "type": "string", + "maxLength": 64 }, - "linked": { - "description": "Whether gross and net prices are linked through the tax configuration.", - "type": "boolean" + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] }, - "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" + "contentType": { + "description": "Detected response content type for the public file.", + "type": "string", + "examples": [ + "text/plain; charset=utf-8" ] }, - "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" + "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": "Whether gross and net list prices are linked through the tax configuration.", - "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 + }, + "fileName": { + "description": "Public file path without a leading slash.", + "type": "string", + "examples": [ + "llms.txt", + ".well-known/ucp.json" ] }, - "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" + "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": "Whether gross and net regulation prices are linked through the tax configuration.", - "type": "boolean" + { + "type": "null" } - }, - "required": [ - "gross", - "net", - "linked" ] } - }, + } + }, + "SalesChannelFileDetailResponse": { + "type": "object", "required": [ - "currencyId", - "gross", - "net", - "linked" - ] + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelFileDetail" + } + } }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" + "SalesChannelFileListResponse": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelFileDescriptor" + } + } + } }, - "ExternalThumbnail": { + "SalesChannelFilePreviewRequest": { "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", "required": [ - "url", - "width", - "height" + "fileName" ], "properties": { - "url": { + "fileName": { + "description": "Public file path without a leading slash.", "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" + "examples": [ + "llms.txt", + ".well-known/ucp.json" + ] }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 + "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" }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 + "contentType": { + "description": "Detected content type of the rendered file.", + "type": "string" + }, + "content": { + "description": "Rendered file content.", + "type": "string" } } }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } + "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" + ] } } }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unique name of the businessEventsResponse." - }, - "class": { - "type": "string", - "description": "Class name of business event." - }, - "data": { - "type": "object", - "description": "Internal field." - }, - "aware": { - "type": "array", - "description": "Parameter that indicates the areas in which the business event is supported.", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "description": "Internal field.", - "items": { - "type": "string" - } - } + "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." } } }, @@ -130138,6 +131686,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" }, @@ -130817,6 +132398,10 @@ "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" diff --git a/adminapi.summary.json b/adminapi.summary.json index 5c66530..e43b7f4 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -6,6 +6,7 @@ "/_action/cache_info", "/_action/cleanup", "/_action/container_cache", + "/_action/customer-convert/{customerId}", "/_action/decrement/{pool}", "/_action/delete-increment/{pool}", "/_action/document/{documentId}/upload", @@ -29,6 +30,8 @@ "/_action/media/presign-upload", "/_action/media/upload", "/_action/media/upload_by_url", + "/_action/media/{mediaId}/download", + "/_action/media/{mediaId}/download/prepare", "/_action/media/{mediaId}/external-thumbnails", "/_action/media/{mediaId}/finalize-upload", "/_action/media/{mediaId}/upload", @@ -44,6 +47,9 @@ "/_action/order_transaction/{orderTransactionId}/state/{transition}", "/_action/order_transaction_capture_refund/{refundId}", "/_action/reset-increment/{pool}", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/detail", + "/_action/sales-channel-file/{fileFamily}/{salesChannelId}/preview", "/_action/scheduled-task/min-run-interval", "/_action/scheduled-task/run", "/_action/sso/invite-user", @@ -59,6 +65,10 @@ "/_action/theme/{themeId}/configuration", "/_action/theme/{themeId}/reset", "/_action/theme/{themeId}/structured-fields", + "/_action/translation/install", + "/_action/translation/list", + "/_action/translation/update", + "/_action/translation/{locale}", "/_action/user/logout", "/_action/user/{userId}/mcp-allowlist", "/_action/validation/email", @@ -190,6 +200,7 @@ "/aggregate/sales-channel", "/aggregate/sales-channel-analytics", "/aggregate/sales-channel-domain", + "/aggregate/sales-channel-file", "/aggregate/sales-channel-tracking-customer", "/aggregate/sales-channel-tracking-order", "/aggregate/sales-channel-type", @@ -454,6 +465,8 @@ "/sales-channel-analytics/{id}", "/sales-channel-domain", "/sales-channel-domain/{id}", + "/sales-channel-file", + "/sales-channel-file/{id}", "/sales-channel-tracking-customer", "/sales-channel-tracking-customer/{id}", "/sales-channel-tracking-order", @@ -580,6 +593,7 @@ "/search/sales-channel", "/search/sales-channel-analytics", "/search/sales-channel-domain", + "/search/sales-channel-file", "/search/sales-channel-tracking-customer", "/search/sales-channel-tracking-order", "/search/sales-channel-type", @@ -962,6 +976,16 @@ "SalesChannelCurrency", "SalesChannelDomain", "SalesChannelDomainJsonApi", + "SalesChannelFile", + "SalesChannelFileConfiguration", + "SalesChannelFileDescriptor", + "SalesChannelFileDetail", + "SalesChannelFileDetailResponse", + "SalesChannelFileJsonApi", + "SalesChannelFileListResponse", + "SalesChannelFilePreviewRequest", + "SalesChannelFilePreviewResponse", + "SalesChannelFileTemplate", "SalesChannelJsonApi", "SalesChannelLanguage", "SalesChannelPaymentMethod",