diff --git a/adminapi.json b/adminapi.json index 53a8b59..e615f14 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.9.0" + "version": "6.6.10.1" }, "servers": [ { @@ -461,6 +461,86 @@ } } }, + "/aggregate/acl-role": { + "post": { + "tags": [ + "Acl Role" + ], + "summary": "Aggregate for the Acl Role resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAclRole", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app": { "get": { "tags": [ @@ -907,6 +987,86 @@ } } }, + "/aggregate/app": { + "post": { + "tags": [ + "App" + ], + "summary": "Aggregate for the App resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateApp", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of App", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-action-button": { "get": { "tags": [ @@ -1353,6 +1513,86 @@ } } }, + "/aggregate/app-action-button": { + "post": { + "tags": [ + "App Action Button" + ], + "summary": "Aggregate for the App Action Button resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppActionButton", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppActionButton", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-administration-snippet": { "get": { "tags": [ @@ -1799,6 +2039,86 @@ } } }, + "/aggregate/app-administration-snippet": { + "post": { + "tags": [ + "App Administration Snippet" + ], + "summary": "Aggregate for the App Administration Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppAdministrationSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppAdministrationSnippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-cms-block": { "get": { "tags": [ @@ -2245,6 +2565,86 @@ } } }, + "/aggregate/app-cms-block": { + "post": { + "tags": [ + "App Cms Block" + ], + "summary": "Aggregate for the App Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppCmsBlock", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppCmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-flow-action": { "get": { "tags": [ @@ -2691,6 +3091,86 @@ } } }, + "/aggregate/app-flow-action": { + "post": { + "tags": [ + "App Flow Action" + ], + "summary": "Aggregate for the App Flow Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowAction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppFlowAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-flow-event": { "get": { "tags": [ @@ -3137,6 +3617,86 @@ } } }, + "/aggregate/app-flow-event": { + "post": { + "tags": [ + "App Flow Event" + ], + "summary": "Aggregate for the App Flow Event resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowEvent", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppFlowEvent", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-payment-method": { "get": { "tags": [ @@ -3583,6 +4143,86 @@ } } }, + "/aggregate/app-payment-method": { + "post": { + "tags": [ + "App Payment Method" + ], + "summary": "Aggregate for the App Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppPaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppPaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-script-condition": { "get": { "tags": [ @@ -4029,6 +4669,86 @@ } } }, + "/aggregate/app-script-condition": { + "post": { + "tags": [ + "App Script Condition" + ], + "summary": "Aggregate for the App Script Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppScriptCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-shipping-method": { "get": { "tags": [ @@ -4475,6 +5195,86 @@ } } }, + "/aggregate/app-shipping-method": { + "post": { + "tags": [ + "App Shipping Method" + ], + "summary": "Aggregate for the App Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-template": { "get": { "tags": [ @@ -4921,6 +5721,86 @@ } } }, + "/aggregate/app-template": { + "post": { + "tags": [ + "App Template" + ], + "summary": "Aggregate for the App Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/category": { "get": { "tags": [ @@ -5367,6 +6247,86 @@ } } }, + "/aggregate/category": { + "post": { + "tags": [ + "Category" + ], + "summary": "Aggregate for the Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-block": { "get": { "tags": [ @@ -5813,6 +6773,86 @@ } } }, + "/aggregate/cms-block": { + "post": { + "tags": [ + "Cms Block" + ], + "summary": "Aggregate for the Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsBlock", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-page": { "get": { "tags": [ @@ -6259,6 +7299,86 @@ } } }, + "/aggregate/cms-page": { + "post": { + "tags": [ + "Cms Page" + ], + "summary": "Aggregate for the Cms Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-section": { "get": { "tags": [ @@ -6705,6 +7825,86 @@ } } }, + "/aggregate/cms-section": { + "post": { + "tags": [ + "Cms Section" + ], + "summary": "Aggregate for the Cms Section resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSection", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-slot": { "get": { "tags": [ @@ -7151,6 +8351,86 @@ } } }, + "/aggregate/cms-slot": { + "post": { + "tags": [ + "Cms Slot" + ], + "summary": "Aggregate for the Cms Slot resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSlot", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/country": { "get": { "tags": [ @@ -7597,6 +8877,86 @@ } } }, + "/aggregate/country": { + "post": { + "tags": [ + "Country" + ], + "summary": "Aggregate for the Country resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountry", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/country-state": { "get": { "tags": [ @@ -8043,6 +9403,86 @@ } } }, + "/aggregate/country-state": { + "post": { + "tags": [ + "Country State" + ], + "summary": "Aggregate for the Country State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountryState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/currency": { "get": { "tags": [ @@ -8489,6 +9929,86 @@ } } }, + "/aggregate/currency": { + "post": { + "tags": [ + "Currency" + ], + "summary": "Aggregate for the Currency resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrency", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/currency-country-rounding": { "get": { "tags": [ @@ -8935,6 +10455,86 @@ } } }, + "/aggregate/currency-country-rounding": { + "post": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Aggregate for the Currency Country Rounding resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrencyCountryRounding", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-entity": { "get": { "tags": [ @@ -9381,6 +10981,86 @@ } } }, + "/aggregate/custom-entity": { + "post": { + "tags": [ + "Custom Entity" + ], + "summary": "Aggregate for the Custom Entity resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomEntity", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-field": { "get": { "tags": [ @@ -9827,6 +11507,86 @@ } } }, + "/aggregate/custom-field": { + "post": { + "tags": [ + "Custom Field" + ], + "summary": "Aggregate for the Custom Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomField", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-field-set": { "get": { "tags": [ @@ -10273,6 +12033,86 @@ } } }, + "/aggregate/custom-field-set": { + "post": { + "tags": [ + "Custom Field Set" + ], + "summary": "Aggregate for the Custom Field Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-field-set-relation": { "get": { "tags": [ @@ -10719,6 +12559,86 @@ } } }, + "/aggregate/custom-field-set-relation": { + "post": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Aggregate for the Custom Field Set Relation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSetRelation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer": { "get": { "tags": [ @@ -11165,6 +13085,86 @@ } } }, + "/aggregate/customer": { + "post": { + "tags": [ + "Customer" + ], + "summary": "Aggregate for the Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-address": { "get": { "tags": [ @@ -11611,6 +13611,86 @@ } } }, + "/aggregate/customer-address": { + "post": { + "tags": [ + "Customer Address" + ], + "summary": "Aggregate for the Customer Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-group": { "get": { "tags": [ @@ -12057,6 +14137,86 @@ } } }, + "/aggregate/customer-group": { + "post": { + "tags": [ + "Customer Group" + ], + "summary": "Aggregate for the Customer Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-recovery": { "get": { "tags": [ @@ -12503,6 +14663,86 @@ } } }, + "/aggregate/customer-recovery": { + "post": { + "tags": [ + "Customer Recovery" + ], + "summary": "Aggregate for the Customer Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerRecovery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-wishlist": { "get": { "tags": [ @@ -12949,6 +15189,86 @@ } } }, + "/aggregate/customer-wishlist": { + "post": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Aggregate for the Customer Wishlist resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlist", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-wishlist-product": { "get": { "tags": [ @@ -13395,6 +15715,86 @@ } } }, + "/aggregate/customer-wishlist-product": { + "post": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Aggregate for the Customer Wishlist Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlistProduct", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/delivery-time": { "get": { "tags": [ @@ -13841,6 +16241,86 @@ } } }, + "/aggregate/delivery-time": { + "post": { + "tags": [ + "Delivery Time" + ], + "summary": "Aggregate for the Delivery Time resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDeliveryTime", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document": { "get": { "tags": [ @@ -14287,6 +16767,86 @@ } } }, + "/aggregate/document": { + "post": { + "tags": [ + "Document" + ], + "summary": "Aggregate for the Document resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocument", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document-base-config": { "get": { "tags": [ @@ -14733,6 +17293,86 @@ } } }, + "/aggregate/document-base-config": { + "post": { + "tags": [ + "Document Base Config" + ], + "summary": "Aggregate for the Document Base Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document-base-config-sales-channel": { "get": { "tags": [ @@ -15179,6 +17819,86 @@ } } }, + "/aggregate/document-base-config-sales-channel": { + "post": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Aggregate for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfigSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document-type": { "get": { "tags": [ @@ -15625,6 +18345,86 @@ } } }, + "/aggregate/document-type": { + "post": { + "tags": [ + "Document Type" + ], + "summary": "Aggregate for the Document Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/flow": { "get": { "tags": [ @@ -16071,6 +18871,86 @@ } } }, + "/aggregate/flow": { + "post": { + "tags": [ + "Flow" + ], + "summary": "Aggregate for the Flow resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlow", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/flow-sequence": { "get": { "tags": [ @@ -16517,6 +19397,86 @@ } } }, + "/aggregate/flow-sequence": { + "post": { + "tags": [ + "Flow Sequence" + ], + "summary": "Aggregate for the Flow Sequence resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowSequence", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/flow-template": { "get": { "tags": [ @@ -16963,6 +19923,86 @@ } } }, + "/aggregate/flow-template": { + "post": { + "tags": [ + "Flow Template" + ], + "summary": "Aggregate for the Flow Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/import-export-file": { "get": { "tags": [ @@ -17409,6 +20449,86 @@ } } }, + "/aggregate/import-export-file": { + "post": { + "tags": [ + "Import Export File" + ], + "summary": "Aggregate for the Import Export File resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportFile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/import-export-log": { "get": { "tags": [ @@ -17855,6 +20975,86 @@ } } }, + "/aggregate/import-export-log": { + "post": { + "tags": [ + "Import Export Log" + ], + "summary": "Aggregate for the Import Export Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/import-export-profile": { "get": { "tags": [ @@ -18301,6 +21501,86 @@ } } }, + "/aggregate/import-export-profile": { + "post": { + "tags": [ + "Import Export Profile" + ], + "summary": "Aggregate for the Import Export Profile resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportProfile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/integration": { "get": { "tags": [ @@ -18747,6 +22027,86 @@ } } }, + "/aggregate/integration": { + "post": { + "tags": [ + "Integration" + ], + "summary": "Aggregate for the Integration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateIntegration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/landing-page": { "get": { "tags": [ @@ -19193,6 +22553,86 @@ } } }, + "/aggregate/landing-page": { + "post": { + "tags": [ + "Landing Page" + ], + "summary": "Aggregate for the Landing Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLandingPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/language": { "get": { "tags": [ @@ -19639,6 +23079,86 @@ } } }, + "/aggregate/language": { + "post": { + "tags": [ + "Language" + ], + "summary": "Aggregate for the Language resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLanguage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/locale": { "get": { "tags": [ @@ -20085,6 +23605,86 @@ } } }, + "/aggregate/locale": { + "post": { + "tags": [ + "Locale" + ], + "summary": "Aggregate for the Locale resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLocale", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/log-entry": { "get": { "tags": [ @@ -20531,6 +24131,86 @@ } } }, + "/aggregate/log-entry": { + "post": { + "tags": [ + "Log Entry" + ], + "summary": "Aggregate for the Log Entry resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLogEntry", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/mail-header-footer": { "get": { "tags": [ @@ -20977,6 +24657,86 @@ } } }, + "/aggregate/mail-header-footer": { + "post": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Aggregate for the Mail Header Footer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailHeaderFooter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/mail-template": { "get": { "tags": [ @@ -21423,6 +25183,86 @@ } } }, + "/aggregate/mail-template": { + "post": { + "tags": [ + "Mail Template" + ], + "summary": "Aggregate for the Mail Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/mail-template-type": { "get": { "tags": [ @@ -21869,6 +25709,86 @@ } } }, + "/aggregate/mail-template-type": { + "post": { + "tags": [ + "Mail Template Type" + ], + "summary": "Aggregate for the Mail Template Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplateType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/main-category": { "get": { "tags": [ @@ -22315,6 +26235,86 @@ } } }, + "/aggregate/main-category": { + "post": { + "tags": [ + "Main Category" + ], + "summary": "Aggregate for the Main Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMainCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media": { "get": { "tags": [ @@ -22761,6 +26761,86 @@ } } }, + "/aggregate/media": { + "post": { + "tags": [ + "Media" + ], + "summary": "Aggregate for the Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-default-folder": { "get": { "tags": [ @@ -23207,6 +27287,86 @@ } } }, + "/aggregate/media-default-folder": { + "post": { + "tags": [ + "Media Default Folder" + ], + "summary": "Aggregate for the Media Default Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaDefaultFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-folder": { "get": { "tags": [ @@ -23653,6 +27813,86 @@ } } }, + "/aggregate/media-folder": { + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Aggregate for the Media Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-folder-configuration": { "get": { "tags": [ @@ -24099,6 +28339,86 @@ } } }, + "/aggregate/media-folder-configuration": { + "post": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Aggregate for the Media Folder Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolderConfiguration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-thumbnail": { "get": { "tags": [ @@ -24545,6 +28865,86 @@ } } }, + "/aggregate/media-thumbnail": { + "post": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Aggregate for the Media Thumbnail resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-thumbnail-size": { "get": { "tags": [ @@ -24991,6 +29391,86 @@ } } }, + "/aggregate/media-thumbnail-size": { + "post": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Aggregate for the Media Thumbnail Size resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnailSize", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/newsletter-recipient": { "get": { "tags": [ @@ -25437,6 +29917,86 @@ } } }, + "/aggregate/newsletter-recipient": { + "post": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Aggregate for the Newsletter Recipient resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNewsletterRecipient", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/notification": { "get": { "tags": [ @@ -25883,6 +30443,86 @@ } } }, + "/aggregate/notification": { + "post": { + "tags": [ + "Notification" + ], + "summary": "Aggregate for the Notification resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNotification", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range": { "get": { "tags": [ @@ -26329,6 +30969,86 @@ } } }, + "/aggregate/number-range": { + "post": { + "tags": [ + "Number Range" + ], + "summary": "Aggregate for the Number Range resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRange", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range-sales-channel": { "get": { "tags": [ @@ -26775,6 +31495,86 @@ } } }, + "/aggregate/number-range-sales-channel": { + "post": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Aggregate for the Number Range Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range-state": { "get": { "tags": [ @@ -27221,6 +32021,86 @@ } } }, + "/aggregate/number-range-state": { + "post": { + "tags": [ + "Number Range State" + ], + "summary": "Aggregate for the Number Range State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range-type": { "get": { "tags": [ @@ -27667,6 +32547,86 @@ } } }, + "/aggregate/number-range-type": { + "post": { + "tags": [ + "Number Range Type" + ], + "summary": "Aggregate for the Number Range Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order": { "get": { "tags": [ @@ -28113,6 +33073,86 @@ } } }, + "/aggregate/order": { + "post": { + "tags": [ + "Order" + ], + "summary": "Aggregate for the Order resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-address": { "get": { "tags": [ @@ -28559,6 +33599,86 @@ } } }, + "/aggregate/order-address": { + "post": { + "tags": [ + "Order Address" + ], + "summary": "Aggregate for the Order Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-customer": { "get": { "tags": [ @@ -29005,6 +34125,86 @@ } } }, + "/aggregate/order-customer": { + "post": { + "tags": [ + "Order Customer" + ], + "summary": "Aggregate for the Order Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderCustomer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-delivery": { "get": { "tags": [ @@ -29451,6 +34651,86 @@ } } }, + "/aggregate/order-delivery": { + "post": { + "tags": [ + "Order Delivery" + ], + "summary": "Aggregate for the Order Delivery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDelivery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-delivery-position": { "get": { "tags": [ @@ -29897,6 +35177,86 @@ } } }, + "/aggregate/order-delivery-position": { + "post": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Aggregate for the Order Delivery Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDeliveryPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-line-item": { "get": { "tags": [ @@ -30343,6 +35703,86 @@ } } }, + "/aggregate/order-line-item": { + "post": { + "tags": [ + "Order Line Item" + ], + "summary": "Aggregate for the Order Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItem", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-line-item-download": { "get": { "tags": [ @@ -30789,6 +36229,86 @@ } } }, + "/aggregate/order-line-item-download": { + "post": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Aggregate for the Order Line Item Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItemDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction": { "get": { "tags": [ @@ -31235,6 +36755,86 @@ } } }, + "/aggregate/order-transaction": { + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Aggregate for the Order Transaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransaction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction-capture": { "get": { "tags": [ @@ -31681,6 +37281,86 @@ } } }, + "/aggregate/order-transaction-capture": { + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Aggregate for the Order Transaction Capture resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCapture", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction-capture-refund": { "get": { "tags": [ @@ -32127,6 +37807,86 @@ } } }, + "/aggregate/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Aggregate for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction-capture-refund-position": { "get": { "tags": [ @@ -32573,6 +38333,86 @@ } } }, + "/aggregate/order-transaction-capture-refund-position": { + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefundPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/payment-method": { "get": { "tags": [ @@ -33019,6 +38859,86 @@ } } }, + "/aggregate/payment-method": { + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Aggregate for the Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/plugin": { "get": { "tags": [ @@ -33465,6 +39385,86 @@ } } }, + "/aggregate/plugin": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Aggregate for the Plugin resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePlugin", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product": { "get": { "tags": [ @@ -33911,6 +39911,86 @@ } } }, + "/aggregate/product": { + "post": { + "tags": [ + "Product" + ], + "summary": "Aggregate for the Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProduct", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-configurator-setting": { "get": { "tags": [ @@ -34357,6 +40437,86 @@ } } }, + "/aggregate/product-configurator-setting": { + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Aggregate for the Product Configurator Setting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductConfiguratorSetting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-cross-selling": { "get": { "tags": [ @@ -34803,6 +40963,86 @@ } } }, + "/aggregate/product-cross-selling": { + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Aggregate for the Product Cross Selling resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSelling", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-cross-selling-assigned-products": { "get": { "tags": [ @@ -35249,6 +41489,86 @@ } } }, + "/aggregate/product-cross-selling-assigned-products": { + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSellingAssignedProducts", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-download": { "get": { "tags": [ @@ -35695,6 +42015,86 @@ } } }, + "/aggregate/product-download": { + "post": { + "tags": [ + "Product Download" + ], + "summary": "Aggregate for the Product Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-export": { "get": { "tags": [ @@ -36141,6 +42541,86 @@ } } }, + "/aggregate/product-export": { + "post": { + "tags": [ + "Product Export" + ], + "summary": "Aggregate for the Product Export resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductExport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-feature-set": { "get": { "tags": [ @@ -36587,6 +43067,86 @@ } } }, + "/aggregate/product-feature-set": { + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Aggregate for the Product Feature Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductFeatureSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-keyword-dictionary": { "get": { "tags": [ @@ -37033,6 +43593,86 @@ } } }, + "/aggregate/product-keyword-dictionary": { + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Aggregate for the Product Keyword Dictionary resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductKeywordDictionary", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-manufacturer": { "get": { "tags": [ @@ -37479,6 +44119,86 @@ } } }, + "/aggregate/product-manufacturer": { + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Aggregate for the Product Manufacturer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductManufacturer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-media": { "get": { "tags": [ @@ -37925,6 +44645,86 @@ } } }, + "/aggregate/product-media": { + "post": { + "tags": [ + "Product Media" + ], + "summary": "Aggregate for the Product Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-price": { "get": { "tags": [ @@ -38371,6 +45171,86 @@ } } }, + "/aggregate/product-price": { + "post": { + "tags": [ + "Product Price" + ], + "summary": "Aggregate for the Product Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-review": { "get": { "tags": [ @@ -38817,6 +45697,86 @@ } } }, + "/aggregate/product-review": { + "post": { + "tags": [ + "Product Review" + ], + "summary": "Aggregate for the Product Review resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductReview", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-search-config": { "get": { "tags": [ @@ -39263,6 +46223,86 @@ } } }, + "/aggregate/product-search-config": { + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Aggregate for the Product Search Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-search-config-field": { "get": { "tags": [ @@ -39709,6 +46749,86 @@ } } }, + "/aggregate/product-search-config-field": { + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Aggregate for the Product Search Config Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-search-keyword": { "get": { "tags": [ @@ -40155,6 +47275,86 @@ } } }, + "/aggregate/product-search-keyword": { + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Aggregate for the Product Search Keyword resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchKeyword", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-sorting": { "get": { "tags": [ @@ -40601,6 +47801,86 @@ } } }, + "/aggregate/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Aggregate for the Product Sorting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSorting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-stream": { "get": { "tags": [ @@ -41047,6 +48327,86 @@ } } }, + "/aggregate/product-stream": { + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Aggregate for the Product Stream resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStream", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-stream-filter": { "get": { "tags": [ @@ -41493,6 +48853,86 @@ } } }, + "/aggregate/product-stream-filter": { + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Aggregate for the Product Stream Filter resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-visibility": { "get": { "tags": [ @@ -41939,6 +49379,86 @@ } } }, + "/aggregate/product-visibility": { + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Aggregate for the Product Visibility resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductVisibility", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion": { "get": { "tags": [ @@ -42385,6 +49905,86 @@ } } }, + "/aggregate/promotion": { + "post": { + "tags": [ + "Promotion" + ], + "summary": "Aggregate for the Promotion resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-discount": { "get": { "tags": [ @@ -42831,6 +50431,86 @@ } } }, + "/aggregate/promotion-discount": { + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Aggregate for the Promotion Discount resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscount", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-discount-prices": { "get": { "tags": [ @@ -43277,6 +50957,86 @@ } } }, + "/aggregate/promotion-discount-prices": { + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Aggregate for the Promotion Discount Prices resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscountPrices", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-individual-code": { "get": { "tags": [ @@ -43723,6 +51483,86 @@ } } }, + "/aggregate/promotion-individual-code": { + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Aggregate for the Promotion Individual Code resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionIndividualCode", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-sales-channel": { "get": { "tags": [ @@ -44169,6 +52009,86 @@ } } }, + "/aggregate/promotion-sales-channel": { + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Aggregate for the Promotion Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-setgroup": { "get": { "tags": [ @@ -44615,6 +52535,86 @@ } } }, + "/aggregate/promotion-setgroup": { + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Aggregate for the Promotion Setgroup resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSetgroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/property-group": { "get": { "tags": [ @@ -45061,6 +53061,86 @@ } } }, + "/aggregate/property-group": { + "post": { + "tags": [ + "Property Group" + ], + "summary": "Aggregate for the Property Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/property-group-option": { "get": { "tags": [ @@ -45507,6 +53587,86 @@ } } }, + "/aggregate/property-group-option": { + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Aggregate for the Property Group Option resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroupOption", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/rule": { "get": { "tags": [ @@ -45953,6 +54113,86 @@ } } }, + "/aggregate/rule": { + "post": { + "tags": [ + "Rule" + ], + "summary": "Aggregate for the Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/rule-condition": { "get": { "tags": [ @@ -46399,6 +54639,86 @@ } } }, + "/aggregate/rule-condition": { + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Aggregate for the Rule Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRuleCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel": { "get": { "tags": [ @@ -46845,6 +55165,86 @@ } } }, + "/aggregate/sales-channel": { + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Aggregate for the Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel-analytics": { "get": { "tags": [ @@ -47291,6 +55691,86 @@ } } }, + "/aggregate/sales-channel-analytics": { + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Aggregate for the Sales Channel Analytics resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelAnalytics", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel-domain": { "get": { "tags": [ @@ -47737,6 +56217,86 @@ } } }, + "/aggregate/sales-channel-domain": { + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Aggregate for the Sales Channel Domain resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelDomain", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel-type": { "get": { "tags": [ @@ -48183,6 +56743,86 @@ } } }, + "/aggregate/sales-channel-type": { + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Aggregate for the Sales Channel Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/salutation": { "get": { "tags": [ @@ -48629,6 +57269,86 @@ } } }, + "/aggregate/salutation": { + "post": { + "tags": [ + "Salutation" + ], + "summary": "Aggregate for the Salutation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalutation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/scheduled-task": { "get": { "tags": [ @@ -49075,6 +57795,86 @@ } } }, + "/aggregate/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Aggregate for the Scheduled Task resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScheduledTask", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/script": { "get": { "tags": [ @@ -49521,6 +58321,86 @@ } } }, + "/aggregate/script": { + "post": { + "tags": [ + "Script" + ], + "summary": "Aggregate for the Script resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScript", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/seo-url": { "get": { "tags": [ @@ -49967,6 +58847,86 @@ } } }, + "/aggregate/seo-url": { + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Aggregate for the Seo Url resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrl", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/seo-url-template": { "get": { "tags": [ @@ -50413,6 +59373,86 @@ } } }, + "/aggregate/seo-url-template": { + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Aggregate for the Seo Url Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrlTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/shipping-method": { "get": { "tags": [ @@ -50859,6 +59899,86 @@ } } }, + "/aggregate/shipping-method": { + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Aggregate for the Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/shipping-method-price": { "get": { "tags": [ @@ -51305,6 +60425,86 @@ } } }, + "/aggregate/shipping-method-price": { + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Aggregate for the Shipping Method Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethodPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/snippet": { "get": { "tags": [ @@ -51751,6 +60951,86 @@ } } }, + "/aggregate/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Aggregate for the Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/snippet-set": { "get": { "tags": [ @@ -52197,6 +61477,86 @@ } } }, + "/aggregate/snippet-set": { + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Aggregate for the Snippet Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippetSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine": { "get": { "tags": [ @@ -52643,6 +62003,86 @@ } } }, + "/aggregate/state-machine": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Aggregate for the State Machine resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachine", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine-history": { "get": { "tags": [ @@ -53089,6 +62529,86 @@ } } }, + "/aggregate/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Aggregate for the State Machine History resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine-state": { "get": { "tags": [ @@ -53535,6 +63055,86 @@ } } }, + "/aggregate/state-machine-state": { + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Aggregate for the State Machine State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine-transition": { "get": { "tags": [ @@ -53981,6 +63581,86 @@ } } }, + "/aggregate/state-machine-transition": { + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Aggregate for the State Machine Transition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineTransition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/system-config": { "get": { "tags": [ @@ -54427,6 +64107,86 @@ } } }, + "/aggregate/system-config": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Aggregate for the System Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSystemConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tag": { "get": { "tags": [ @@ -54873,6 +64633,86 @@ } } }, + "/aggregate/tag": { + "post": { + "tags": [ + "Tag" + ], + "summary": "Aggregate for the Tag resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTag", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax": { "get": { "tags": [ @@ -55319,6 +65159,86 @@ } } }, + "/aggregate/tax": { + "post": { + "tags": [ + "Tax" + ], + "summary": "Aggregate for the Tax resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTax", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax-provider": { "get": { "tags": [ @@ -55765,6 +65685,86 @@ } } }, + "/aggregate/tax-provider": { + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Aggregate for the Tax Provider resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxProvider", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax-rule": { "get": { "tags": [ @@ -56211,6 +66211,86 @@ } } }, + "/aggregate/tax-rule": { + "post": { + "tags": [ + "Tax Rule" + ], + "summary": "Aggregate for the Tax Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax-rule-type": { "get": { "tags": [ @@ -56657,6 +66737,86 @@ } } }, + "/aggregate/tax-rule-type": { + "post": { + "tags": [ + "Tax Rule Type" + ], + "summary": "Aggregate for the Tax Rule Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRuleType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/theme": { "get": { "tags": [ @@ -57103,6 +67263,86 @@ } } }, + "/aggregate/theme": { + "post": { + "tags": [ + "Theme" + ], + "summary": "Aggregate for the Theme resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTheme", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/unit": { "get": { "tags": [ @@ -57549,6 +67789,86 @@ } } }, + "/aggregate/unit": { + "post": { + "tags": [ + "Unit" + ], + "summary": "Aggregate for the Unit resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUnit", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user": { "get": { "tags": [ @@ -57995,6 +68315,86 @@ } } }, + "/aggregate/user": { + "post": { + "tags": [ + "User" + ], + "summary": "Aggregate for the User resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUser", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user-access-key": { "get": { "tags": [ @@ -58441,6 +68841,86 @@ } } }, + "/aggregate/user-access-key": { + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Aggregate for the User Access Key resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user-config": { "get": { "tags": [ @@ -58887,6 +69367,86 @@ } } }, + "/aggregate/user-config": { + "post": { + "tags": [ + "User Config" + ], + "summary": "Aggregate for the User Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user-recovery": { "get": { "tags": [ @@ -59333,6 +69893,86 @@ } } }, + "/aggregate/user-recovery": { + "post": { + "tags": [ + "User Recovery" + ], + "summary": "Aggregate for the User Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserRecovery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/webhook": { "get": { "tags": [ @@ -59779,6 +70419,86 @@ } } }, + "/aggregate/webhook": { + "post": { + "tags": [ + "Webhook" + ], + "summary": "Aggregate for the Webhook resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhook", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Webhook", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/webhook-event-log": { "get": { "tags": [ @@ -60225,353 +70945,338 @@ } } }, - "/_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}": { + "/aggregate/webhook-event-log": { "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": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "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", "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } } }, - "type": "object" + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Returns information about the iteration.", + "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": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", + "total": { "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } - }, - "type": "object" + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { + "/_action/mail-template/send": { + "post": { "tags": [ - "Document Management" + "Mail Operations" ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "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.", - "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" + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], + "properties": { + "recipients": { + "description": "A list 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.", + "type": "string" + } + }, + "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.", + "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" + }, + "mediaIds": { + "description": "List of media 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.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "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 list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + } + }, + "type": "object" + } } } - ], + }, "responses": { "200": { - "description": "The generated number", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" + "size": { + "description": "Length of the email message", + "type": "integer" } }, "type": "object" } } } - }, - "400": { - "description": "Number range not found" } } } }, - "/_action/container_cache": { - "delete": { + "/_action/mail-template/validate": { + "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", + "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" + } + } + } + }, "responses": { "204": { - "description": "Returns a no content response indicating that the container cache is cleared." + "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { + "/_action/mail-template/build": { + "post": { "tags": [ - "Document Management" - ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", - "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, - "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 - } - } + "Mail Operations" ], - "responses": { - "200": { - "description": "The document.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, - "/_action/document/{documentId}/upload": { - "post": { - "tags": [ - "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": "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`", - "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": { - "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" - } - } - } - } - } - } - }, - "/_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": { - "type": "string" - } - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." - } - } - } - }, - "/_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", + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "customerId", - "salesChannelId" + "mailTemplateType", + "mailTemplate" ], "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" + "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" }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail 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" } }, "type": "object" @@ -60581,54 +71286,11 @@ }, "responses": { "200": { - "description": "The generated customer impersonation token.", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/order/document/download": { - "post": { - "tags": [ - "Document 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}$" - } - } - } - } - }, - "responses": { - "200": { - "description": "The documents.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" + "type": "string" } } } @@ -60636,352 +71298,118 @@ } } }, - "/_action/order/document/{documentTypeName}/create": { + "/_action/sync": { "post": { "tags": [ - "Document Management" + "Bulk Operations" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "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": "documentTypeName", - "in": "path", - "description": "The type of document to create", - "required": true, + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { - "type": "string" + "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" + ] } } ], "requestBody": { - "description": "test", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { - "type": "object", "required": [ - "orderId", - "type" + "action", + "entity", + "payload" ], "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 - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", + "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", - "default": "null", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "upsert", + "delete" + ] }, - "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/order/{orderId}/state/{transition}": { - "post": { - "tags": [ - "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" - } - } - ], - "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": { + "entity": { + "description": "The entity that should be processed with the payload.", "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" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" - } - } - } - }, - "/_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" + "example": "product" }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" + "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" + } }, - "cacheAdapter": { - "description": "The active cache adapter.", - "type": "string" - } - }, - "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" - }, - "500": { - "description": "Application is not working properly" - } - } - } - }, - "/_info/system-health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", - "parameters": [ - { - "name": "verbose", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" - } - ], - "responses": { - "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { + "filter": { + "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": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "status": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "message": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } + { + "$ref": "#/components/schemas/RangeFilter" } - } + ] } } - } - } - } - } - }, - "500": { - "description": "Application is not working properly" - } - } - } - }, - "/_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" - } - } - } - } - } - } - }, - "/_info/config": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get API information", - "description": "Get information about the API", - "operationId": "config", - "responses": { - "200": { - "description": "Returns information about the API.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/infoConfigResponse" + }, + "type": "object" } } } } - } - } - }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", + }, "responses": { "200": { - "description": "Successful operation", + "description": "Returns a sync result containing information about the updated entities", "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" - } - } - } + "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" } } } @@ -60989,145 +71417,62 @@ } } }, - "/_action/scheduled-task/run": { + "/_action/index-products": { "post": { "tags": [ "System Operations" ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", "responses": { - "200": { - "description": "Returns a success message indicating a successful run.", - "content": { - "application/json": { - "schema": { - "properties": { - "message": { - "description": "Success message", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns an empty response indicating that the message dispatched." } } } }, - "/_action/scheduled-task/min-run-interval": { - "get": { + "/_action/cache": { + "delete": { "tags": [ "System Operations" ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Returns the minimum interval.", - "content": { - "application/json": { - "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_action/order/{orderId}/order-address": { - "post": { + "/_action/cache-delayed": { + "delete": { "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", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "System Operations" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "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": { - "type": "string", - "description": "The ID of the delivery (optional)", - "nullable": true - } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" - } - } - } - } - }, - "required": true - }, + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", "responses": { "204": { - "description": "Returns a no content response indicating that the update has been made." + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_info/flow-actions.json": { - "get": { + "/_action/cleanup": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" - } - } - } + "204": { + "description": "Returns a no content response indicating that the cleanup finished." } } } @@ -61208,19 +71553,78 @@ } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { - "post": { + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "responses": { + "200": { + "description": "Successful operation", + "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" + } + } + } + } + } + } + } + } + } + } + } + }, + "/_action/container_cache": { + "delete": { "tags": [ - "Order Management" + "System Operations" ], - "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": "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": "orderDeliveryId", + "name": "documentId", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Identifier of the document to be downloaded.", "required": true, "schema": { "type": "string", @@ -61228,9 +71632,71 @@ } }, { - "name": "transition", + "name": "deepLinkCode", "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": "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 + } + } + ], + "responses": { + "200": { + "description": "The document.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/document/{documentId}/upload": { + "post": { + "tags": [ + "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": "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`", "required": true, "schema": { "type": "string" @@ -61238,34 +71704,22 @@ } ], "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 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" + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" } }, "type": "object" @@ -61275,270 +71729,182 @@ }, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "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" + } + } + } } } } }, - "/_action/sync": { - "post": { + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { "tags": [ - "Bulk Operations" + "Document Management" ], - "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", + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", "parameters": [ { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, "schema": { - "type": "boolean", - "default": true + "type": "string" } }, { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "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", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] + "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" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" + } + }, + "type": "object" + } + } } + }, + "400": { + "description": "Number range not found" } + } + } + }, + "/oauth/token": { + "post": { + "tags": [ + "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": "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" - } - }, - "filter": { - "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" - } - ] - } - } + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" }, - "type": "object" - } + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + } + ] } } } }, "responses": { "200": { - "description": "Returns a sync result containing information about the updated entities", + "description": "Authorized successfully.", "content": { "application/json": { "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" + "token_type": { + "description": "Type of the token.", + "type": "string" }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" + "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": { + "$ref": "#/components/responses/400" } } } }, - "/_action/mail-template/send": { + "/_proxy/generate-imitate-customer-token": { "post": { "tags": [ - "Mail Operations" + "Customer impersonation" ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", + "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": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" + "customerId", + "salesChannelId" ], "properties": { - "recipients": { - "description": "A list 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.", - "type": "string" - } - }, - "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.", - "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.", + "customerId": { + "description": "ID of the customer", "type": "string" }, - "mediaIds": { - "description": "List of media 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.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "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 list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" } }, "type": "object" @@ -61548,14 +71914,14 @@ }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "token": { + "description": "The generated customer impersonation token", + "type": "string" } }, "type": "object" @@ -61566,91 +71932,155 @@ } } }, - "/_action/mail-template/validate": { + "/_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": [ - "Mail Operations" + "System Operations" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" + "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" + } }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" + "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": "Returns a no content response indicating the mail content was rendered successfully." + "200": { + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } }, - "/_action/mail-template/build": { + "/_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": { + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/indexing": { "post": { "tags": [ - "Mail Operations" + "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": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", "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" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail 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" + "offset": { + "description": "The offset for the iteration.", + "type": "integer" } }, "type": "object" @@ -61660,11 +72090,21 @@ }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "Returns information about the iteration.", "content": { "application/json": { "schema": { - "type": "string" + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" } } } @@ -61744,50 +72184,186 @@ } } }, - "/_action/order_transaction_capture_refund/{refundId}": { + "/_action/order/document/download": { "post": { "tags": [ - "Order Management" + "Document Management" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", + "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}$" + } + } + } + } + }, + "responses": { + "200": { + "description": "The documents.", + "content": { + "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": "refundId", + "name": "documentTypeName", "in": "path", - "description": "Identifier of the order transaction capture refund.", + "description": "The type of document to create", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], + "requestBody": { + "description": "test", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "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 + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", + "type": "string", + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" + } + } + } + } + } + } + }, "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" + "200": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, - "/_action/index-products": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ - "System Operations" + "Order Management" ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", + "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" + } + } + ], + "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 database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" } } } @@ -61839,6 +72415,104 @@ } } }, + "/_action/order/{orderId}/order-address": { + "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", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "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": { + "type": "string", + "description": "The ID of the delivery (optional)", + "nullable": true + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/_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": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, "/_info/openapi3.json": { "get": { "tags": [ @@ -61868,105 +72542,207 @@ } } }, - "/_action/cache": { - "delete": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "post": { "tags": [ - "System Operations" + "Order Management" ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", + "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": "orderDeliveryId", + "in": "path", + "description": "Identifier of the order delivery.", + "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 which is not possible, you will get an error that lists possible transition for the actual state.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "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" + } + }, + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" } } } }, - "/_action/cache-delayed": { - "delete": { + "/_info/health-check": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", + "summary": "Check that the Application is running", + "operationId": "healthCheck", "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/cleanup": { - "delete": { + "/_info/system-health-check": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" + } ], - "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." + "200": { + "description": "Returns the system health check results", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Application is not working properly" } } } }, - "/oauth/token": { - "post": { + "/_info/flow-actions.json": { + "get": { "tags": [ - "Authorization & Authentication" + "System Info & Health Check" ], - "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" - } - ] + "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.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flowBuilderActionsResponse" + } } } } - }, + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "Authorized successfully.", + "description": "Information about the cache state.", "content": { "application/json": { "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], "properties": { - "token_type": { - "description": "Type of the token.", + "environment": { + "description": "The active environment.", "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" + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" }, - "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`.", + "cacheAdapter": { + "description": "The active cache adapter.", "type": "string" } }, @@ -61974,38 +72750,62 @@ } } } - }, - "400": { - "$ref": "#/components/responses/400" } } } }, - "/_info/version": { + "/_info/config": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", + "summary": "Get API information", + "description": "Get information about the API", + "operationId": "config", "responses": { "200": { - "description": "Returns the version of the Shopware instance.", + "description": "Returns information about the API.", "content": { "application/json": { "schema": { - "properties": { - "version": { - "description": "The Shopware version.", + "$ref": "#/components/schemas/infoConfigResponse" + } + } + } + } + } + } + }, + "/_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": { "type": "string" } - }, - "type": "object" - } + } + }, + "type": "object" } } } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." + } } } } @@ -64828,6 +75628,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -64909,6 +75712,9 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app." }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -68632,6 +79438,9 @@ "allowCartExpose": { "type": "boolean" }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -68754,6 +79563,9 @@ "type": "boolean", "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process." }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -69204,21 +80016,12 @@ "lastName": { "type": "string" }, - "company": { - "type": "string" - }, "email": { "type": "string" }, "title": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, "affiliateCode": { "type": "string" }, @@ -69298,9 +80101,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -69970,10 +80770,6 @@ "type": "string", "description": "Last name of the customer." }, - "company": { - "type": "string", - "description": "Company name of the customer." - }, "email": { "type": "string", "description": "Email ID of the customer." @@ -69982,13 +80778,6 @@ "type": "string", "description": "Titles or honorifics like Mr, Mrs, etc." }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Unique identity of VAT." - }, "affiliateCode": { "type": "string", "description": "An affiliate code is an identification option with which website operators can mark outgoing links." @@ -70088,10 +80877,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of bonus sales channel." }, - "accountType": { - "type": "string", - "description": "Account type can be personal or business." - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -70189,6 +80974,15 @@ }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethod" + }, + "company": { + "description": "Company name of the customer." + }, + "vatIds": { + "description": "Unique identity of VAT." + }, + "accountType": { + "description": "Account type can be personal or business." } }, "type": "object" @@ -71465,10 +82259,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -71479,9 +82273,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -71494,6 +82285,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -71516,6 +82311,9 @@ "customFields": { "type": "object" }, + "fileType": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -71674,6 +82472,35 @@ } }, "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -71688,10 +82515,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -71704,10 +82531,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document type." }, - "fileType": { - "type": "string", - "description": "Type of file like PDF." - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -71723,6 +82546,10 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document media file." }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -71751,6 +82578,10 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "fileType": { + "type": "string", + "description": "Type of file like PDF." + }, "createdAt": { "type": "string", "format": "date-time", @@ -71778,6 +82609,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -75918,8 +86752,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -75931,8 +86764,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -76795,7 +87627,6 @@ }, "mimeType": { "type": "string", - "readOnly": true, "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg." }, "fileExtension": { @@ -76811,7 +87642,6 @@ }, "fileName": { "type": "string", - "readOnly": true, "description": "Name of the media file uploaded." }, "fileSize": { @@ -102591,111 +113421,6 @@ } ] }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "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" - } - } - } - }, "businessEventsResponse": { "type": "array", "items": { @@ -102747,68 +113472,6 @@ } } }, - "infoConfigResponse": { - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "The Shopware version." - }, - "versionRevision": { - "type": "string", - "description": "The Shopware version revision." - }, - "adminWorker": { - "type": "object", - "description": "Information about the admin worker.", - "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "State of the admin worker." - }, - "transports": { - "type": "array", - "description": "Configured transports.", - "items": { - "type": "string" - } - } - } - }, - "bundles": { - "type": "object", - "description": "Asset files of active extensions", - "additionalProperties": { - "type": "object", - "properties": { - "css": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the css file." - } - }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the js file." - } - } - } - } - }, - "settings": { - "type": "object", - "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." - } - } - } - } - }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -103535,6 +114198,173 @@ "field" ] }, + "infoConfigResponse": { + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "The Shopware version." + }, + "versionRevision": { + "type": "string", + "description": "The Shopware version revision." + }, + "adminWorker": { + "type": "object", + "description": "Information about the admin worker.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "State of the admin worker." + }, + "transports": { + "type": "array", + "description": "Configured transports.", + "items": { + "type": "string" + } + } + } + }, + "bundles": { + "type": "object", + "description": "Asset files of active extensions", + "additionalProperties": { + "type": "object", + "properties": { + "css": { + "type": "array", + "items": { + "type": "string", + "description": "Url to the css file." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "Url to the js file." + } + } + } + } + }, + "settings": { + "type": "object", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." + } + } + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "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" + } + } + } + }, "Cart": { "properties": { "id": { diff --git a/adminapi.summary.json b/adminapi.summary.json index ad55780..3f59c69 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -38,6 +38,141 @@ "/_proxy/generate-imitate-customer-token", "/acl-role", "/acl-role/{id}", + "/aggregate/acl-role", + "/aggregate/app", + "/aggregate/app-action-button", + "/aggregate/app-administration-snippet", + "/aggregate/app-cms-block", + "/aggregate/app-flow-action", + "/aggregate/app-flow-event", + "/aggregate/app-payment-method", + "/aggregate/app-script-condition", + "/aggregate/app-shipping-method", + "/aggregate/app-template", + "/aggregate/category", + "/aggregate/cms-block", + "/aggregate/cms-page", + "/aggregate/cms-section", + "/aggregate/cms-slot", + "/aggregate/country", + "/aggregate/country-state", + "/aggregate/currency", + "/aggregate/currency-country-rounding", + "/aggregate/custom-entity", + "/aggregate/custom-field", + "/aggregate/custom-field-set", + "/aggregate/custom-field-set-relation", + "/aggregate/customer", + "/aggregate/customer-address", + "/aggregate/customer-group", + "/aggregate/customer-recovery", + "/aggregate/customer-wishlist", + "/aggregate/customer-wishlist-product", + "/aggregate/delivery-time", + "/aggregate/document", + "/aggregate/document-base-config", + "/aggregate/document-base-config-sales-channel", + "/aggregate/document-type", + "/aggregate/flow", + "/aggregate/flow-sequence", + "/aggregate/flow-template", + "/aggregate/import-export-file", + "/aggregate/import-export-log", + "/aggregate/import-export-profile", + "/aggregate/integration", + "/aggregate/landing-page", + "/aggregate/language", + "/aggregate/locale", + "/aggregate/log-entry", + "/aggregate/mail-header-footer", + "/aggregate/mail-template", + "/aggregate/mail-template-type", + "/aggregate/main-category", + "/aggregate/media", + "/aggregate/media-default-folder", + "/aggregate/media-folder", + "/aggregate/media-folder-configuration", + "/aggregate/media-thumbnail", + "/aggregate/media-thumbnail-size", + "/aggregate/newsletter-recipient", + "/aggregate/notification", + "/aggregate/number-range", + "/aggregate/number-range-sales-channel", + "/aggregate/number-range-state", + "/aggregate/number-range-type", + "/aggregate/order", + "/aggregate/order-address", + "/aggregate/order-customer", + "/aggregate/order-delivery", + "/aggregate/order-delivery-position", + "/aggregate/order-line-item", + "/aggregate/order-line-item-download", + "/aggregate/order-transaction", + "/aggregate/order-transaction-capture", + "/aggregate/order-transaction-capture-refund", + "/aggregate/order-transaction-capture-refund-position", + "/aggregate/payment-method", + "/aggregate/plugin", + "/aggregate/product", + "/aggregate/product-configurator-setting", + "/aggregate/product-cross-selling", + "/aggregate/product-cross-selling-assigned-products", + "/aggregate/product-download", + "/aggregate/product-export", + "/aggregate/product-feature-set", + "/aggregate/product-keyword-dictionary", + "/aggregate/product-manufacturer", + "/aggregate/product-media", + "/aggregate/product-price", + "/aggregate/product-review", + "/aggregate/product-search-config", + "/aggregate/product-search-config-field", + "/aggregate/product-search-keyword", + "/aggregate/product-sorting", + "/aggregate/product-stream", + "/aggregate/product-stream-filter", + "/aggregate/product-visibility", + "/aggregate/promotion", + "/aggregate/promotion-discount", + "/aggregate/promotion-discount-prices", + "/aggregate/promotion-individual-code", + "/aggregate/promotion-sales-channel", + "/aggregate/promotion-setgroup", + "/aggregate/property-group", + "/aggregate/property-group-option", + "/aggregate/rule", + "/aggregate/rule-condition", + "/aggregate/sales-channel", + "/aggregate/sales-channel-analytics", + "/aggregate/sales-channel-domain", + "/aggregate/sales-channel-type", + "/aggregate/salutation", + "/aggregate/scheduled-task", + "/aggregate/script", + "/aggregate/seo-url", + "/aggregate/seo-url-template", + "/aggregate/shipping-method", + "/aggregate/shipping-method-price", + "/aggregate/snippet", + "/aggregate/snippet-set", + "/aggregate/state-machine", + "/aggregate/state-machine-history", + "/aggregate/state-machine-state", + "/aggregate/state-machine-transition", + "/aggregate/system-config", + "/aggregate/tag", + "/aggregate/tax", + "/aggregate/tax-provider", + "/aggregate/tax-rule", + "/aggregate/tax-rule-type", + "/aggregate/theme", + "/aggregate/unit", + "/aggregate/user", + "/aggregate/user-access-key", + "/aggregate/user-config", + "/aggregate/user-recovery", + "/aggregate/webhook", + "/aggregate/webhook-event-log", "/app", "/app-action-button", "/app-action-button/{id}",